Method GetCustomCalcFields

Summary

Get Custom Calc Fields

Remarks

Get the list of fields to display for custom calculations, and check if they are editable or required.

Input Parameters

NameTypeLengthDescription
licenseYear numeric 2 [Required] License Year. 2 digit
licenseNumber numeric 8 [Required] License Number
licenseClass System.String 7 [Required] License classification code.

Example

GET http://localhost/FusionServices/v2/Naviline/OccupationalLicense/CustomCalcFields/{licenseYear}/{licenseNumber}/{licenseClass}

Return Values

NameDescription
ErrorCode Blank = Success, 0001=No Custom Calcx for license class
ErrorMessage Message returned with error code
CustomCalcDescription Field label
CustomCalcScreen Screen number to display field on
CustomCalcSequence Field sequence in page
CustomCalcType Type of field. C=Calcultated (non-editable), E=Editable
CustomCalcReceipt Required Y/N

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v2/Naviline/OccupationalLicense/CustomCalcFields/89/74/134";
    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")
    {
        JArray jRows = (JArray)response["Rows"];
        foreach (JObject row in jRows)
        {
             string CustomCalcDescription = row["CustomCalcDescription"].ToString();
             string CustomCalcScreen = row["CustomCalcScreen"].ToString();
             string CustomCalcSequence = row["CustomCalcSequence"].ToString();
             string CustomCalcType = row["CustomCalcType"].ToString();
             string CustomCalcReceipt = row["CustomCalcReceipt"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v2/Naviline/OccupationalLicense/CustomCalcFields/89/74/134', 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 GetCustomCalcFields
   {
       // 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 licenseYear{get; set;}

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

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

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

@{
   ViewBag.Title = "GetCustomCalcFields";
   string myUrl = "http://localhost/FusionServices/v2/Naviline/OccupationalLicense/CustomCalcFields/" + Model.licenseYear + "/" + Model.licenseNumber + "/" + Model.licenseClass;
}

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

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

// 
// POST: /MyController/GetCustomCalcFields
[HttpPost]
public ActionResult GetCustomCalcFields(FormCollection collection)
{
   string url = "v2/Naviline/OccupationalLicense/CustomCalcFields/{licenseYear}/{licenseNumber}/{licenseClass}";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("licenseYear", collection["licenseYear"]);
   inputParms.Add("licenseNumber", collection["licenseNumber"]);
   inputParms.Add("licenseClass", collection["licenseClass"]);

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