GET AdvancedCaseSearch?apikey={apikey}&caseNumber={caseNumber}&lowerCaseNumber={lowerCaseNumber}&upperCaseNumber={upperCaseNumber}&debtorLastName={debtorLastName}&debtorLastFourSsn={debtorLastFourSsn}&startRowIndex={startRowIndex}&maximumRows={maximumRows}
Searches the NDC case repository based on various search criteria
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
apikey |
The apikey used for authentication. Required. |
string |
Required |
caseNumber |
A Specific Case number to find. Optional. |
string |
None. |
lowerCaseNumber |
The lower bound of a set of Cases to find. Optional. |
string |
None. |
upperCaseNumber |
The upper bound of a set of Cases to find. Optional. |
string |
None. |
debtorLastName |
The Debtor's last name |
string |
None. |
debtorLastFourSsn |
The last four digits of the Debtor's SSN |
string |
None. |
startRowIndex |
Paging parameter for the zero-based index of the results - Optional, default 0. |
integer |
None. |
maximumRows |
Paging parameter for the maximum number of results to return. Optional, default 1000. |
integer |
None. |
Response Information
Response Schema Document
Resource Description
The cases in a portfolio that match the filters.
Collection of AdvancedCaseSearchName | Description | Type | Additional information |
---|---|---|---|
NDC_Case_ID | string |
None. |
|
CaseNumber | string |
None. |
|
DebtorName | string |
None. |
|
City | string |
None. |
|
CaseStatus | string |
None. |
|
TrusteeName | string |
None. |
|
InPortfolio | string |
None. |
Response Formats
application/xml, text/xml
Sample:
<ArrayOfAdvancedCaseSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models"> <AdvancedCaseSearch> <CaseNumber>sample string 2</CaseNumber> <CaseStatus>sample string 5</CaseStatus> <City>sample string 4</City> <DebtorName>sample string 3</DebtorName> <InPortfolio>sample string 7</InPortfolio> <NDC_Case_ID>sample string 1</NDC_Case_ID> <TrusteeName>sample string 6</TrusteeName> </AdvancedCaseSearch> <AdvancedCaseSearch> <CaseNumber>sample string 2</CaseNumber> <CaseStatus>sample string 5</CaseStatus> <City>sample string 4</City> <DebtorName>sample string 3</DebtorName> <InPortfolio>sample string 7</InPortfolio> <NDC_Case_ID>sample string 1</NDC_Case_ID> <TrusteeName>sample string 6</TrusteeName> </AdvancedCaseSearch> </ArrayOfAdvancedCaseSearch>
application/json, text/json
Sample:
[ { "NDC_Case_ID": "sample string 1", "CaseNumber": "sample string 2", "DebtorName": "sample string 3", "City": "sample string 4", "CaseStatus": "sample string 5", "TrusteeName": "sample string 6", "InPortfolio": "sample string 7" }, { "NDC_Case_ID": "sample string 1", "CaseNumber": "sample string 2", "DebtorName": "sample string 3", "City": "sample string 4", "CaseStatus": "sample string 5", "TrusteeName": "sample string 6", "InPortfolio": "sample string 7" } ]