Method GetNotificationSettings

Summary

Returns system eBilling notification settings

Remarks

This service returns the utility system eBilling settings in order to determine which email notification options are available for customers.

To get and set email notifications for a customer use GetNotificationInfo and PostNotificationInfo

Common uses:

Input Parameters

NameTypeLengthDescription
None No input parameters to pass

Example

GET http://localhost/FusionServices/v2/Naviline/Utilities/NotificationSettings

Return Values

NameDescription
Active Indicates what type of notifications are available for the system to send.
1 = Charge summary, 2 = Bills and charge summary, 3 = None
NoticeType Indicates the default notifications type for utility 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
BillNumber This is the number of 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 Error code returned from the call. 0000 indicates success.
ErrorMessage Error message returned if there was an error.

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v2/Naviline/Utilities/NotificationSettings";
    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/v2/Naviline/Utilities/NotificationSettings', 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 GetNotificationSettings
   {
       // Add property for each input param in order to map a field to it
       public GetNotificationSettings()
       {
           //Set any defaults here
       }
   }
}
@* NOTE: Use Add->View to add the View. *@
@* NOTE: Check the 'Create strongly-typed view checkbox, and select the GetNotificationSettings 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.GetNotificationSettings

@{
   ViewBag.Title = "GetNotificationSettings";
   string myUrl = "http://localhost/FusionServices/v2/Naviline/Utilities/NotificationSettings";
}

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

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

// 
// POST: /MyController/GetNotificationSettings
[HttpPost]
public ActionResult GetNotificationSettings(FormCollection collection)
{
   string url = "v2/Naviline/Utilities/NotificationSettings";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();

   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", "GetNotificationSettings");
       return View("Error", info);
   }
}