Trackunit API

<back to all web services

GetAlarm

The following routes are available for this service:
GET POST/GetAlarm
GET POST/GetAlarm/{Id}
GET/Alarm
GET/Alarm/{Id}
GetAlarm Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GetAlarmResponse Parameters:
NameParameterData TypeRequiredDescription
ListformList<Alarm>No
ResponseStatusformResponseStatusNo
Alarm Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CreatedformDateTime?No
NameformstringNo
TypeformstringNo
Enabledformbool?No
AllUnitsformbool?No
Unitsformstring[]No
Groupsformstring[]No
EmailRecipientsformstring[]No
SystemRecipientsformstring[]No
SmsRecipientsformstring[]No
TemperatureLimitsformTemperatureAlarmLimitsNo
ADVoltageLimitsformADVoltageAlarmLimitsNo
ADVoltageInputIndexformint?No
Thresholdformdouble?No
BatteryLevelformdouble?No
LocationformLocationNo
Radiusformdouble?No
InputIndexformint?No
Intervalformdouble?No
PointIdformstringNo
ExpectedArrivalTimeformDateTime?No
PowerLevelformdouble?No
Weekdaysformstring[]No
TimeStartformTimeOfDayNo
TimeEndformTimeOfDayNo
ZoneIdformstringNo
TemperatureAlarmLimits Parameters:
NameParameterData TypeRequiredDescription
Temperature1LowerLimitformdouble?No
Temperature1UpperLimitformdouble?No
Temperature2LowerLimitformdouble?No
Temperature2UpperLimitformdouble?No
ADVoltageAlarmLimits Parameters:
NameParameterData TypeRequiredDescription
ADVoltageLowerLimitformdouble?No
ADVoltageUpperLimitformdouble?No
Location Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo
TimeOfDay Parameters:
NameParameterData TypeRequiredDescription
HourformintNo
MinuteformintNo

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GetAlarm HTTP/1.1 
Host: api.trackunit.com 
Content-Type: application/json
Content-Length: length

{"id":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"list":[{"id":"String","created":"0001-01-01T00:00:00.0000000Z","name":"String","type":"String","enabled":false,"allUnits":false,"units":["String"],"groups":["String"],"emailRecipients":["String"],"systemRecipients":["String"],"smsRecipients":["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"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}