PUT /api/v1/ExternalBatch/{ExternalBatchRef}/Status/MarkReadyForImport
This request sets an external batch to "Ready for Import" status
The status of the external batch will be set to 20, indicating that the batch is 'ready for import' by RTS.
A batch at this status can no longer have documents added or removed.
This method is only applicable to batches at a status less than 20.
Request Endpoint
/api/v1/ExternalBatch/{ExternalBatchRef}/Status/MarkReadyForImport
Sample Curl
curl -X PUT --header 'Accept: application/json' --header 'Pragma: no-cache' --header 'Cache-Control: no-cache' 'http://localhost/BrainwareAPI/api/v1/ExternalBatch/BWB0000000001/Status/MarkReadyForImport'
Sample Request
PUT /ExternalBatch/BWB0000000001/Status/MarkReadyForImport
Parameters
| Parameter | Description | Type | Required |
|---|---|---|---|
| ExternalBatchRef | External batch reference | string | Required |
Sample Response
{}
Response Codes
| Code | Description |
|---|---|
| 204 | External batch marked as "Ready for Import". |
| 404 | External batch does not exist. |
| 422 | External batch reference is invalid. |
| 423 | External batch is processed by RTS. |