Method GetStructureCodes

Summary

Get Structure Code values

Remarks

Get list of available values for the structure code type.

Generic codes (type=1) will return a Code and Value field.

Structure Information Codes (type=2) will return just a Value field.

Input Parameters

NameTypeLengthDescription
codeType System.String 1 1=Add Generic Code data, 2=Add Structure Information. See GetRequiredStructureInfo
code System.String 4 Structure data code. See GetRequiredStructureInfo

Example

GET http://localhost/FusionServices/v3/Naviline/Permit/Application/StructureCodes/{codeType}/{code}

Return Values

NameDescription
ErrorCode 0000 is successful.
ErrorMessage Description of error, if any.
Code Code for value
Value Description for value

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v3/Naviline/Permit/Application/StructureCodes/1/CT";
    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 Code = row["Code"].ToString();
             string Value = row["Value"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v3/Naviline/Permit/Application/StructureCodes/1/CT', 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 GetStructureCodes
   {
       // Add property for each input param in order to map a field to it
       [RegularExpression("^(?=.{0,1}$).*", ErrorMessage = "Must be 1 characters or less. ")]
       public string codeType{get; set;}

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

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

@{
   ViewBag.Title = "GetStructureCodes";
   string myUrl = "http://localhost/FusionServices/v3/Naviline/Permit/Application/StructureCodes/" + Model.codeType + "/" + Model.code;
}

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

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

// 
// POST: /MyController/GetStructureCodes
[HttpPost]
public ActionResult GetStructureCodes(FormCollection collection)
{
   string url = "v3/Naviline/Permit/Application/StructureCodes/{codeType}/{code}";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("codeType", collection["codeType"]);
   inputParms.Add("code", collection["code"]);

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