GET PlanSteps?apikey={apikey}&NDC_Case_ID={NDC_Case_ID}

Returns the Plan Payment Steps a specific Case by its Case ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apikey

The apikey used for authentication. Required.

 string

Required
NDC_Case_ID

The ID of the Case requested. Required.

 string

Required

Response Information

Response Schema Document

Resource Description

A collection of the Plan Payment Steps found

Collection of PlanStep
NameDescriptionTypeAdditional information
NDC_Case_ID

string

None.
TrusteePK

integer

None.
CaseNumber

string

None.
Debtor_Name

string

None.
Payee_Name

string

None.
Start_DT

string

None.
Num_Periods

string

None.
Payment_AMT

string

None.
Payment_Freq

string

None.
Paying_Type

string

None.
WhichDebtor_Type

string

None.
End_DT

string

None.
Start_Month

string

None.
End_Month

string

None.

Response Formats

application/xml, text/xml

Sample: 
<ArrayOfPlanStep xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <PlanStep>
    <CaseNumber>sample string 3</CaseNumber>
    <Debtor_Name>sample string 4</Debtor_Name>
    <End_DT>sample string 12</End_DT>
    <End_Month>sample string 14</End_Month>
    <NDC_Case_ID>sample string 1</NDC_Case_ID>
    <Num_Periods>sample string 7</Num_Periods>
    <Payee_Name>sample string 5</Payee_Name>
    <Paying_Type>sample string 10</Paying_Type>
    <Payment_AMT>sample string 8</Payment_AMT>
    <Payment_Freq>sample string 9</Payment_Freq>
    <Start_DT>sample string 6</Start_DT>
    <Start_Month>sample string 13</Start_Month>
    <TrusteePK>2</TrusteePK>
    <WhichDebtor_Type>sample string 11</WhichDebtor_Type>
  </PlanStep>
  <PlanStep>
    <CaseNumber>sample string 3</CaseNumber>
    <Debtor_Name>sample string 4</Debtor_Name>
    <End_DT>sample string 12</End_DT>
    <End_Month>sample string 14</End_Month>
    <NDC_Case_ID>sample string 1</NDC_Case_ID>
    <Num_Periods>sample string 7</Num_Periods>
    <Payee_Name>sample string 5</Payee_Name>
    <Paying_Type>sample string 10</Paying_Type>
    <Payment_AMT>sample string 8</Payment_AMT>
    <Payment_Freq>sample string 9</Payment_Freq>
    <Start_DT>sample string 6</Start_DT>
    <Start_Month>sample string 13</Start_Month>
    <TrusteePK>2</TrusteePK>
    <WhichDebtor_Type>sample string 11</WhichDebtor_Type>
  </PlanStep>
</ArrayOfPlanStep>

application/json, text/json

Sample: 
[
  {
    "NDC_Case_ID": "sample string 1",
    "TrusteePK": 2,
    "CaseNumber": "sample string 3",
    "Debtor_Name": "sample string 4",
    "Payee_Name": "sample string 5",
    "Start_DT": "sample string 6",
    "Num_Periods": "sample string 7",
    "Payment_AMT": "sample string 8",
    "Payment_Freq": "sample string 9",
    "Paying_Type": "sample string 10",
    "WhichDebtor_Type": "sample string 11",
    "End_DT": "sample string 12",
    "Start_Month": "sample string 13",
    "End_Month": "sample string 14"
  },
  {
    "NDC_Case_ID": "sample string 1",
    "TrusteePK": 2,
    "CaseNumber": "sample string 3",
    "Debtor_Name": "sample string 4",
    "Payee_Name": "sample string 5",
    "Start_DT": "sample string 6",
    "Num_Periods": "sample string 7",
    "Payment_AMT": "sample string 8",
    "Payment_Freq": "sample string 9",
    "Paying_Type": "sample string 10",
    "WhichDebtor_Type": "sample string 11",
    "End_DT": "sample string 12",
    "Start_Month": "sample string 13",
    "End_Month": "sample string 14"
  }
]