Get the Organization Compliance Status for a RedSky Account
Get the organization compliance status for a RedSky account. The locationStatus.state in the response will show the state for the location that is in the earliest stage of configuration.
The enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.
To retrieve organization compliance status requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
Retrieve the compliance status for the organization.
Response Properties
The RedSky account configuration status for the organization.
RedSky account configuration process is in progress.
RedSky account configuration process is complete.
Customer has opted out of the E911 service.
The RedSky account's compliance status.
Customer has opted out of the E911 service.
RedSky account compliance status has been exempted.
RedSky account is non-compliant.
RedSky account is compliant.
The RedSky held token from the secret response.
The RedSky organization ID for the organization which can be found in the RedSky portal.
true if an Admin has been created in RedSky.
Object that contains a list of locations, the count for the location list, and the state for the location that has completed the least amount of setup. Available if at least one location is exists.
Configuration stage that was last completed. The order of precedence is LOCATION_SETUP, ALERTS, NETWORK_ELEMENTS, ROUTING_ENABLE. If at least one location is LOCATION_SETUP, then locationState will be set to LOCATION_SETUP. Otherwise, locationState will check for the next precedence option and at least one location should have that option.
RedSky account is pending location setup.
RedSky account is pending email notification configuration.
RedSky account is pending network element setup.
RedSky account is pending the routing enable setup stage.
Total count of locations available in the organization.
List of locations that have completed the least amount of setup. Only 4 locations are included in this list.
Unique identifier for the location.
Name of the location.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Retrieve the compliance status for the organization.
{
"orgStatus": "INITIALISE",
"complianceStatus": "NON_COMPLIANT",
"companyId": "ddd1424c-5b48-433d-9bab-061cdfb84c90",
"redSkyOrgId": "2ff43e05-af11-41ff-91b6-87a3b509f4z4",
"adminExists": true,
"locationsStatus": {
"state": "LOCATION_SETUP",
"count": 2,
"locations": [
{
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"name": "MainOffice"
}
]
}
}