Method GetLicenseAdditionalsAll

Summary

Gets Optional Charges and Additional Requirements for a license

Remarks

Gets Optional Charges and Additional Requirements for a license

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/v3/Naviline/OccupationalLicense/LicenseAdditionalsAll/{licenseYear}/{licenseNumber}/{licenseClass}

Return Values

NameDescription
ErrorCode 0000=Success
ErrorMessage Message returned with error code
Code Code for additional license requirement
Description Description
Type Type of requirement
UnitCharge Unit Charge. If the requirement has a per unit fee, such as a per gallon charge, this is the amount charged per unit. Example: $2.00 for $2.00 per gallon.
UnitMeasure Unit of Measure. If the requirement has a per unit fee, such as a per gallon charge, this is the unit of measure. Example: Gallons
Quantity Quantity. If the requirement has a per unit fee, such as a per gallon charge, this is quantity of units that were charged. Example: 10 for 10 gallons
DocumentNum Document Number. If the requirement requires a certificate or other certified document, this is the document number.
ExpirationDate Expiration date of the requirement or certificate
DocRequired Document required. Y/N
ExpirationRequired Expire Date required. Y/N
NonExempt Non Exempt
RequiredChargeFlag Required Charge Y/N
GrossReceipts Gross Receipts Amount reported for renewal
RenewalDate Renewal date
ApplicantQualifier Applicant Qualifier. Y/N
AdditionalCharges Additional Charges. Y/N
ROWS Number of Rows returned
ExpirationDate Expiration date of the license

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v3/Naviline/OccupationalLicense/LicenseAdditionalsAll/96/5/364";
    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 Code = row["Code"].ToString();
             string Description = row["Description"].ToString();
             string Type = row["Type"].ToString();
             string UnitCharge = row["UnitCharge"].ToString();
             string UnitMeasure = row["UnitMeasure"].ToString();
             string Quantity = row["Quantity"].ToString();
             string DocumentNum = row["DocumentNum"].ToString();
             string ExpirationDate = row["ExpirationDate"].ToString();
             string DocRequired = row["DocRequired"].ToString();
             string ExpirationRequired = row["ExpirationRequired"].ToString();
             string NonExempt = row["NonExempt"].ToString();
             string RequiredChargeFlag = row["RequiredChargeFlag"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v3/Naviline/OccupationalLicense/LicenseAdditionalsAll/96/5/364', 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 GetLicenseAdditionalsAll
   {
       // 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 GetLicenseAdditionalsAll()
       {
           //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 GetLicenseAdditionalsAll 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.GetLicenseAdditionalsAll

@{
   ViewBag.Title = "GetLicenseAdditionalsAll";
   string myUrl = "http://localhost/FusionServices/v3/Naviline/OccupationalLicense/LicenseAdditionalsAll/" + Model.licenseYear + "/" + Model.licenseNumber + "/" + Model.licenseClass;
}

<h2>GetLicenseAdditionalsAll</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>GetLicenseAdditionalsAll</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/GetLicenseAdditionalsAll
public ActionResult GetLicenseAdditionalsAll()
{
   // Create a new instance of the model to pick up any default values.
   GetLicenseAdditionalsAll model =  new GetLicenseAdditionalsAll();

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

// 
// POST: /MyController/GetLicenseAdditionalsAll
[HttpPost]
public ActionResult GetLicenseAdditionalsAll(FormCollection collection)
{
   string url = "v3/Naviline/OccupationalLicense/LicenseAdditionalsAll/{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", "GetLicenseAdditionalsAll");
       return View("Error", info);
   }
}