Method PostNotificationInfo

Summary

Sets the eBilling notification settings for the customer

Remarks

Sets the notification options for the customer. The options are 1=eBilling only, 2=Both eBill and print, (blank)=Print only. Any value other than 1 or 2 defaults to Print only. If an eBilling option is set, the email address is required.

It requires the customer and location number to set the information for, which can be retrieved by using the Account Search services.

Input Parameters

NameTypeLengthDescription
customerNumber numeric 9 [Required] Customer Number. See Account Search methods.
locationNumber numeric 9 [Required] Location Number. See Account Search methods.
Active System.String 1 [Required] Y=Enable email, N=Disable email (paper only)
NoticeType numeric 1 Indicates the notifications setting for the customers. 1=e-mail only, 2=Both e-mail and printed bill, (blank)=Print bills only
EmailAddress System.String 100 The email to send notifications to. Required if Emails are enabled (Active=Y). If disabling email, send the previous email in this field, so that if they enable it again, it remembers the email address.
BillNumber numeric 0 This is the number of remaining printed bills that will still be sent after signing up for e-notifications.
Values are 00 - 99. 00 = No bills will be printed.
This is only valid if NoticeType is set to 1 = e-mail only.
This is normally left blank, as it is already managed by the BillNumber setting in GetNotificationSettings

Example

POST http://localhost/FusionServices/v3/Naviline/Utilities/NotificationInfo

Sample Responses

Sample Code

using System.Net;
using Newtonsoft.Json.Linq;

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/Utilities/NotificationInfo";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("customerNumber",System.Web.HttpUtility.UrlEncode("27211"));
   postParms.Add("locationNumber",System.Web.HttpUtility.UrlEncode("9258"));
   postParms.Add("active",System.Web.HttpUtility.UrlEncode("Y"));
   postParms.Add("noticeType",System.Web.HttpUtility.UrlEncode("2"));
   postParms.Add("emailAddress",System.Web.HttpUtility.UrlEncode("customer@noreply.com"));

   WebClient req = new WebClient();
   wc.Headers.Add("Content-Type", "application/x-www-form-urlencoded");
   wc.Headers.Set("X-APPID", "YOURID");
   wc.Headers.Set("X-APPKEY", "YOURKEY");

   byte[] responseBytes = wc.UploadValues(new Uri(uri), "POST", postParms);
   string stringResult = Encoding.UTF8.GetString(responseBytes); 
   JObject response = JObject.Parse(stringResult);
   string error = response["OutputParms"]["ErrorCode"].ToString();
   if (error == "0000")
   {
         // TODO - YOUR CODE HERE
   }
}

C# Razor MVC Sample Code

using System;
using System.Linq;
using System.Web;
using System.ComponentModel.DataAnnotations;
using System.Collections.Specialized;
using FusionServiceHelper.Models;

// NOTE: Use the namespace generated when you add the class, so that it is correct.
namespace FusionRazor.Models
{
   public class PostNotificationInfo
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,9}", ErrorMessage = "Numeric values only. Must be 9 digits or less. ")]
       public string customerNumber{get; set;}

       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,9}", ErrorMessage = "Numeric values only. Must be 9 digits or less. ")]
       public string locationNumber{get; set;}

       [Required(ErrorMessage = "Required")]
       [RegularExpression("^(?=.{0,1}$).*", ErrorMessage = "Must be 1 characters or less. ")]
       public string Active{get; set;}

       [RegularExpression("[0-9]{0,1}", ErrorMessage = "Numeric values only. Must be 1 digits or less. ")]
       public string NoticeType{get; set;}

       [RegularExpression("^(?=.{0,100}$).*", ErrorMessage = "Must be 100 characters or less. ")]
       public string EmailAddress{get; set;}

       [RegularExpression("[0-9]+", ErrorMessage = "Numeric values only. ")]
       public string BillNumber{get; set;}

       public PostNotificationInfo()
       {
           //Set any defaults here
       }
   }
}
@* NOTE: Use Add->View to add the View. *@
@* NOTE: Check the 'Create strongly-typed view checkbox, and select the PostNotificationInfo class. *@
@* NOTE: Select Edit as the Scaffold template. *@
@* NOTE: Use the @model line that is generated at the top.  Replace the rest with the lines below.
@model FusionRazor.Models.PostNotificationInfo

@{
   ViewBag.Title = "PostNotificationInfo";
}

<h2>PostNotificationInfo</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>PostNotificationInfo</legend>
       <div class="editor-label">
           @Html.LabelFor(model => model.customerNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.customerNumber)
           @Html.ValidationMessageFor(model => model.customerNumber)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.locationNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.locationNumber)
           @Html.ValidationMessageFor(model => model.locationNumber)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.Active)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.Active)
           @Html.ValidationMessageFor(model => model.Active)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.NoticeType)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.NoticeType)
           @Html.ValidationMessageFor(model => model.NoticeType)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.EmailAddress)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.EmailAddress)
           @Html.ValidationMessageFor(model => model.EmailAddress)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.BillNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.BillNumber)
           @Html.ValidationMessageFor(model => model.BillNumber)
       </div>
       <p>
       <input type="submit" value="Submit"/>
       </p>
   </fieldset>

}

@section Scripts {
   @Scripts.Render("~/bundles/jqueryval")
}
using System;
using System.Collections.Specialized;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using FusionServiceHelper.Models;

// NOTE: Replace 'MyController' with the name of your controller.

// 
// GET: /MyController/PostNotificationInfo
public ActionResult PostNotificationInfo()
{
   // Create a new instance of the model to pick up any default values.
   PostNotificationInfo model =  new PostNotificationInfo();

   // pass model to set to default values
   // NOTE: Change 'MyFolderPath' to the path to the .cshtml file.
   return View("~/Views/MyFolderPath/PostNotificationInfo.cshtml", model);
}

// 
// POST: /MyController/PostNotificationInfo
[HttpPost]
public ActionResult PostNotificationInfo(FormCollection collection)
{
   string url = "v3/Naviline/Utilities/NotificationInfo";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("customerNumber", collection["customerNumber"]);
   inputParms.Add("locationNumber", collection["locationNumber"]);
   inputParms.Add("Active", collection["Active"]);
   inputParms.Add("NoticeType", collection["NoticeType"]);
   inputParms.Add("EmailAddress", collection["EmailAddress"]);
   inputParms.Add("BillNumber", collection["BillNumber"]);

   try
   {
       // Send the request
       FusionServiceRequest request = new FusionServiceRequest();
       FusionServiceResult result = request.Post(url, inputParms);

       return View("Result", result);
   }
   catch(Exception e)
   {
       HandleErrorInfo info = new HandleErrorInfo(e, "MyController", "PostNotificationInfo");
       return View("Error", info);
   }
}