GET Portfolios?apikey={apikey}&caseNumber={caseNumber}&lowerCaseNumber={lowerCaseNumber}&upperCaseNumber={upperCaseNumber}&debtorLastName={debtorLastName}&debtorLastFourSsn={debtorLastFourSsn}&startRowIndex={startRowIndex}&maximumRows={maximumRows}

Gets all of the Cases in a single portfolio, as found by the specified filters

Request Information

URI Parameters

NameDescriptionTypeAdditional 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 PortfolioCase
NameDescriptionTypeAdditional information
NDC_Case_ID

string

None.

CaseNumber

string

None.

DebtorName

string

None.

City

string

None.

CaseStatus

string

None.

TrusteeName

string

None.

Response Formats

application/xml, text/xml

Sample:
<ArrayOfPortfolioCase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <PortfolioCase>
    <CaseNumber>sample string 2</CaseNumber>
    <CaseStatus>sample string 5</CaseStatus>
    <City>sample string 4</City>
    <DebtorName>sample string 3</DebtorName>
    <NDC_Case_ID>sample string 1</NDC_Case_ID>
    <TrusteeName>sample string 6</TrusteeName>
  </PortfolioCase>
  <PortfolioCase>
    <CaseNumber>sample string 2</CaseNumber>
    <CaseStatus>sample string 5</CaseStatus>
    <City>sample string 4</City>
    <DebtorName>sample string 3</DebtorName>
    <NDC_Case_ID>sample string 1</NDC_Case_ID>
    <TrusteeName>sample string 6</TrusteeName>
  </PortfolioCase>
</ArrayOfPortfolioCase>

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"
  },
  {
    "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"
  }
]