Method GetNextRequiredInspection

Summary

Get Next Required Inspection

Remarks

Returns the next required inspections for the permit type, and their priority.

This method will return the AllowInspection flag indicating if the inspections should be scheduled or not. If N, the ErrorCode and ErrorMessage will indicates the reason it is not currently allowed. Such as unpaid fees or the permit status doesn't allow inspections to be scheduled.

Input Parameters

NameTypeLengthDescription
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 [Required] Start Number. For a permit, Ex: 000 000 BLDG 01, this is the first set of three numbers.
startSequence numeric 3 [Required] Start Sequence. For a permit, Ex: 000 000 BLDG 01, this is the second set of three numbers.
permitType System.String 4 [Required] 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 [Required] Permit Sequence. For a permit, Ex: 000 000 BLDG 01, this is the fourth set of two numbers.

Example

GET http://localhost/FusionServices/v3/Naviline/Inspection/NextRequiredInspection/{applicationYear}/{applicationNumber}/{startNumber}/{startSequence}/{permitType}/{permitSequence}

Return Values

NameDescription
InspectionDesc Inpection description
InspectionType Inpection type code - 4 chars
Priority Priority. 0 is highest
AllowInspection Y/N to indicate if scheduling the inspection is currently allowed.

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v3/Naviline/Inspection/NextRequiredInspection/09/502/000/000/ELCT/00";
    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();
    string allowInspection = response["OutputParms"]["AllowInspection"].ToString();
    if (allowInspection == "Y") 
    {
        JArray jRows = (JArray)response["Rows"];
        foreach (JObject row in jRows)
        {
             string InspectionDesc = row["InspectionDesc"].ToString();
             string InspectionType = row["InspectionType"].ToString();
             string Priority = row["Priority"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
    else
    {
         string errorMessage = response["OutputParms"]["ErrorMessage"].ToString();
    }
}

$.get('http://localhost/FusionServices/v3/Naviline/Inspection/NextRequiredInspection/09/502/000/000/ELCT/00', 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 GetNextRequiredInspection
   {
       // 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;}

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

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

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

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

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

@{
   ViewBag.Title = "GetNextRequiredInspection";
   string myUrl = "http://localhost/FusionServices/v3/Naviline/Inspection/NextRequiredInspection/" + Model.applicationYear + "/" + Model.applicationNumber + "/" + Model.startNumber + "/" + Model.startSequence + "/" + Model.permitType + "/" + Model.permitSequence;
}

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

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

// 
// POST: /MyController/GetNextRequiredInspection
[HttpPost]
public ActionResult GetNextRequiredInspection(FormCollection collection)
{
   string url = "v3/Naviline/Inspection/NextRequiredInspection/{applicationYear}/{applicationNumber}/{startNumber}/{startSequence}/{permitType}/{permitSequence}";
   // 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"]);

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