Status updates can be received via Azure Service Bus. For additional information on how to interact with the Azure Service Bus please refer to the Service Bus Runtime REST documentation.
Every notification represents the latest orchestration state (appointments, payments made on behalf of the integrator, container status and error messages and warnings). Each notification is triggered by internal system notification of changes of any fields of the container data, appointment data, successful payments and when an error/warning occurs. The usual sequence of messages for an orchestration with no fees on the container and appointments is the following:
- Orchestration status ACTIVE. Container Status empty. - orchestration is functional, but the container has not been located yet.
- Container Status with data - no appointment has been requested yet.
- 'reservation_preferences' field is populated with selected preferences. - appointment request is about to be initiated.
- Appointment data is set, and status is set to PENDING - appointment is being requested and pending slot confirmation.
- 'reservation_preferences' field is cleared. Appointment data is set with ticket number and slot information. - slot is secured.
| Name | Description |
|---|---|
| orchestration_request | object Information relevant to the notification orchestration request |
| trade_type | string Trade type |
| unit_nbr | string Unit number. Eleven-digit number for containers |
| orchestration_request. notification_type | list of string List of types of notification. "Appointment" indicates a notification triggered by the appointment system. An empty list indicates a general notification. |
| orchestration_request. sections_updated | list of string List of sections with modifications since the previous notification. Possible values are: "orchestration_status", "unitinfo", "unitstatusinfo", "locations", "holdinfo", "fee_receipts", "lfdinfo" and "activity". Please refer to "Container Status object" for more information on these sections. |
| orchestration_status | object Orchestration status object |
| unit_status | object Container status object |
The following example retrieves a message and deletes it from the ASB queue (destructive read). Request
DELETE https://{serviceNamespace}.servicebus.windows.net/{provided by SprintPass Pro}/subscriptions/orchestrationupdates/messages/head{
"orchestration_request": {
"trade_type": "string",
"unit_nbr": "string",
"notification_type": [],
"sections_updated": []
},
"orchestration_status": {
"status": "string",
"submitted_dttm": "string",
"initiated_dttm": "string",
"ended_dttm": "string",
"messages": [
{
"message_cd": "string",
"message_txt": "string",
"message_severity_cd": "string"
}
]
},
"unit_status": {
"unitinfo": {
"unit_cat": "string",
"unit_nbr": "string",
"unittypeiso_cd": "string"
},
...
...
}
}