Method PostRenewBaseFees

Summary

Post Renew Base Fees

Remarks

Calculate base fee, interest, and other charges applied to the base license based on their gross receipts.

This does not include additional per unit charges, such as a per occupancy fee.

Input Parameters

NameTypeLengthDescription
licenseYear numeric 2 [Required] License Year
licenseNumber numeric 8 [Required] License Number
grossReceipts amount 11 [Required] Gross Receipts Amount
renewPeriod System.String 30 Renewal Period Y=Year, M=Month, Q=Quarter, H=Half-Year. Defaults to Year.
renewDate mmddyyyy 8 Renew Date. Defaults to current date.
applicantName System.String 30 Applicant Name
address1 System.String 30 Address Line 1
address2 System.String 30 Address Line 2
address3 System.String 30 Address Line 3
addressZip System.String 9 Address Zip Code
areaCode System.String 3 Area Code
phoneNumber System.String 7 Phone Number
email System.String 50 Email Address

Example

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

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/RenewBaseFees";
   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("grossReceipts",System.Web.HttpUtility.UrlEncode("22.01"));
   postParms.Add("renewPeriod",System.Web.HttpUtility.UrlEncode("y"));

   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 PostRenewBaseFees
   {
       // 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("^\\d{1,8}\\.(\\d{2,2})$", ErrorMessage = "Amount values only.  Example: 1234.56")]
       public string grossReceipts{get; set;}

       [RegularExpression("^(?=.{0,30}$).*", ErrorMessage = "Must be 30 characters or less. ")]
       public string renewPeriod{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 renewDate{get; set;}

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

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

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

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

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

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

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

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

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

@{
   ViewBag.Title = "PostRenewBaseFees";
}

<h2>PostRenewBaseFees</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>PostRenewBaseFees</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.grossReceipts)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.grossReceipts)
           @Html.ValidationMessageFor(model => model.grossReceipts)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.renewPeriod)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.renewPeriod)
           @Html.ValidationMessageFor(model => model.renewPeriod)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.renewDate)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.renewDate)
           @Html.ValidationMessageFor(model => model.renewDate)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.applicantName)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.applicantName)
           @Html.ValidationMessageFor(model => model.applicantName)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.address1)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.address1)
           @Html.ValidationMessageFor(model => model.address1)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.address2)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.address2)
           @Html.ValidationMessageFor(model => model.address2)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.address3)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.address3)
           @Html.ValidationMessageFor(model => model.address3)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.addressZip)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.addressZip)
           @Html.ValidationMessageFor(model => model.addressZip)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.areaCode)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.areaCode)
           @Html.ValidationMessageFor(model => model.areaCode)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.phoneNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.phoneNumber)
           @Html.ValidationMessageFor(model => model.phoneNumber)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.email)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.email)
           @Html.ValidationMessageFor(model => model.email)
       </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/PostRenewBaseFees
public ActionResult PostRenewBaseFees()
{
   // Create a new instance of the model to pick up any default values.
   PostRenewBaseFees model =  new PostRenewBaseFees();

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

// 
// POST: /MyController/PostRenewBaseFees
[HttpPost]
public ActionResult PostRenewBaseFees(FormCollection collection)
{
   string url = "v3/Naviline/OccupationalLicense/RenewBaseFees";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("licenseYear", collection["licenseYear"]);
   inputParms.Add("licenseNumber", collection["licenseNumber"]);
   inputParms.Add("grossReceipts", collection["grossReceipts"]);
   inputParms.Add("renewPeriod", collection["renewPeriod"]);
   inputParms.Add("renewDate", collection["renewDate"]);
   inputParms.Add("applicantName", collection["applicantName"]);
   inputParms.Add("address1", collection["address1"]);
   inputParms.Add("address2", collection["address2"]);
   inputParms.Add("address3", collection["address3"]);
   inputParms.Add("addressZip", collection["addressZip"]);
   inputParms.Add("areaCode", collection["areaCode"]);
   inputParms.Add("phoneNumber", collection["phoneNumber"]);
   inputParms.Add("email", collection["email"]);

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