PUT api/Batch/Process?processAllBatches={processAllBatches}&clientId={clientId}&processAllClients={processAllClients}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
processAllBatches

boolean

Default value is False

clientId

string

None.

processAllClients

boolean

Default value is False

Body Parameters

Collection of integer

Request Formats

application/json, text/json

Sample:
[
  1,
  2
]

application/xml, text/xml

Sample:
<ArrayOfInt xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <int>1</int>
  <int>2</int>
</ArrayOfInt>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ProcessBatchResponse
NameDescriptionTypeAdditional information
clientId

string

None.

batchNo

integer

None.

status

string

None.

errorMessage

string

None.

voucherJournalNo

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "clientId": "sample string 1",
    "batchNo": 2,
    "status": "sample string 3",
    "errorMessage": "sample string 4",
    "voucherJournalNo": 5
  },
  {
    "clientId": "sample string 1",
    "batchNo": 2,
    "status": "sample string 3",
    "errorMessage": "sample string 4",
    "voucherJournalNo": 5
  }
]

application/xml, text/xml

Sample:
<ArrayOfProcessBatchResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProcessBatchResponse>
    <clientId>sample string 1</clientId>
    <batchNo>2</batchNo>
    <status>sample string 3</status>
    <errorMessage>sample string 4</errorMessage>
    <voucherJournalNo>5</voucherJournalNo>
  </ProcessBatchResponse>
  <ProcessBatchResponse>
    <clientId>sample string 1</clientId>
    <batchNo>2</batchNo>
    <status>sample string 3</status>
    <errorMessage>sample string 4</errorMessage>
    <voucherJournalNo>5</voucherJournalNo>
  </ProcessBatchResponse>
</ArrayOfProcessBatchResponse>