Method PostRenewAddtlRequirements

Summary

Set Additional Requirements for Renew

Remarks

This sets the document number and expiration date for an additional requirement items

Get the additional requirement info, which are rows with type=REQ from either:

Use the Code, Description, and Type, from these methods.

Set the document number or expiration date to the value entered by the customer. Expiration date should be in the future.

Input Parameters

NameTypeLengthDescription
licenseYear numeric 2 [Required] License Year
licenseNumber numeric 8 [Required] License Number
code System.String 10 [Required] Additional requirement code
description System.String 40 [Required] Additional requirement description
type System.String 0 Additional Info type. Defaults to REQ for Additional Requirement
documentNum System.String 15 Document number. If GetLicenseAdditionals DocRequired field is Y, then this is required.
expireDate mmddyyyy 8 Expiration Date on additional requirement. If GetLicenseAdditionals ExpirationRequired field is Y, then this is required.

Example

POST http://localhost/FusionServices/v3/Naviline/OccupationalLicense/RenewAddtlRequirements

Return Values

NameDescription
ErrorCode 00=Success. Note: This only returns 2 digits for the error code
ErrorMessage Message returned with error code
LicenseYear License year
LicenseNumber License number
BaseFee Base fee for renewal
Exemption Exemption amount allowed
Penalty Penalty amount charged
Interest Interest amount charged
AdditionalCharge Additional charges
Total Total amount due
MinimumCharge Minimum Charge Y/N
FeePercent Fee Percentage
ChargePercent Charge Percentage
OverDuePeriodFlag Overdue Y/N
ChangeGrossReceiptsFlag Allow user to change the gross receipts amount during renewal? 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/RenewAddtlRequirements";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("licenseYear",System.Web.HttpUtility.UrlEncode("12"));
   postParms.Add("licenseNumber",System.Web.HttpUtility.UrlEncode("620"));
   postParms.Add("code",System.Web.HttpUtility.UrlEncode("DRINS"));
   postParms.Add("description",System.Web.HttpUtility.UrlEncode("PROOF OF VEH INSURANCE"));
   postParms.Add("type",System.Web.HttpUtility.UrlEncode("REQ"));
   postParms.Add("documentNum",System.Web.HttpUtility.UrlEncode("FL37564"));
   postParms.Add("expireDate",System.Web.HttpUtility.UrlEncode("07062018"));

   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 == "0000")
   {
         // 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 PostRenewAddtlRequirements
   {
       // 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,10}$).*", ErrorMessage = "Must be 10 characters or less. ")]
       public string code{get; set;}

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

       public string type{get; set;}

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

       [RegularExpression("^(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])(19|20)\\d\\d$", ErrorMessage = "Date values only. Format: MMDDYYYY")]
       public string expireDate{get; set;}

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

@{
   ViewBag.Title = "PostRenewAddtlRequirements";
}

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

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

// 
// POST: /MyController/PostRenewAddtlRequirements
[HttpPost]
public ActionResult PostRenewAddtlRequirements(FormCollection collection)
{
   string url = "v3/Naviline/OccupationalLicense/RenewAddtlRequirements";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("licenseYear", collection["licenseYear"]);
   inputParms.Add("licenseNumber", collection["licenseNumber"]);
   inputParms.Add("code", collection["code"]);
   inputParms.Add("description", collection["description"]);
   inputParms.Add("type", collection["type"]);
   inputParms.Add("documentNum", collection["documentNum"]);
   inputParms.Add("expireDate", collection["expireDate"]);

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