Method GetUtilitiesAddress

Summary

Returns mailing and location address for utility account

Remarks

This service returns the customer's mailing address and location address. The location address is the address used for the site the account is for.

The mailing address can be different from the location address if the customer is having their mail delivered to a different location such as a P.O. Box or a corporate address.

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

Input Parameters

NameTypeLengthDescription
customerNumber numeric 9 [Required] Customer Number
locationNumber numeric 9 [Required] Location Number

Example

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

Return Values

NameDescription
CustomerName Customer name, in format: Last, First
CustomerMailingAddress1 Street address
CustomerMailingAddress2 Street address line 2
CustomerMailingAddress3 City (18 chars) State code (2 char), space, Zip Code (9 chars)
LocationAddress Location address for the site as defined in Land Management
LocationCity City (18 chars) State code (2 char).
AccountStatus Account Status code indicate if the account is active or otherwise.
TotalDue Total Amount currently due, including any charges.
TotalDelinquent Any overdue Amount
LastBillDate Date the last bill was issued. Format: mmddyyyy
ErrorFlag
DueDateOfLastBill Date when last bill is due. Format: mmddyyyy
LastBillAmount Amount due on last bill
LastPaymentDate Date the last payment was received. mmddyyyy
LastPaymentAmount Amount of last payment received. This should normally have a minus sign (-) at the end indicating it was credited to the account
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/101/33028/address";
    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/101/33028/address', 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 GetUtilitiesAddress
   {
       // 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 GetUtilitiesAddress()
       {
           //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 GetUtilitiesAddress 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.GetUtilitiesAddress

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

<h2>GetUtilitiesAddress</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>GetUtilitiesAddress</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/GetUtilitiesAddress
public ActionResult GetUtilitiesAddress()
{
   // Create a new instance of the model to pick up any default values.
   GetUtilitiesAddress model =  new GetUtilitiesAddress();

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

// 
// POST: /MyController/GetUtilitiesAddress
[HttpPost]
public ActionResult GetUtilitiesAddress(FormCollection collection)
{
   string url = "v2/Naviline/Utilities/{CustomerNumber}/{LocationNumber}/address";
   // 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", "GetUtilitiesAddress");
       return View("Error", info);
   }
}