Trackunit API

UpdateAlarm

The following routes are available for this service:
PUT	/Alarm
PUT	/Alarm/{Id}
GET POST	/UpdateAlarm
GET POST	/UpdateAlarm/{Id}

import Foundation
import ServiceStack

// @DataContract
public class UpdateAlarm : Codable
{
    // @DataMember
    public var id:String

    // @DataMember
    public var name:String

    // @DataMember
    public var enabled:Bool?

    // @DataMember
    public var allUnits:Bool?

    // @DataMember
    public var clearUnits:Bool?

    // @DataMember
    public var addUnits:[String]

    // @DataMember
    public var removeUnits:[String]

    // @DataMember
    public var clearGroups:Bool?

    // @DataMember
    public var addGroups:[String]

    // @DataMember
    public var removeGroups:[String]

    // @DataMember
    public var clearEmailRecipients:Bool?

    // @DataMember
    public var addEmailRecipients:[String]

    // @DataMember
    public var removeEmailRecipients:[String]

    // @DataMember
    public var clearSystemRecipients:Bool?

    // @DataMember
    public var addSystemRecipients:[String]

    // @DataMember
    public var removeSystemRecipients:[String]

    // @DataMember
    public var clearSmsRecipients:Bool?

    // @DataMember
    public var addSmsRecipients:[String]

    // @DataMember
    public var removeSmsRecipients:[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 UpdateAlarmResponse : Codable
{
    // @DataMember
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift UpdateAlarm DTOs

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 /UpdateAlarm HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
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"}}}