Method GetNotificationInfo

Summary

Get Notification Information

Remarks

Gets the notification settings for the user. Options are email, paper, or both.

Input Parameters

NameTypeLengthDescription
customerNumber numeric 9 [Required] Customer Number. See Account Search methods.
locationNumber numeric 9 [Required] Location Number. See Account Search methods.

Example

GET http://localhost/FusionServices/v3/Naviline/Utilities/NotificationInfo/{customerNumber}/{locationNumber}

Return Values

NameDescription
Active Y/N if Notifications are enabled.
NoticeType Indicates the notifications setting for the customers.
1 = e-mail only, (blank*) = Print bills only, 2 = Both e-mail and printed bill
*If Active is not set to 2, for bill and charge summary, then blank is the only valid option
*Any value that is not a 1 or 2 indicates it is Print bills only
EmailAddress The email address notifications will be sent to, if enabled
BillNumber 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.
ErrorCode 0000=Success
ErrorMessage Description of error if any
PaymentDue Y=Payment is due

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v3/Naviline/Utilities/NotificationInfo/27211/9258";
    WebClient wc = new WebClient();
    wc.Headers.Set("X-APPID", "YOURID");
    wc.Headers.Set("X-APPKEY", "YOURKEY");
    string stringResult = wc.DownloadString(new Uri(uri));
    
    JObject response = JObject.Parse(stringResult);
    string error = response["OutputParms"]["ErrorCode"].ToString();
    if (error == "0000")
    {
         // TODO - YOUR CODE HERE
    }
}

$.get('http://localhost/FusionServices/v3/Naviline/Utilities/NotificationInfo/27211/9258', function(response) {
    $('#resultDiv).html(response); 
 });

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 GetNotificationInfo
   {
       // 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;}

       public GetNotificationInfo()
       {
           //Set any defaults here
           customerNumber = DefaultData.Get("customerNumber");
           locationNumber = DefaultData.Get("locationNumber");
       }
   }
}
@* NOTE: Use Add->View to add the View. *@
@* NOTE: Check the 'Create strongly-typed view checkbox, and select the GetNotificationInfo 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.GetNotificationInfo

@{
   ViewBag.Title = "GetNotificationInfo";
   string myUrl = "http://localhost/FusionServices/v3/Naviline/Utilities/NotificationInfo/" + Model.customerNumber + "/" + Model.locationNumber;
}

<h2>GetNotificationInfo</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>GetNotificationInfo</legend>
       <div class="editor-label">Use the fields below to change the values and resubmit.</div>
       <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>
       <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/GetNotificationInfo
public ActionResult GetNotificationInfo()
{
   // Create a new instance of the model to pick up any default values.
   GetNotificationInfo model =  new GetNotificationInfo();

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

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

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

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