GET apioauth/matrixv2/services/{serviceId}/voltagealerts

Get voltage alerts for a service id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serviceId

The service id queried

unsigned integer

Required

Body Parameters

None.

Response Information

Resource Description

A VoltageAlertResponse

VoltageAlertResponse
NameDescriptionTypeAdditional information
VoltageAlerts

The voltage alerts for the requested service

Collection of VoltageAlert

None.

Response Formats

application/json, text/json

Sample:
{
  "VoltageAlerts": [
    {
      "Id": 1,
      "Title": "sample string 2",
      "Message": "sample string 3",
      "VoltageThreshold": 4.1,
      "PushNotificationEnabled": true,
      "InboxMessageEnabled": true,
      "EmailEnabled": true
    },
    {
      "Id": 1,
      "Title": "sample string 2",
      "Message": "sample string 3",
      "VoltageThreshold": 4.1,
      "PushNotificationEnabled": true,
      "InboxMessageEnabled": true,
      "EmailEnabled": true
    }
  ]
}

application/xml, text/xml

Sample:
<VoltageAlertResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VoltageAlerts>
    <VoltageAlert>
      <Id>1</Id>
      <Title>sample string 2</Title>
      <Message>sample string 3</Message>
      <VoltageThreshold>4.1</VoltageThreshold>
      <PushNotificationEnabled>true</PushNotificationEnabled>
      <InboxMessageEnabled>true</InboxMessageEnabled>
      <EmailEnabled>true</EmailEnabled>
    </VoltageAlert>
    <VoltageAlert>
      <Id>1</Id>
      <Title>sample string 2</Title>
      <Message>sample string 3</Message>
      <VoltageThreshold>4.1</VoltageThreshold>
      <PushNotificationEnabled>true</PushNotificationEnabled>
      <InboxMessageEnabled>true</InboxMessageEnabled>
      <EmailEnabled>true</EmailEnabled>
    </VoltageAlert>
  </VoltageAlerts>
</VoltageAlertResponse>