Contents x
[Get] Create a Batch
  • 08 Sep 2023
  • 1 Minute to read
  • PDF
Contents

[Get] Create a Batch

  • Updated on 08 Sep 2023
  • 1 Minute to read
  • PDF
Article Summary

GET  /api/DocBatch/CreateBatch

Required User-Role: BatchCreator

Creates a batch container into which batch records (documents for processing) can be added.

   

Request

GET /api/DocBatch/CreateBatch?tenantGuid={tenantGuid}&batchTypeGuid={batchTypeGuid}&batchReference={batchReference}
content-type: application/json
authorization: Bearer {token}

See Authentication for more about bearer tokens.

   

Query Parameters

tenantGuid (string)
The Guid of the batch tenant that will contain the batch.

batchTypeGuid (string)
The Batch Type definition for batch records within the batch.

batchReference (string)
User defined reference to identify the batch.


Response

200  Returns the success state and batchGuid or an error description.

{
  "isSuccess": true,
  "error": "string",
  "result": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Error Codes

HTTP

401 Unauthorized

403 Forbidden


Was this article helpful?
What's Next