POST api/SocialDriver/Services/TelemetryAlert
Get the telemetry alerts for multiple service ids
Request Information
URI Parameters
None.
Body Parameters
A list of service ids being requested
GetTelemetryAlertRequestName | Description | Type | Additional information |
---|---|---|---|
ServiceIds |
A list of service ids requested |
Collection of unsigned integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "ServiceIds": [ 1, 2 ] }
application/xml, text/xml
Sample:
<GetTelemetryAlertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ServiceIds> <unsignedLong>1</unsignedLong> <unsignedLong>2</unsignedLong> </ServiceIds> </GetTelemetryAlertRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of 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 }, { "Id": 1, "ServiceId": 2, "AlertType": 0, "PushNotificationEnabled": true, "InboxMessageEnabled": true, "EmailEnabled": true } ]
application/xml, text/xml
Sample:
<ArrayOfTelemetryAlertResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <TelemetryAlertResponse> <Id>1</Id> <ServiceId>2</ServiceId> <AlertType>Heartbeat_Voltage</AlertType> <PushNotificationEnabled>true</PushNotificationEnabled> <InboxMessageEnabled>true</InboxMessageEnabled> <EmailEnabled>true</EmailEnabled> </TelemetryAlertResponse> <TelemetryAlertResponse> <Id>1</Id> <ServiceId>2</ServiceId> <AlertType>Heartbeat_Voltage</AlertType> <PushNotificationEnabled>true</PushNotificationEnabled> <InboxMessageEnabled>true</InboxMessageEnabled> <EmailEnabled>true</EmailEnabled> </TelemetryAlertResponse> </ArrayOfTelemetryAlertResponse>