POST api/ApnBulk/Queue

Request Information

URI Parameters

None.

Body Parameters

BulkQueueRequest
NameDescriptionTypeAdditional information
AccountIds

Collection of integer

None.

WorkflowIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountIds": [
    1,
    2
  ],
  "WorkflowIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<BulkQueueRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Bulk">
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AccountIds>
  <WorkflowIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </WorkflowIds>
</BulkQueueRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResultOfBulkQueueResult
NameDescriptionTypeAdditional information
Response

ApiResponse

None.

Data

BulkQueueResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Response": {
    "Success": true,
    "ErrorMessage": "sample string 2"
  },
  "Data": {
    "BatchId": 1,
    "Queued": 2,
    "AlreadyPending": 3,
    "NotFound": 4
  }
}

application/xml, text/xml

Sample:
<ApiResultOfBulkQueueResultpqgyCYEG 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:AlreadyPending>3</d2p1:AlreadyPending>
    <d2p1:BatchId>1</d2p1:BatchId>
    <d2p1:NotFound>4</d2p1:NotFound>
    <d2p1:Queued>2</d2p1:Queued>
  </Data>
  <Response>
    <ErrorMessage>sample string 2</ErrorMessage>
    <Success>true</Success>
  </Response>
</ApiResultOfBulkQueueResultpqgyCYEG>