Method PostAddZipCode

Summary

Add Zip Code

Remarks

Add zip code to land management

Requires

NaviLine 9.1.17.3 or higher

Input Parameters

Name	Type	Length	Description
zipCode	System.String	9	[Required] Zip Code. If zip + 4, enter as all digits, no spaces.
city	System.String	20	[Required] City
state	System.String	2	[Required] State. 2 char abbreviation
wlkNumber	System.String	4	Walk Number (Canadian)
tapeID	System.String	1	Tape ID (Canadian)
foreignFlag	System.String	1	Foreign zip flag

Example

POST http://localhost/FusionServices/v3/Naviline/Land/AddZipCode

Return Values

Name	Description
ErrorCode	0=Succes, 1=Not Found
StateName	Long name for the state code, or country.
FormattedCityState	Formatted City, State, and Zip line

Sample Responses

JSON

{
    "ServerElapsedTime": "00:00:00.5789081",
    "Rows": [],
    "OutputParms": {
        "ErrorCode": "0",
        "StateName": "MISSOURI",
        "FormattedCityState": "UNION MO 63084"
    }
}

Sample Code

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

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/Land/AddZipCode";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("zipCode",System.Web.HttpUtility.UrlEncode("63084"));
   postParms.Add("city",System.Web.HttpUtility.UrlEncode("Union"));
   postParms.Add("state",System.Web.HttpUtility.UrlEncode("MO"));

   WebClient req = new WebClient();
   wc.Headers.Add("Content-Type", "application/x-www-form-urlencoded");
   wc.Headers.Set("X-APPID", "YOURID");
   wc.Headers.Set("X-APPKEY", "YOURKEY");

   byte[] responseBytes = wc.UploadValues(new Uri(uri), "POST", postParms);
   string stringResult = Encoding.UTF8.GetString(responseBytes); 
   JObject response = JObject.Parse(stringResult);
   string error = response["OutputParms"]["ErrorCode"].ToString();
   if (error == "0")
   {
         // TODO - YOUR CODE HERE
   }
}

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

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

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

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

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

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

       public PostAddZipCode()
       {
           //Set any defaults here
       }
   }
}

@* NOTE: Use Add->View to add the View. *@
@* NOTE: Check the 'Create strongly-typed view checkbox, and select the PostAddZipCode 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.PostAddZipCode

@{
   ViewBag.Title = "PostAddZipCode";
}

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

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

// 
// POST: /MyController/PostAddZipCode
[HttpPost]
public ActionResult PostAddZipCode(FormCollection collection)
{
   string url = "v3/Naviline/Land/AddZipCode";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("zipCode", collection["zipCode"]);
   inputParms.Add("city", collection["city"]);
   inputParms.Add("state", collection["state"]);
   inputParms.Add("wlkNumber", collection["wlkNumber"]);
   inputParms.Add("tapeID", collection["tapeID"]);
   inputParms.Add("foreignFlag", collection["foreignFlag"]);

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

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