GET CaseAttributeHistory?apikey={apikey}&NDC_Case_ID={NDC_Case_ID}&Attribute={Attribute}&HistoryDate={HistoryDate}

Returns the historical values of a given Case as tracked by the NDC. The response provides the Old Value, New Value and data of change for various attributes of a Case.

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
Attribute

The specified Attribute to lookup changes for on the given case. If not provided all changes are returned. Optional. If you don't provide the Attribute parameter then all historical values will be returned for the Case. The available attributes to lookup changes for are: Continued_DT, First_Meeting_DT, Meeting_DT, Cleared_DT, Closed_DT, Confirmed_DT, Discharge_Hearing_DT, Entered_DT, First_Payment_DT, Petition_Filed_DT, Plan_Filed_DT, First_Meeting_TM, Hearing_Confirm_TM, Trustee_PCT, Unsecured_PCT, Balance_On_Hand, Filing_Fee_PTD_Amt, Filing_Fee_Plan_AMT, Notice_Fee_AMT, Notice_Fee_PTD_AMT, Perm_Hold_AMT, Plan_Base, Total_Credit_Disbursed_AMT, Total_Disbursed_AMT, Total_Plan_Paid_AMT, Trustee_PTD_AMT, Attorney_Paid_Outside_Plan_AMT, Attorney_Paid_Plan_AMT, Attorney_PTD_AMT, Debtor1_Payroll_FREQ, Debtor1_Payroll_DED_AMT, Debtor1_Direct_AMT, Debtor1_Dir_Freq, Debtor2_Payroll_FREQ, Debtor2_Payroll_DED_AMT, Debtor2_Direct_AMT, Debtor2_Dir_Freq, Case_Status, Plan_Terms, Bar_DT, Delinquency_AMT, PacerLink, Debtor1_Education_Date, Debtor2_Education_Date, ConversionDT

 string

None.
HistoryDate

A single History Date in the form of MM/DD/YYYY. Returns only changes after the given HistoryDate. If no date is provided all history is returned. Optional.

 date

None.

Response Information

Response Schema Document

Resource Description

The Case Attributes that change (old value and new value and date of change).

Collection of CaseAttributeHistory
NameDescriptionTypeAdditional information
Action

string

None.
CaseNumber

string

None.
NDC_Case_ID

string

None.
AttributeName

string

None.
OldValue

string

None.
NewValue

string

None.
ChangeDate

string

None.

Response Formats

application/xml, text/xml

Sample: 
<ArrayOfCaseAttributeHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <CaseAttributeHistory>
    <Action>sample string 1</Action>
    <AttributeName>sample string 4</AttributeName>
    <CaseNumber>sample string 2</CaseNumber>
    <ChangeDate>sample string 7</ChangeDate>
    <NDC_Case_ID>sample string 3</NDC_Case_ID>
    <NewValue>sample string 6</NewValue>
    <OldValue>sample string 5</OldValue>
  </CaseAttributeHistory>
  <CaseAttributeHistory>
    <Action>sample string 1</Action>
    <AttributeName>sample string 4</AttributeName>
    <CaseNumber>sample string 2</CaseNumber>
    <ChangeDate>sample string 7</ChangeDate>
    <NDC_Case_ID>sample string 3</NDC_Case_ID>
    <NewValue>sample string 6</NewValue>
    <OldValue>sample string 5</OldValue>
  </CaseAttributeHistory>
</ArrayOfCaseAttributeHistory>

application/json, text/json

Sample: 
[
  {
    "Action": "sample string 1",
    "CaseNumber": "sample string 2",
    "NDC_Case_ID": "sample string 3",
    "AttributeName": "sample string 4",
    "OldValue": "sample string 5",
    "NewValue": "sample string 6",
    "ChangeDate": "sample string 7"
  },
  {
    "Action": "sample string 1",
    "CaseNumber": "sample string 2",
    "NDC_Case_ID": "sample string 3",
    "AttributeName": "sample string 4",
    "OldValue": "sample string 5",
    "NewValue": "sample string 6",
    "ChangeDate": "sample string 7"
  }
]