Trackunit API

CreateAlarm

The following routes are available for this service:
POST	/Alarm
GET POST	/CreateAlarm

**CreateAlarm** Parameters:
Name	Parameter	Data Type	Required
Name	body	string	No
Type	body	string	No
Enabled	body	bool?	No
AllUnits	body	bool?	No
Units	body	string[]	No
Groups	body	string[]	No
EmailRecipients	body	string[]	No
SystemRecipients	body	string[]	No
SmsRecipients	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

**TemperatureAlarmLimits** Parameters:
Name	Parameter	Data Type	Required
Temperature1LowerLimit	form	double?	No
Temperature1UpperLimit	form	double?	No
Temperature2LowerLimit	form	double?	No
Temperature2UpperLimit	form	double?	No

**ADVoltageAlarmLimits** Parameters:
Name	Parameter	Data Type	Required	Description
ADVoltageLowerLimit	form	double?	No
ADVoltageUpperLimit	form	double?	No

**Location** Parameters:
Name	Parameter	Data Type	Required	Description
Latitude	form	double	No
Longitude	form	double	No

**TimeOfDay** Parameters:
Name	Parameter	Data Type	Required	Description
Hour	form	int	No
Minute	form	int	No

**CreateAlarmResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
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

HTTP + JSON

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

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

{"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"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}