Method GetCancelInspection

Summary

Cancel Application Inspection

Remarks

First call GetInspectionsToCancel to get the list of inspections to cancel.

GetInspectionsToCancel will return the inspection type and sequence number that you will need to pass to this method in order to cancel it. It also returns the current status, indicating if it is already cancelled or approved.

This method does not return the normal error code. It returns the inspection description of the inspection that was cancelled.

Input Parameters

NameTypeLengthDescription
applicationYear numeric 2 [Required] Application Year. 2 digit
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.
inspectionType System.String 4 [Required] Inspection Type. 4 char code. Ex. BL02
inspectionSequence numeric 4 [Required] sequence number for inspection

Example

GET http://localhost/FusionServices/v2/Naviline/Permit/Application/Cancel/{applicationYear}/{applicationNumber}/{startNumber}/{startSequence}/{permitType}/{permitSequence}/{inspectionType}/{inspectionSequence}

Return Values

NameDescription
IDES Inspection description of the inspection that was cancelled.

Sample Responses

Sample Code

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

public void MethodName(parms){
    string uri = "http://localhost/FusionServices/v2/Naviline/Permit/Application/Cancel/09/502/000/000/BLDG/01/BL11/0005";
    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 desc = response["OutputParms"]["IDES"].ToString();
    if (desc.Length > 0)
    {
       // TODO - YOUR CODE HERE
    }
}

$.get('http://localhost/FusionServices/v2/Naviline/Permit/Application/Cancel/09/502/000/000/BLDG/01/BL11/0005', 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 GetCancelInspection
   {
       // 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;}

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

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

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

@{
   ViewBag.Title = "GetCancelInspection";
   string myUrl = "http://localhost/FusionServices/v2/Naviline/Permit/Application/Cancel/" + Model.applicationYear + "/" + Model.applicationNumber + "/" + Model.startNumber + "/" + Model.startSequence + "/" + Model.permitType + "/" + Model.permitSequence + "/" + Model.inspectionType + "/" + Model.inspectionSequence;
}

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

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

// 
// POST: /MyController/GetCancelInspection
[HttpPost]
public ActionResult GetCancelInspection(FormCollection collection)
{
   string url = "v2/Naviline/Permit/Application/Cancel/{applicationYear}/{applicationNumber}/{startNumber}/{startSequence}/{permitType}/{permitSequence}/{inspectionType}/{inspectionSequence}";
   // 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("inspectionType", collection["inspectionType"]);
   inputParms.Add("inspectionSequence", collection["inspectionSequence"]);

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