GET /api/v1/ExternalBatch/{ExternalBatchRef}/ExternalDocument
This request returns a list of external documents in an external batch.
Request Endpoint
/api/v1/ExternalBatch/{ExternalBatchRef}/ExternalDocument
Sample Curl
curl -X GET --header 'Accept: application/json' --header 'Pragma: no-cache' --header 'Cache-Control: no-cache' 'http://localhost/BrainwareAPI/api/v1/ExternalBatch/BWB0000000001/ExternalDocument'
Sample Request
GET /ExternalBatch/BWB0000000001/ExternalDocument
Response
List of external document details for the external batch.
| Element | Description | Type | ||
|---|---|---|---|---|
| reference | External document reference | string | ||
| fileName | External document file name | string | ||
| index | Index value | string | ||
| uploadingTime | Uploading time as string | string | ||
Sample Response
[
{
"reference": "string",
"fileName": "string",
"index": 0,
"uploadingTime": "string"
}
]
Response Codes
| Code | Description |
|---|---|
| 200 | External document details returned. |
| 204 | List of external document details for the external batch. |
| 404 | External batch does not exist. |
| 422 | External batch reference is invalid. |