| PUT | /Alarm | ||
|---|---|---|---|
| PUT | /Alarm/{Id} | ||
| GET POST | /UpdateAlarm | ||
| GET POST | /UpdateAlarm/{Id} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | No | |
| Name | body | string | No | |
| Enabled | body | bool? | No | |
| AllUnits | body | bool? | No | |
| ClearUnits | body | bool? | No | |
| AddUnits | body | string[] | No | |
| RemoveUnits | body | string[] | No | |
| ClearGroups | body | bool? | No | |
| AddGroups | body | string[] | No | |
| RemoveGroups | body | string[] | No | |
| ClearEmailRecipients | body | bool? | No | |
| AddEmailRecipients | body | string[] | No | |
| RemoveEmailRecipients | body | string[] | No | |
| ClearSystemRecipients | body | bool? | No | |
| AddSystemRecipients | body | string[] | No | |
| RemoveSystemRecipients | body | string[] | No | |
| ClearSmsRecipients | body | bool? | No | |
| AddSmsRecipients | body | string[] | No | |
| RemoveSmsRecipients | body | string[] | No | |
| TemperatureLimits | body | TemperatureAlarmLimits | No | |
| ADVoltageLimits | body | ADVoltageAlarmLimits | No | |
| ADVoltageInputIndex | body | int? | No | |
| Threshold | body | double? | No | |
| BatteryLevel | body | double? | No | |
| Location | body | Location | No | |
| Radius | body | double? | No | |
| InputIndex | body | int? | No | |
| Interval | body | double? | No | |
| PointId | body | string | No | |
| ExpectedArrivalTime | body | DateTime? | No | |
| PowerLevel | body | double? | No | |
| Weekdays | body | string[] | No | |
| TimeStart | body | TimeOfDay | No | |
| TimeEnd | body | TimeOfDay | No | |
| ZoneId | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Temperature1LowerLimit | form | double? | No | |
| Temperature1UpperLimit | form | double? | No | |
| Temperature2LowerLimit | form | double? | No | |
| Temperature2UpperLimit | form | double? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ADVoltageLowerLimit | form | double? | No | |
| ADVoltageUpperLimit | form | double? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Latitude | form | double | No | |
| Longitude | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Hour | form | int | No | |
| Minute | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/UpdateAlarm HTTP/1.1
Host: api.trackunit.com
Content-Type: application/json
Content-Length: length
{"id":"String","name":"String","enabled":false,"allUnits":false,"clearUnits":false,"addUnits":["String"],"removeUnits":["String"],"clearGroups":false,"addGroups":["String"],"removeGroups":["String"],"clearEmailRecipients":false,"addEmailRecipients":["String"],"removeEmailRecipients":["String"],"clearSystemRecipients":false,"addSystemRecipients":["String"],"removeSystemRecipients":["String"],"clearSmsRecipients":false,"addSmsRecipients":["String"],"removeSmsRecipients":["String"],"temperatureLimits":{"temperature1LowerLimit":0,"temperature1UpperLimit":0,"temperature2LowerLimit":0,"temperature2UpperLimit":0},"adVoltageLimits":{"adVoltageLowerLimit":0,"adVoltageUpperLimit":0},"adVoltageInputIndex":0,"threshold":0,"batteryLevel":0,"location":{"latitude":0,"longitude":0},"radius":0,"inputIndex":0,"interval":0,"pointId":"String","expectedArrivalTime":"0001-01-01T00:00:00.0000000Z","powerLevel":0,"weekdays":["String"],"timeStart":{"hour":0,"minute":0},"timeEnd":{"hour":0,"minute":0},"zoneId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}