Method GetCityStateZip

Summary

Get City, State Zip

Remarks

This finds zip codes in the location file and returns the corresponding City and State.

It returns a formatted City, State zip line to use with Business Owner and Business Officers address information.

It will return a row for each matching zip code, if you give it a 5 digit zip code, it will return all the mathcing zip+4 codes available for that zip code.

Input Parameters

NameTypeLengthDescription
zipCode System.String 9 [Required] Zip Code

Example

GET http://localhost/FusionServices/v2/Naviline/OccupationalLicense/CityStateZip/{zipCode}

Return Values

NameDescription
ErrorCode 0000=Success
ErrorMessage Message returned with error code
Zip Matching zip code
City City
State State
CityStateZip Formatted City, State zip line

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v2/Naviline/OccupationalLicense/CityStateZip/75901";
    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 Zip = row["Zip"].ToString();
             string City = row["City"].ToString();
             string State = row["State"].ToString();
             string CityStateZip = row["CityStateZip"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v2/Naviline/OccupationalLicense/CityStateZip/75901', 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 GetCityStateZip
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("^(?=.{0,9}$).*", ErrorMessage = "Must be 9 characters or less. ")]
       public string zipCode{get; set;}

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

@{
   ViewBag.Title = "GetCityStateZip";
   string myUrl = "http://localhost/FusionServices/v2/Naviline/OccupationalLicense/CityStateZip/" + Model.zipCode;
}

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

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

// 
// POST: /MyController/GetCityStateZip
[HttpPost]
public ActionResult GetCityStateZip(FormCollection collection)
{
   string url = "v2/Naviline/OccupationalLicense/CityStateZip/{zipCode}";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("zipCode", collection["zipCode"]);

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