Method PostExploreAddtlCharge

Summary

Set Additional Charges for Explore License

Remarks

This sets the quantity of items for an additional charge that has a per-unit charge.

Get the additional charge info, which are rows with type=CHG from either:

Use the code, desc, type, unitCharge, and unitMeasure from these methods.

Set the quantity to the value entered by the customer.

Input Parameters

NameTypeLengthDescription
licenseClass System.String 7 [Required] License Classification
exemption System.String 2 Exemption code
businessName System.String 30 [Required] Business Name. Use the Job name from GetExplorePeriod
code System.String 10 [Required] Additional charge code
description System.String 40 [Required] Additional charge description
type System.String 0 Additional Info type. Defaults to CHG for Additional Charge
unitCharge System.String 10 [Required] Unit charge. 5 digit decimal. Ex. 1234567890 = $12,345.67890 It will remove dollar formatting, and parse to 5 decimals if entered.
unitMeasure System.String 2 Unit of Measure. Defaults to EA=Each.
quantity System.String 9 [Required] Unit charge. 2 digit decimal. Ex. 000000300 = 3.00 It will remove decimal formatting, and parse to 2 decimals if entered.

Example

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

Return Values

NameDescription
ErrorCode 0000=Success
ErrorMessage Message returned with error code
JobName Temp Job Name
CustomCalculations Custom calcuations available for license? Y/N
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
PenaltyPercent Penalty Percentage to be charged

Sample Responses

Sample Code

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

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/OccupationalLicense/ExploreAddtlCharge";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("licenseClass",System.Web.HttpUtility.UrlEncode("AL"));
   postParms.Add("businessName",System.Web.HttpUtility.UrlEncode("QZDASOINIT QUSER 535978"));
   postParms.Add("code",System.Web.HttpUtility.UrlEncode("US"));
   postParms.Add("description",System.Web.HttpUtility.UrlEncode("UNSPAYED OR UNEUTERED"));
   postParms.Add("type",System.Web.HttpUtility.UrlEncode("CHG"));
   postParms.Add("unitCharge",System.Web.HttpUtility.UrlEncode("0010000000"));
   postParms.Add("unitMeasure",System.Web.HttpUtility.UrlEncode(""));
   postParms.Add("quantity",System.Web.HttpUtility.UrlEncode("3.00"));

   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 PostExploreAddtlCharge
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("^(?=.{0,7}$).*", ErrorMessage = "Must be 7 characters or less. ")]
       public string licenseClass{get; set;}

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

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

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

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

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

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

@{
   ViewBag.Title = "PostExploreAddtlCharge";
}

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

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

// 
// POST: /MyController/PostExploreAddtlCharge
[HttpPost]
public ActionResult PostExploreAddtlCharge(FormCollection collection)
{
   string url = "v3/Naviline/OccupationalLicense/ExploreAddtlCharge";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("licenseClass", collection["licenseClass"]);
   inputParms.Add("exemption", collection["exemption"]);
   inputParms.Add("businessName", collection["businessName"]);
   inputParms.Add("code", collection["code"]);
   inputParms.Add("description", collection["description"]);
   inputParms.Add("type", collection["type"]);
   inputParms.Add("unitCharge", collection["unitCharge"]);
   inputParms.Add("unitMeasure", collection["unitMeasure"]);
   inputParms.Add("quantity", collection["quantity"]);

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