Method GetLegalDescription

Summary

Get Legal Description

Remarks

Get the legal description for a location, including block and lot number.

Input Parameters

NameTypeLengthDescription
locationID numeric 9 [Required] Location ID
mode System.String 1 [Required] Mode. F=Find
rows numeric 4 [Required] Number of rows to return
firstRC numeric 4 [Required] First row number to return.
lastRC numeric 4 [Required] Last row number to return.

Example

GET http://localhost/FusionServices/v3/Naviline/CodeEnforcement/LegalDescription/{locationID}/{mode}/{rows}/{firstRC}/{lastRC}

Return Values

NameDescription
LegalDescription Legal Description, including block and lot number
ROWS Number of rows returned
FirstRecord First row number returned
LastRecord Last row number returned
MOREYN More records to return? Y/N
ErrorCode 0000=Success, 2003=No more records for this search
ErrorMessage Message returned with error code

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v3/Naviline/CodeEnforcement/LegalDescription/31404/F/99/0/5";
    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 LegalDescription = row["LegalDescription"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v3/Naviline/CodeEnforcement/LegalDescription/31404/F/99/0/5', 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 GetLegalDescription
   {
       // 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 locationID{get; set;}

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

       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,4}", ErrorMessage = "Numeric values only. Must be 4 digits or less. ")]
       public string rows{get; set;}

       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,4}", ErrorMessage = "Numeric values only. Must be 4 digits or less. ")]
       public string firstRC{get; set;}

       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,4}", ErrorMessage = "Numeric values only. Must be 4 digits or less. ")]
       public string lastRC{get; set;}

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

@{
   ViewBag.Title = "GetLegalDescription";
   string myUrl = "http://localhost/FusionServices/v3/Naviline/CodeEnforcement/LegalDescription/" + Model.locationID + "/" + Model.mode + "/" + Model.rows + "/" + Model.firstRC + "/" + Model.lastRC;
}

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

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

// 
// POST: /MyController/GetLegalDescription
[HttpPost]
public ActionResult GetLegalDescription(FormCollection collection)
{
   string url = "v3/Naviline/CodeEnforcement/LegalDescription/{locationID}/{mode}/{rows}/{firstRC}/{lastRC}";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("locationID", collection["locationID"]);
   inputParms.Add("mode", collection["mode"]);
   inputParms.Add("rows", collection["rows"]);
   inputParms.Add("firstRC", collection["firstRC"]);
   inputParms.Add("lastRC", collection["lastRC"]);

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