Method PostSearchRequiredInspections

Summary

Search for Required Inspections

Remarks

Searches for required inspections for an application. You only need the application year and number.

Input Parameters

Name	Type	Length	Description
applicationYear	numeric	2	[Required] Two digit Application Year - if a 4 digit year is provided, only the last two digits are used
applicationNumber	numeric	8	[Required] Application Number
startNumber	numeric	3	Start Number. For a permit, Ex: 000 000 BLDG 01, this is the first set of three numbers.
startSequence	numeric	3	Start Sequence. For a permit, Ex: 000 000 BLDG 01, this is the second set of three numbers.
permitType	System.String	4	Permit Type. For a permit, Ex: 000 000 BLDG 01, this is the third set of four characters, which has to be one of the permit type codes.
permitSequence	numeric	2	Permit Sequence. For a permit, Ex: 000 000 BLDG 01, this is the fourth set of two numbers.
mode	System.String	1	Search mode. Used for paging. F=First records (default), N=Next records, P=Previous records
rows	numeric	4	Number of rows to return. Used for paging. Defaults to 10 rows
firstRec	numeric	4	First record number to return. Used for paging.
lastRec	numeric	4	Last record number to return. Used for paging.

Example

POST http://localhost/FusionServices/v3/Naviline/Inspection/SearchRequiredInspections

Return Values

Name	Description
PermitDesc	Permit description
StartNumber	Permit start number
StartSequence	Permit start sequence
Priority	Priority. 0 is highest
MaxPriority	Max Priority that can be assigned to this inspection type. 0 is highest
PermitCode	Permit code 4-char
RequestSequence	Request sequence
InspCode	Inspection code
InspSequence	Inspection sequence
InspStatusCode	Inspection status code
InspStatusDesc	Inspection status description
InspDesc	Inpection description
RequestedDate	Date inspection is scheduled. Format: YYMMDD
ResultDate	Date inspection was done. Format: YYMMDD
ErrorCode	2004 = OK. No more records for this search
ROWS	Number of rows that were returned
FTSRCD	Record number of first record returned
LSTRCD	Record number of last record returned
MOREYN	Y/N. Y indicates the search found more records than were returned.

Sample Responses

JSON

{
    "ServerElapsedTime": "00:00:01.3115952",
    "Rows": [
        {
            "PermitDesc": "BUILDING PERMIT",
            "StartNumber": "0",
            "StartSequence": "0",
            "PermitType": "",
            "PermitSequence": "0",
            "Priority": "10",
            "MaxPriority": "00000",
            "PermitCode": "BLDG",
            "RequestSequence": "1",
            "InspCode": "PL08",
            "InspSequence": "1",
            "InspStatusCode": "",
            "InspStatusDesc": "",
            "InspDesc": "PLMB LEAD CHECK TEST",
            "RequestedDate": "160509",
            "ResultDate": "000000"
        },
        {
            "PermitDesc": "",
            "StartNumber": "0",
            "StartSequence": "0",
            "PermitType": "",
            "PermitSequence": "0",
            "Priority": "20",
            "MaxPriority": "00000",
            "PermitCode": "",
            "RequestSequence": "0",
            "InspCode": "BL05",
            "InspSequence": "0",
            "InspStatusCode": "",
            "InspStatusDesc": "",
            "InspDesc": "BLDG DRIVEWAY APPROACH",
            "RequestedDate": "000000",
            "ResultDate": "000000"
        }
    ],
    "OutputParms": {
        "ROWS": "0011",
        "FTSRCD": "0001",
        "LSTRCD": "0011",
        "MOREYN": "N",
        "ErrorCode": "2004",
        "ErrorMessage": "No more records for this search"
    }
}

Sample Code

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

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/Inspection/SearchRequiredInspections";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("applicationYear",System.Web.HttpUtility.UrlEncode("9"));
   postParms.Add("applicationNumber",System.Web.HttpUtility.UrlEncode("502"));

   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 == "2004")
   {
        JArray jRows = (JArray)response["Rows"];
        foreach (JObject row in jRows)
        {
             string PermitDesc = row["PermitDesc"].ToString();
             string StartNumber = row["StartNumber"].ToString();
             string StartSequence = row["StartSequence"].ToString();
             string PermitType = row["PermitType"].ToString();
             string PermitSequence = row["PermitSequence"].ToString();
             string Priority = row["Priority"].ToString();
             string MaxPriority = row["MaxPriority"].ToString();
             string PermitCode = row["PermitCode"].ToString();
             string RequestSequence = row["RequestSequence"].ToString();
             string InspCode = row["InspCode"].ToString();
             string InspSequence = row["InspSequence"].ToString();
             string InspStatusCode = row["InspStatusCode"].ToString();
             string InspStatusDesc = row["InspStatusDesc"].ToString();
             string InspDesc = row["InspDesc"].ToString();
             string RequestedDate = row["RequestedDate"].ToString();
             string ResultDate = row["ResultDate"].ToString();
             // 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 PostSearchRequiredInspections
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,2}", ErrorMessage = "Numeric values only. Must be 2 digits or less. ")]
       public string applicationYear{get; set;}

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

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

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

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

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

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

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

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

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

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

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

@{
   ViewBag.Title = "PostSearchRequiredInspections";
}

<h2>PostSearchRequiredInspections</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>PostSearchRequiredInspections</legend>
       <div class="editor-label">
           @Html.LabelFor(model => model.applicationYear)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.applicationYear)
           @Html.ValidationMessageFor(model => model.applicationYear)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.applicationNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.applicationNumber)
           @Html.ValidationMessageFor(model => model.applicationNumber)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.startNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.startNumber)
           @Html.ValidationMessageFor(model => model.startNumber)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.startSequence)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.startSequence)
           @Html.ValidationMessageFor(model => model.startSequence)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.permitType)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.permitType)
           @Html.ValidationMessageFor(model => model.permitType)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.permitSequence)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.permitSequence)
           @Html.ValidationMessageFor(model => model.permitSequence)
       </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.firstRec)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.firstRec)
           @Html.ValidationMessageFor(model => model.firstRec)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.lastRec)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.lastRec)
           @Html.ValidationMessageFor(model => model.lastRec)
       </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/PostSearchRequiredInspections
public ActionResult PostSearchRequiredInspections()
{
   // Create a new instance of the model to pick up any default values.
   PostSearchRequiredInspections model =  new PostSearchRequiredInspections();

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

// 
// POST: /MyController/PostSearchRequiredInspections
[HttpPost]
public ActionResult PostSearchRequiredInspections(FormCollection collection)
{
   string url = "v3/Naviline/Inspection/SearchRequiredInspections";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("applicationYear", collection["applicationYear"]);
   inputParms.Add("applicationNumber", collection["applicationNumber"]);
   inputParms.Add("startNumber", collection["startNumber"]);
   inputParms.Add("startSequence", collection["startSequence"]);
   inputParms.Add("permitType", collection["permitType"]);
   inputParms.Add("permitSequence", collection["permitSequence"]);
   inputParms.Add("mode", collection["mode"]);
   inputParms.Add("rows", collection["rows"]);
   inputParms.Add("firstRec", collection["firstRec"]);
   inputParms.Add("lastRec", collection["lastRec"]);

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