This API is used to get the status of a broadcast from UID
Service URL: GET /broadcast/{broadcastID}
Path parameters
broadcastID (required)
Request Headers:
Basic authentication
Response Body:
itemsAffected Integer format: int32
predefinedBroadcastId String dateTimeBroadcast (optional)
Date format: date-time
LastUpdated Date format: date-time
status String Enum: STARTED
EXPORTING
NOTHING_TO_EXPORT
EXPORT_FAILED
COLLATING
NOTHING_TO_COLLATE
COLLATING_FAILED
SENDING_TO_RECEIPIENTS
PARTIALLY_RECEIPTED
PARTIALLY_RECEIPTED_WITH_FAILUERS
PARTIALLY_RECEIPTED_WITH_FAILURES
FAILED
SUCCESSFUL
CANCELLED
Remarks
Get the status of a broadcast from UID
Scenarios:
| # | Scenario | Outcome | Expected Behavior | Status Code | Response |
|---|---|---|---|---|---|
| 1 | Request with no/wrong authorization header | Fail | Response contains error message | 401 Unauthorized | Unauthorized |
| 2 | Request with wrong UID | Fail | Response contains error message | 500 Internal Server Error | Error processing request |
| 3 | Valid request | Success | Response contains broadcast information | 200 OK | Refer to table below |
Example Response
{
"itemsAffected": 9,
"predefinedBroadcastId": "LOCATION",
"dateTimeBroadcast": 1628514037684,
"lastUpdated": 1628514070000,
"status": "SENDING_TO_RECEIPIENTS"
}