POST api/ApnBulk/Search

Request Information

URI Parameters

None.

Body Parameters

BulkSearchCriteria
NameDescriptionTypeAdditional information
EntityIds

Collection of integer

None.

IncludeChildEntities

boolean

None.

AccountStatusIds

Collection of integer

None.

AccountStatusTypeIds

Collection of integer

None.

PoolIds

Collection of integer

None.

AccountManagerIds

Collection of integer

None.

MasterWorkflowIds

Collection of integer

None.

LastRunWorkflowIds

Collection of integer

None.

BalanceFrom

decimal number

None.

BalanceTo

decimal number

None.

OpenFrom

date

None.

OpenTo

date

None.

LoadFrom

date

None.

LoadTo

date

None.

LastPaymentFrom

date

None.

LastPaymentTo

date

None.

HasActiveArrangement

boolean

None.

ExcludeBreathingSpace

boolean

None.

IncludeInactive

boolean

None.

Pasted

string

None.

PasteKind

string

None.

AdvancedAccountIds

Collection of integer

None.

Page

integer

None.

PageSize

integer

None.

SortKey

string

None.

SortDesc

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "EntityIds": [
    1,
    2
  ],
  "IncludeChildEntities": true,
  "AccountStatusIds": [
    1,
    2
  ],
  "AccountStatusTypeIds": [
    1,
    2
  ],
  "PoolIds": [
    1,
    2
  ],
  "AccountManagerIds": [
    1,
    2
  ],
  "MasterWorkflowIds": [
    1,
    2
  ],
  "LastRunWorkflowIds": [
    1,
    2
  ],
  "BalanceFrom": 1.0,
  "BalanceTo": 1.0,
  "OpenFrom": "2026-11-18T13:30:20.4096001+00:00",
  "OpenTo": "2026-11-18T13:30:20.4096001+00:00",
  "LoadFrom": "2026-11-18T13:30:20.4096001+00:00",
  "LoadTo": "2026-11-18T13:30:20.4096001+00:00",
  "LastPaymentFrom": "2026-11-18T13:30:20.4096001+00:00",
  "LastPaymentTo": "2026-11-18T13:30:20.4096001+00:00",
  "HasActiveArrangement": true,
  "ExcludeBreathingSpace": true,
  "IncludeInactive": true,
  "Pasted": "sample string 4",
  "PasteKind": "sample string 5",
  "AdvancedAccountIds": [
    1,
    2
  ],
  "Page": 6,
  "PageSize": 7,
  "SortKey": "sample string 8",
  "SortDesc": true
}

application/xml, text/xml

Sample:
<BulkSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Bulk">
  <AccountManagerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AccountManagerIds>
  <AccountStatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AccountStatusIds>
  <AccountStatusTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AccountStatusTypeIds>
  <AdvancedAccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AdvancedAccountIds>
  <BalanceFrom>1</BalanceFrom>
  <BalanceTo>1</BalanceTo>
  <EntityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EntityIds>
  <ExcludeBreathingSpace>true</ExcludeBreathingSpace>
  <HasActiveArrangement>true</HasActiveArrangement>
  <IncludeChildEntities>true</IncludeChildEntities>
  <IncludeInactive>true</IncludeInactive>
  <LastPaymentFrom>2026-11-18T13:30:20.4096001+00:00</LastPaymentFrom>
  <LastPaymentTo>2026-11-18T13:30:20.4096001+00:00</LastPaymentTo>
  <LastRunWorkflowIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </LastRunWorkflowIds>
  <LoadFrom>2026-11-18T13:30:20.4096001+00:00</LoadFrom>
  <LoadTo>2026-11-18T13:30:20.4096001+00:00</LoadTo>
  <MasterWorkflowIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </MasterWorkflowIds>
  <OpenFrom>2026-11-18T13:30:20.4096001+00:00</OpenFrom>
  <OpenTo>2026-11-18T13:30:20.4096001+00:00</OpenTo>
  <Page>6</Page>
  <PageSize>7</PageSize>
  <PasteKind>sample string 5</PasteKind>
  <Pasted>sample string 4</Pasted>
  <PoolIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PoolIds>
  <SortDesc>true</SortDesc>
  <SortKey>sample string 8</SortKey>
</BulkSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResultOfBulkSearchPage
NameDescriptionTypeAdditional information
Response

ApiResponse

None.

Data

BulkSearchPage

None.

Response Formats

application/json, text/json

Sample:
{
  "Response": {
    "Success": true,
    "ErrorMessage": "sample string 2"
  },
  "Data": {
    "Total": 1,
    "Page": 2,
    "PageSize": 3,
    "Rows": [
      {
        "sample string 1": {},
        "sample string 3": {}
      },
      {
        "sample string 1": {},
        "sample string 3": {}
      }
    ],
    "PastedIgnored": 4
  }
}

application/xml, text/xml

Sample:
<ApiResultOfBulkSearchPagepqgyCYEG xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Bulk">
    <d2p1:Page>2</d2p1:Page>
    <d2p1:PageSize>3</d2p1:PageSize>
    <d2p1:PastedIgnored>4</d2p1:PastedIgnored>
    <d2p1:Rows xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfKeyValueOfstringanyType>
        <d3p1:KeyValueOfstringanyType>
          <d3p1:Key>sample string 1</d3p1:Key>
          <d3p1:Value />
        </d3p1:KeyValueOfstringanyType>
        <d3p1:KeyValueOfstringanyType>
          <d3p1:Key>sample string 3</d3p1:Key>
          <d3p1:Value />
        </d3p1:KeyValueOfstringanyType>
      </d3p1:ArrayOfKeyValueOfstringanyType>
      <d3p1:ArrayOfKeyValueOfstringanyType>
        <d3p1:KeyValueOfstringanyType>
          <d3p1:Key>sample string 1</d3p1:Key>
          <d3p1:Value />
        </d3p1:KeyValueOfstringanyType>
        <d3p1:KeyValueOfstringanyType>
          <d3p1:Key>sample string 3</d3p1:Key>
          <d3p1:Value />
        </d3p1:KeyValueOfstringanyType>
      </d3p1:ArrayOfKeyValueOfstringanyType>
    </d2p1:Rows>
    <d2p1:Total>1</d2p1:Total>
  </Data>
  <Response>
    <ErrorMessage>sample string 2</ErrorMessage>
    <Success>true</Success>
  </Response>
</ApiResultOfBulkSearchPagepqgyCYEG>