GetSystemStatus
Use the GetSystemStatus method to retrieve the status of your account. Use this method only during exception handling or as the first SOAP API call.
Don't use this method before every API call or at intervals less than 60 seconds. When troubleshooting, we recommend running this method every 10 minutes.
| Name | Data Type | Description |
|---|---|---|
| Options | SystemStatusOptions | Optionally specifies more processing options. |
| OverallStatus | String | Specifies the overall status of the request. |
| OverallStatusMessage | String | Specifies the overall status message of the request. |
| RequestID | String | A unique identifier for the request. |
This method returns an array of SystemStatusResult objects.
If the SystemStatusResult SystemStatus property equals OK, no action is required.
If the SystemStatusResult SystemStatus property equals InMaintenance, place your application in queue mode and periodically make the GetSystemStatus call until the status returns to OK.
If the SystemStatusResult SystemStatus property equals UnplannedOutage, place your application in queue mode and periodically make the GetSystemStatus call until the status returns to OK.
To understand and act on the system status, we recommend that you have these elements in place.
- A global status container in your application. This container can allow your application to change code paths to ensure that all messages are stored while waiting for the status to return to OK. If the global status container contains an InMaintenance or UnplannedOutage status, wait for the scheduled status checking component to update the global status container to the OK status.
- A scheduled status checking component in your software, so it can respond to error situations and update the global status container if the status is different.