Trackunit API

UpdateAlarm

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 .soap11 suffix or ?format=soap11

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: api.trackunit.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: UpdateAlarm

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

<UpdateAlarm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ADVoltageInputIndex>0</ADVoltageInputIndex>
  <ADVoltageLimits>
    <ADVoltageLowerLimit>0</ADVoltageLowerLimit>
    <ADVoltageUpperLimit>0</ADVoltageUpperLimit>
  </ADVoltageLimits>
  <AddEmailRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddEmailRecipients>
  <AddGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddGroups>
  <AddSmsRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddSmsRecipients>
  <AddSystemRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddSystemRecipients>
  <AddUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddUnits>
  <AllUnits>false</AllUnits>
  <BatteryLevel>0</BatteryLevel>
  <ClearEmailRecipients>false</ClearEmailRecipients>
  <ClearGroups>false</ClearGroups>
  <ClearSmsRecipients>false</ClearSmsRecipients>
  <ClearSystemRecipients>false</ClearSystemRecipients>
  <ClearUnits>false</ClearUnits>
  <Enabled>false</Enabled>
  <ExpectedArrivalTime>0001-01-01T00:00:00</ExpectedArrivalTime>
  <Id>String</Id>
  <InputIndex>0</InputIndex>
  <Interval>0</Interval>
  <Location>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </Location>
  <Name>String</Name>
  <PointId>String</PointId>
  <PowerLevel>0</PowerLevel>
  <Radius>0</Radius>
  <RemoveEmailRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemoveEmailRecipients>
  <RemoveGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemoveGroups>
  <RemoveSmsRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemoveSmsRecipients>
  <RemoveSystemRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemoveSystemRecipients>
  <RemoveUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemoveUnits>
  <TemperatureLimits>
    <Temperature1LowerLimit>0</Temperature1LowerLimit>
    <Temperature1UpperLimit>0</Temperature1UpperLimit>
    <Temperature2LowerLimit>0</Temperature2LowerLimit>
    <Temperature2UpperLimit>0</Temperature2UpperLimit>
  </TemperatureLimits>
  <Threshold>0</Threshold>
  <TimeEnd>
    <Hour>0</Hour>
    <Minute>0</Minute>
  </TimeEnd>
  <TimeStart>
    <Hour>0</Hour>
    <Minute>0</Minute>
  </TimeStart>
  <Weekdays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Weekdays>
  <ZoneId>String</ZoneId>
</UpdateAlarm>

</soap:Body>
</soap:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

<UpdateAlarmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</UpdateAlarmResponse>

</soap:Body>
</soap:Envelope>