Method PostSearchAmountDue

Summary

Search Amount Due - Coming soon... targeted release 23.1

Remarks

This API will return the amount due required for the project. The amount due for the project will be calculated and returned to the calling program with the application year and number. Note: The fee code of the charge must be flagged as ‘Start of plan check’ to be included in the amount due.

Requires

Input Parameters

NameTypeLengthDescription
projectID System.String 20 [Required] Project ID

Example

POST http://localhost/FusionServices/v3/Naviline/EPR/SearchAmountDue

Return Values

NameDescription
ErrorCode Error Code
ErrorMessage Error Message
APPYER Application Year
APPNBR Application Number
FEESDUE Fees Due

Error Details

Error CodeError Message
0000 Success
0001 Project number not found

Sample Responses

Sample Code

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

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/EPR/SearchAmountDue";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("projectID",System.Web.HttpUtility.UrlEncode("2200198"));

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

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

@{
   ViewBag.Title = "PostSearchAmountDue";
}

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

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

// 
// POST: /MyController/PostSearchAmountDue
[HttpPost]
public ActionResult PostSearchAmountDue(FormCollection collection)
{
   string url = "v3/Naviline/EPR/SearchAmountDue";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("projectID", collection["projectID"]);

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