| POST | /Alarm | ||
|---|---|---|---|
| GET POST | /CreateAlarm |
import Foundation
import ServiceStack
// @DataContract
public class CreateAlarm : Codable
{
// @DataMember
public var name:String
// @DataMember
public var type:String
// @DataMember
public var enabled:Bool?
// @DataMember
public var allUnits:Bool?
// @DataMember
public var units:[String]
// @DataMember
public var groups:[String]
// @DataMember
public var emailRecipients:[String]
// @DataMember
public var systemRecipients:[String]
// @DataMember
public var smsRecipients:[String]
// @DataMember
public var temperatureLimits:TemperatureAlarmLimits
// @DataMember
public var adVoltageLimits:ADVoltageAlarmLimits
// @DataMember
public var adVoltageInputIndex:Int?
// @DataMember
public var threshold:Double?
// @DataMember
public var batteryLevel:Double?
// @DataMember
public var location:Location
// @DataMember
public var radius:Double?
// @DataMember
public var inputIndex:Int?
// @DataMember
public var interval:Double?
// @DataMember
public var pointId:String
// @DataMember
public var expectedArrivalTime:Date?
// @DataMember
public var powerLevel:Double?
// @DataMember
public var weekdays:[String]
// @DataMember
public var timeStart:TimeOfDay
// @DataMember
public var timeEnd:TimeOfDay
// @DataMember
public var zoneId:String
required public init(){}
}
// @DataContract
public class TemperatureAlarmLimits : Codable
{
// @DataMember
public var temperature1LowerLimit:Double?
// @DataMember
public var temperature1UpperLimit:Double?
// @DataMember
public var temperature2LowerLimit:Double?
// @DataMember
public var temperature2UpperLimit:Double?
required public init(){}
}
// @DataContract
public class ADVoltageAlarmLimits : Codable
{
// @DataMember
public var adVoltageLowerLimit:Double?
// @DataMember
public var adVoltageUpperLimit:Double?
required public init(){}
}
// @DataContract
public class Location : Codable
{
// @DataMember
public var latitude:Double
// @DataMember
public var longitude:Double
required public init(){}
}
// @DataContract
public class TimeOfDay : Codable
{
// @DataMember
public var hour:Int
// @DataMember
public var minute:Int
required public init(){}
}
// @DataContract
public class CreateAlarmResponse : Codable
{
// @DataMember
public var id:String
// @DataMember
public var responseStatus:ResponseStatus
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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"}}}