Method GetCaseByPaymentPlan

Summary

Get a court case by the payment plan number

Remarks

It will return all cases that the defendent owes money for.

Input Parameters

NameTypeLengthDescription
paymentPlanNumber numeric 11 Payment plan number

Example

GET http://localhost/FusionServices/v2/Naviline/CaseManagement/Plan/{paymentPlanNumber}

Return Values

NameDescription
SearchMode letter code indicating the type of search performed
Section Section
Application Application the case was created in. CS = Case Management
CaseNumber Case Number of the case returned
TicketNumber Ticket Number
ViolationDate Date of Violation. Format: MMDDYYYY
ViolationDescription Violation description
ViolationSequenceNumber Violation sequence number
TotalBalanceDue Total balance Amount due
BalanceDue Balance Amount due
PaymentPlanAmount Installment Amount for payment plan
DateOfBirth Defendent's Date of birth. Format: MMDDYYYY
CaseID internal case id
DEFNID DEF CPF ID
MRCSID MR Customer ID used for payments
MRNUM MR Master ID used for payments
CashReceiptsApp App code for cash receips app. CR = Cash Receipts
PlanID Payment plan ID
Name Defendent's name. Last, First
Address Defendent's address
City Defendent's city
State Defendent's state
Zip Defendent's zip code
DueDate Due Date for payment plan. Format: MMDDYYYY
PendingPayment Any pending payment Amount

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v2/Naviline/CaseManagement/Plan/5101";
    WebClient wc = new WebClient();
    wc.Headers.Set("X-APPID", "YOURID");
    wc.Headers.Set("X-APPKEY", "YOURKEY");
    string stringResult = wc.DownloadString(new Uri(uri));
    
    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 SearchMode = row["SearchMode"].ToString();
             string Section = row["Section"].ToString();
             string Application = row["Application"].ToString();
             string CaseNumber = row["CaseNumber"].ToString();
             string TicketNumber = row["TicketNumber"].ToString();
             string ViolationDate = row["ViolationDate"].ToString();
             string ViolationDescription = row["ViolationDescription"].ToString();
             string ViolationSequenceNumber = row["ViolationSequenceNumber"].ToString();
             string TotalBalanceDue = row["TotalBalanceDue"].ToString();
             string BalanceDue = row["BalanceDue"].ToString();
             string PaymentPlanAmount = row["PaymentPlanAmount"].ToString();
             string DateOfBirth = row["DateOfBirth"].ToString();
             string CaseID = row["CaseID"].ToString();
             string DEFNID = row["DEFNID"].ToString();
             string MRCSID = row["MRCSID"].ToString();
             string MRNUM = row["MRNUM"].ToString();
             string CashReceiptsApp = row["CashReceiptsApp"].ToString();
             string PlanID = row["PlanID"].ToString();
             string Name = row["Name"].ToString();
             string Address = row["Address"].ToString();
             string City = row["City"].ToString();
             string State = row["State"].ToString();
             string Zip = row["Zip"].ToString();
             string DueDate = row["DueDate"].ToString();
             string PendingPayment = row["PendingPayment"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v2/Naviline/CaseManagement/Plan/5101', function(response) {
    $('#resultDiv).html(response); 
 });

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 GetCaseByPaymentPlan
   {
       // Add property for each input param in order to map a field to it
       [RegularExpression("[0-9]{0,11}", ErrorMessage = "Numeric values only. Must be 11 digits or less. ")]
       public string paymentPlanNumber{get; set;}

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

@{
   ViewBag.Title = "GetCaseByPaymentPlan";
   string myUrl = "http://localhost/FusionServices/v2/Naviline/CaseManagement/Plan/" + Model.paymentPlanNumber;
}

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

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

// 
// POST: /MyController/GetCaseByPaymentPlan
[HttpPost]
public ActionResult GetCaseByPaymentPlan(FormCollection collection)
{
   string url = "v2/Naviline/CaseManagement/Plan/{paymentPlanNumber}";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("paymentPlanNumber", collection["paymentPlanNumber"]);

   try
   {
       // Send the request
       FusionServiceRequest request = new FusionServiceRequest();
       FusionServiceResult result = request.Get(url, inputParms);

       return View("Result", result);
   }
   catch(Exception e)
   {
       HandleErrorInfo info = new HandleErrorInfo(e, "MyController", "GetCaseByPaymentPlan");
       return View("Error", info);
   }
}