GET Batches/{InspectionKey}/{BatchKey}
Get the current status of a Batch.
The StatusCode value in the response will be one of:
- 0: NotFound - The requested batch does not exist.
- 1: Empty - No respondents have yet been added to the Batch.
- 2: Waiting - The Batch is awaiting additional respondents or start of the analysis.
- 3: Analyzing - Analysis has started and is not yet complete.
- 4: Success - Analysis has completed successfully.
- 5: Failure - Analysis has completed unsuccessfully.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| InspectionKey |
The key identifying an Inspection. |
integer |
Required |
| BatchKey |
The key identifying a Batch. |
integer |
Required |
Body Parameters
None.
Response Information
Get the current status of a Batch.
The StatusCode value in the response will be one of:
- 0: NotFound - The requested batch does not exist.
- 1: Empty - No respondents have yet been added to the Batch.
- 2: Waiting - The Batch is awaiting additional respondents or start of the analysis.
- 3: Analyzing - Analysis has started and is not yet complete.
- 4: Success - Analysis has completed successfully.
- 5: Failure - Analysis has completed unsuccessfully.
| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRespondents |
The number of respondents in the Batch. |
integer |
Required |
| StatusCode |
The current status of the Batch. |
BatchStatus |
Required |
| Status |
The current status of the Batch as a text value, e.g. "Waiting". |
string |
Required |
| FailureMessage |
If the StatusCode is Failure (5), the reason for the failure. |
string |
None. |
| InspectionKey |
The key of the Inspection. |
integer |
Required |
| BatchKey |
The key of the Batch. |
integer |
Required |
| errors |
If null the request was processed without error. If not null errors occurred while processing the request. The array contains the error messages. |
Collection of string |
None. |