Method PostSearchAmountDue

Summary

Search records with an Amount Due

Remarks

Gets amount due for either all projects or only those with a bill due. Allows for paging to handle a large file size.

If MOREYN returns Y, call the method again, passing in the LASTPYER and LASTPNBR values as the projectYear and projectNumber to continue retrieving all the records.

Requires

Input Parameters

NameTypeLengthDescription
rows numeric 9 Number of rows to return at a time.
projectYear numeric 2 Last Project Year returned from previous search. Leave blank for initial search.
projectNumber numeric 8 Last Project Number returned from previous search. Leave blank for initial search.
selectAmountDue yn 1 Select Amount Due option. Y=Return only applications where amount due > $0.00, N=Return all applications. Default is N.

Example

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

Return Values

NameDescription
YEAR Project Year
PROJECT Project Number
BALANCE_DUE Amount Due on the application
DESCRIPTION Description
DEVELOPER Developer name
ROWS Number of rows returned
LASTPYER Last Project Year returned
LASTPNBR Last Project Number returned
MOREYN More records Y/N
ErrorCode Error code 0000=Success
ErrorMessage Error Message

Sample Responses

Sample Code

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

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/PlanningEngineering/SearchAmountDue";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("projectYear",System.Web.HttpUtility.UrlEncode("16"));
   postParms.Add("projectNumber",System.Web.HttpUtility.UrlEncode("5"));
   postParms.Add("selectAmountDue",System.Web.HttpUtility.UrlEncode("Y"));
   postParms.Add("rows",System.Web.HttpUtility.UrlEncode("2"));

   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")
   {
        JArray jRows = (JArray)response["Rows"];
        foreach (JObject row in jRows)
        {
             string YEAR = row["YEAR"].ToString();
             string PROJECT = row["PROJECT"].ToString();
             string BALANCE_DUE = row["BALANCE_DUE"].ToString();
             string DESCRIPTION = row["DESCRIPTION"].ToString();
             string DEVELOPER = row["DEVELOPER"].ToString();
             // 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
       [RegularExpression("[0-9]{0,9}", ErrorMessage = "Numeric values only. Must be 9 digits or less. ")]
       public string rows{get; set;}

       [RegularExpression("[0-9]{0,2}", ErrorMessage = "Numeric values only. Must be 2 digits or less. ")]
       public string projectYear{get; set;}

       [RegularExpression("[0-9]{0,8}", ErrorMessage = "Numeric values only. Must be 8 digits or less. ")]
       public string projectNumber{get; set;}

       [RegularExpression("^[YN]{0,1}$", ErrorMessage = "Must be Y or N.")]
       public string selectAmountDue{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.rows)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.rows)
           @Html.ValidationMessageFor(model => model.rows)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.projectYear)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.projectYear)
           @Html.ValidationMessageFor(model => model.projectYear)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.projectNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.projectNumber)
           @Html.ValidationMessageFor(model => model.projectNumber)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.selectAmountDue)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.selectAmountDue)
           @Html.ValidationMessageFor(model => model.selectAmountDue)
       </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/PlanningEngineering/SearchAmountDue";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("rows", collection["rows"]);
   inputParms.Add("projectYear", collection["projectYear"]);
   inputParms.Add("projectNumber", collection["projectNumber"]);
   inputParms.Add("selectAmountDue", collection["selectAmountDue"]);

   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);
   }
}