GET api/SocialDriver/TelemetryAlert?alertId={alertId}
Get a Telemetry Alert by id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
alertId | unsigned integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A TelemetryAlertResponse
TelemetryAlertResponseName | Description | Type | Additional information |
---|---|---|---|
Id |
The alert id |
unsigned integer |
None. |
ServiceId |
The id of the service on the alert |
unsigned integer |
None. |
AlertType |
The type of alert |
AlertNotificationTypeEnum |
None. |
PushNotificationEnabled |
If push notifications are enabled |
boolean |
None. |
InboxMessageEnabled |
If inbox messages are enabled |
boolean |
None. |
EmailEnabled |
If email alerts are enabled |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "ServiceId": 2, "AlertType": 0, "PushNotificationEnabled": true, "InboxMessageEnabled": true, "EmailEnabled": true }
application/xml, text/xml
Sample:
<TelemetryAlertResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Id>1</Id> <ServiceId>2</ServiceId> <AlertType>Heartbeat_Voltage</AlertType> <PushNotificationEnabled>true</PushNotificationEnabled> <InboxMessageEnabled>true</InboxMessageEnabled> <EmailEnabled>true</EmailEnabled> </TelemetryAlertResponse>