Method GetStepComments

Summary

Get review comments for an application tracking step

Remarks

The review comments will be returned as rows. The ReviewBy name is returned in the OutputParms

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
revision numeric 3 [Required] Revision Number
path numeric 1 [Required] Path Number
step numeric 2 [Required] Step Number
agency System.String 4 [Required] Agency Code
sequenceNumber numeric 2 [Required] Sequence Number

Example

GET http://localhost/FusionServices/v3/Naviline/Permit/Application/StepComments/{applicationYear}/{applicationNumber}/{revision}/{path}/{step}/{agency}/{sequenceNumber}

Return Values

NameDescription
Comment Comment logged to tracking step
Date Date comment was logged
Review Description of review
ReviewByCode Initials or code of person who reviewed the tracking step
ReviewByName Name of person who reviewed the tracking step

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v3/Naviline/Permit/Application/StepComments/10/42/0/1/2/PLZN/3";
    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")
    {
       // TODO - YOUR CODE HERE
    }
}

$.get('http://localhost/FusionServices/v3/Naviline/Permit/Application/StepComments/10/42/0/1/2/PLZN/3', 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 GetStepComments
   {
       // 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 revision{get; set;}

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

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

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

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

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

@{
   ViewBag.Title = "GetStepComments";
   string myUrl = "http://localhost/FusionServices/v3/Naviline/Permit/Application/StepComments/" + Model.applicationYear + "/" + Model.applicationNumber + "/" + Model.revision + "/" + Model.path + "/" + Model.step + "/" + Model.agency + "/" + Model.sequenceNumber;
}

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

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

// 
// POST: /MyController/GetStepComments
[HttpPost]
public ActionResult GetStepComments(FormCollection collection)
{
   string url = "v3/Naviline/Permit/Application/StepComments/{applicationYear}/{applicationNumber}/{revision}/{path}/{step}/{agency}/{sequenceNumber}";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("applicationYear", collection["applicationYear"]);
   inputParms.Add("applicationNumber", collection["applicationNumber"]);
   inputParms.Add("revision", collection["revision"]);
   inputParms.Add("path", collection["path"]);
   inputParms.Add("step", collection["step"]);
   inputParms.Add("agency", collection["agency"]);
   inputParms.Add("sequenceNumber", collection["sequenceNumber"]);

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