POST api/Alarm/UnitAlarms?serialNumber={serialNumber}

Update list of alarm subscriptions on a unit.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serialNumber

unit serialnumber

string

Required

Body Parameters

alarm subscriptions to update

Collection of AlarmNotificationModel
NameDescriptionTypeAdditional information
AlarmId

integer32

None.

AlarmName

string

None.

Description

string

None.

Enabled

boolean

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "AlarmId": 1,
    "AlarmName": "sample string 2",
    "Description": "sample string 3",
    "Enabled": true
  },
  {
    "AlarmId": 1,
    "AlarmName": "sample string 2",
    "Description": "sample string 3",
    "Enabled": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfAlarmNotificationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.Alarm">
  <AlarmNotificationModel>
    <AlarmId>1</AlarmId>
    <AlarmName>sample string 2</AlarmName>
    <Description>sample string 3</Description>
    <Enabled>true</Enabled>
  </AlarmNotificationModel>
  <AlarmNotificationModel>
    <AlarmId>1</AlarmId>
    <AlarmName>sample string 2</AlarmName>
    <Description>sample string 3</Description>
    <Enabled>true</Enabled>
  </AlarmNotificationModel>
</ArrayOfAlarmNotificationModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Update list of alarm subscriptions on a unit.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.