Method GetServiceInformation

Summary

Returns account status and average usage of a utility service

Remarks

Returns the service status for a customer's utility service account along with average consumption and bill amounts.

Closed accounts, with Status of F=Finalled will not return information.

If you do not pass the ServiceCode this will return information for all active services the customer has.

It returns the following information:

Common uses:

Input Parameters

NameTypeLengthDescription
customerNumber numeric 9 [Required] Customer Number. See Account Search methods.
locationNumber numeric 9 [Required] Location Number. See Account Search methods.
ServiceCode System.String 2 Service Code. Use the ServiceCode field returned by PostUtilitiesAccountSearchByName

Example

GET http://localhost/FusionServices/v2/Naviline/Utilities/{CustomerNumber}/{LocationNumber}/service/{ServiceCode}

Return Values

NameDescription
ServiceCode Two letter code indicating the type of utility service. Example: WA for water
ServiceDescription Twenty character description of the utility service type.
Status Current account status for the service. Example:
  • ACTIVE
  • COLLECTION
  • DELETED
  • FINALLED
  • INACTIVE
  • SHUT OFF, NONPAY
  • TERMINATED
  • TERMINATED, NONPAY
  • VACATION
OnDate Date the utility service was turned on for the customer. Format: mmddyyyy
OffDate Date the utility service was turned off. Format: mmddyyyy
AverageBillAmount Average bill amount based on prior 12 months of service.
AverageDailyUsage Average daily usage based on prior 12 months of service.
AverageBilledConsupmtion NOTE: Consumption is misspelled.
Days Total number of days of service.
AverageDays Average number of days in billing periods.
AverageDailyConsumption Average usage based on prior 12 months of service.

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v2/Naviline/Utilities/101/33028/service";
    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")
    {
        JArray jRows = (JArray)response["Rows"];
        foreach (JObject row in jRows)
        {
             string ServiceCode = row["ServiceCode"].ToString();
             string ServiceDescription = row["ServiceDescription"].ToString();
             string Status = row["Status"].ToString();
             string OnDate = row["OnDate"].ToString();
             string OffDate = row["OffDate"].ToString();
             string AverageBillAmount = row["AverageBillAmount"].ToString();
             string AverageDailyUsage = row["AverageDailyUsage"].ToString();
             string AverageBilledConsupmtion = row["AverageBilledConsupmtion"].ToString();
             string Days = row["Days"].ToString();
             string AverageDays = row["AverageDays"].ToString();
             string AverageDailyConsumption = row["AverageDailyConsumption"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v2/Naviline/Utilities/101/33028/service', 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 GetServiceInformation
   {
       // 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;}

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

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

@{
   ViewBag.Title = "GetServiceInformation";
   string myUrl = "http://localhost/FusionServices/v2/Naviline/Utilities/" + Model.CustomerNumber + "/" + Model.LocationNumber + "/service/" + Model.ServiceCode;
}

<h2>GetServiceInformation</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>GetServiceInformation</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>
       <div class="editor-label">
           @Html.LabelFor(model => model.ServiceCode)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.ServiceCode)
           @Html.ValidationMessageFor(model => model.ServiceCode)
       </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/GetServiceInformation
public ActionResult GetServiceInformation()
{
   // Create a new instance of the model to pick up any default values.
   GetServiceInformation model =  new GetServiceInformation();

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

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

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