Set the Status of an External Batch - Brainware Intelligent Capture - Foundation 23.1 - Foundation 23.1 - Brainware

PUT /api/v1/ExternalBatch/{ExternalBatchRef}/Status/{BatchStatus}

This request sets the status of an external batch.

Provided that the external batch has not been locked for processing, the status can be set to any value between 10 and 999.

Note: Only a batch at status less than 20 can be set to Ready for Import (status 20).

Request Endpoint

/api/v1/ExternalBatch/{ExternalBatchRef}/Status/{BatchStatus}

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/20'

Sample Request

PUT 'http://localhost/BrainwareAPI/api/v1/ExternalBatch/BWB0000000001/Status/20' PUT /ExternalBatch/BWB0000000001/Status/20

Parameters

Parameter	Description	Type	Required
ExternalBatchRef	External batch reference	string	Required
BatchStatus	External batch status	string	Required

Sample Response

{}

Response Codes

Code	Description
204	External batch status updated.
404	External batch does not exist.
422	External batch reference and/or batch status is invalid.
423	External batch is ready for import or locked for RTS processing.

Set the Status of an External Batch - Brainware Intelligent Capture - Foundation 23.1 - Foundation 23.1 - Brainware - external

Brainware API Requests

PUT /api/v1/ExternalBatch/{ExternalBatchRef}/Status/{BatchStatus}