Method GetLicenseDetail

Summary

Get License Detail

Input Parameters

NameTypeLengthDescription
licenseYear numeric 2 [Required] License Year. 2 digit
licenseNumber numeric 8 [Required] License Number

Example

GET http://localhost/FusionServices/v3/Naviline/OccupationalLicense/LicenseDetail/{licenseYear}/{licenseNumber}

Return Values

NameDescription
ErrorCode 0000=Success
ErrorMessage Message returned with error code
PeriodName Description for the period the license is valid
PeriodType Period type
ControlNumber Business control number
Locationnumber Location number
Name Business name
Address Business Address
CityStateZip Business City, ST Zip line
MailingAddressLine1 Business Mail address line 1
MailingAddressLine2 Business Mail address line 2
MailingCityStateZip Business Mail City, ST Zip line
MailingDeliveryPoint Business Mail Delivery Point
MainAreaCode Area Code
MainPhoneNumber Phone number
BusinessStatusCode Business Status
BusinessStatusDesc Business Status description
OpenDate Date Opened
ContractorFlag Contractor Y/N
OwnershipCode Ownership Code
OwnershipCodeDesc Ownership Code description
FedTaxID Federal Tax ID
OwnerName Owner Name
ClassCode License Classification Code
ClassCodeDesc License Classification Description
ApplicationDate Application date. Format=MMddyyyy
IssueDate Issue date. Format=MMddyyyy
StatusCode Status Code
StatusCodeDesc Status Description
LicenseRenewYear License year for Renew
LicenseRenewNumber License Number for Renew
LicenseStatusDate License Status Date
LicenseRenewThruDate License Renew Thru Date
LicenseOpenPeriodFlag Open Period for renewal? Y/N
RenewToYear Renew to year
RenewToLic New License Number if Renew
AllowRenew Allow renewal? Y/N
BalanceDue Balance Amount due
CustomCalcs Custom Calculations required Y/N

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v3/Naviline/OccupationalLicense/LicenseDetail/96/1";
    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 PeriodName = row["PeriodName"].ToString();
             string PeriodType = row["PeriodType"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v3/Naviline/OccupationalLicense/LicenseDetail/96/1', 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 GetLicenseDetail
   {
       // 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;}

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

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

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

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

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

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