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

Brainware API Requests
Platform
Brainware
Product
Brainware Intelligent Capture
Release
Foundation 23.1
License

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

This request returns the status of an external batch.

Request Endpoint

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

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

Sample Request

GET /ExternalBatch/BWB0000000001/Status

Parameters

Parameter Description Type Required
ExternalBatchRef External batch reference string required

Response

Element Description Type Possible Values
status External batch status integer

  • 10: Documents can be added or removed from a batch.

  • 15: The batch has been processed by RTS, the import of one or more documents failed.

  • 20: The batch has been marked 'ready for import' and documents can no longer be added or removed. The batch is ready to be processed by RTS.

  • 100: All documents from the batch have been processed by RTS.

Sample Response

{ "status": 0 }

Response Codes

Code Description
200 External batch status returned.
404 External batch does not exist.
422 Invalid external batch reference.