Contents x
[Get] Get Batch Record Document
  • 08 Sep 2023
  • 1 Minute to read
  • PDF
Contents

[Get] Get Batch Record Document

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

GET  /api/DocBatch/GetBatchRecordDocument

Required User-Role: BatchViewer

Returns the payload of the document for the specified batch record as a stream.


Request

GET /api/DocBatch/GetBatchRecordDocument?tenantGuid={tenantGuid}&batchGuid={batchGuid}&batchRecordId={batchRecordId}
content-type: application/json
authorization: Bearer {token}

See Authentication for more about bearer tokens.

   

Query Parameters

tenantGuid (string($uuid)) Required
The Guid of the batch tenant containing the batch.

batchGuid (string($uuid)) Required
Unique Guid of the batch containing the batch record.

batchRecordId (integer($int64)) Required 
ID of the batch record.

   

Response

200  Returns the batch record payload.

// application/octet-stream

string

Error Codes

HTTP

401 Unauthorized

403 Forbidden


Was this article helpful?
What's Next