Method PostScheduleInspection

Summary

Schedule Inspection

Remarks

Schedules an inspection and assigns to the given inspector

Before calling this method, make sure it is ok to schedule the inspection by calling:

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.
inspectionCode System.String 4 [Required] Inspection Type Code
inspectionText System.String 6000 Inspection text. Any comment the customer wants to include.
inspectorID System.String 6 Inspector's ID. Use this to override the inspector assigned by location.
inspectionDate numeric 6 Inspection date in MMddyy format. Defaults to current date.
inspectionRequired System.String 1 [Required] Inspection required 1=Yes

Example

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

Return Values

NameDescription
ErrorCode Returns blank if successful, and error message if it is already scheduled
IVRNumber ID number of the inspection

Sample Responses

Sample Code

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

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/Inspection/ScheduleInspection";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("applicationYear",System.Web.HttpUtility.UrlEncode("09"));
   postParms.Add("applicationNumber",System.Web.HttpUtility.UrlEncode("00000502"));
   postParms.Add("structureNumber",System.Web.HttpUtility.UrlEncode("000"));
   postParms.Add("structureSequence",System.Web.HttpUtility.UrlEncode("000"));
   postParms.Add("permitType",System.Web.HttpUtility.UrlEncode("BLDG"));
   postParms.Add("permitSequence",System.Web.HttpUtility.UrlEncode("13"));
   postParms.Add("inspectionCode",System.Web.HttpUtility.UrlEncode("BL11"));
   postParms.Add("inspectionText",System.Web.HttpUtility.UrlEncode("fusion inspection text"));
   postParms.Add("inspectorID",System.Web.HttpUtility.UrlEncode(""));
   postParms.Add("inspectionRequired",System.Web.HttpUtility.UrlEncode("1"));

   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 == "")
   {
         string inspectionID = response["OutputParms"]["IVRNumber"].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 PostScheduleInspection
   {
       // 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 inspectionCode{get; set;}

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

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

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

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

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

@{
   ViewBag.Title = "PostScheduleInspection";
}

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

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

// 
// POST: /MyController/PostScheduleInspection
[HttpPost]
public ActionResult PostScheduleInspection(FormCollection collection)
{
   string url = "v3/Naviline/Inspection/ScheduleInspection";
   // 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("inspectionCode", collection["inspectionCode"]);
   inputParms.Add("inspectionText", collection["inspectionText"]);
   inputParms.Add("inspectorID", collection["inspectorID"]);
   inputParms.Add("inspectionDate", collection["inspectionDate"]);
   inputParms.Add("inspectionRequired", collection["inspectionRequired"]);

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