- 15.5
Description
The CustomerEmergency endpoint provides the API consumer with access to methods pertaining to Customer Emergencies and related data objects. The methods allow consumers to pull data regarding outages and alarms experienced by customers.
Methods
| URL | base/EMS/CustomerEmergency/Specification |
|---|---|
| Action | GET |
| Description | Returns a data dictionary that details the available web service methods related to Customer Emergency. |
| Parameters | None |
| Returns | A JSON object with method descriptions |
| Sample Return Object | |
[
{
"HttpAction": "Get",
"MethodName": "GetActiveOutageStatus",
"Description": "Returns a JSON object containing a 'Value' (true/false) based on whether the customer (with the associated customer ID) is currently experiencing a service outage.",
"Path": "/CustomerEmergency/GetActiveOutageStatus/25032"
}
]
|
|
| URL | base/EMS/CustomerEmergency/GetActiveOutageStatus/ID | ||
|---|---|---|---|
| Action | GET | ||
| Description | Returns a JSON Boolean object (true/false) as to whether the specified client is currently experiencing an outage. | ||
| Parameters | |||
| Name | Required? | Code | Description |
| ID | Yes | Integer | An integer value representing the ID of a customer in the M4 database. |
| Returns | A JSON boolean data object | ||
| Sample Return Object | |||
{
"Value": true
}
|
|||