Trackunit API

<back to all web services

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(){}
}

Swift CreateAlarm DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12

HTTP + SOAP12

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

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

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

<CreateAlarm 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>
  <AllUnits>false</AllUnits>
  <BatteryLevel>0</BatteryLevel>
  <EmailRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EmailRecipients>
  <Enabled>false</Enabled>
  <ExpectedArrivalTime>0001-01-01T00:00:00</ExpectedArrivalTime>
  <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Groups>
  <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>
  <SmsRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SmsRecipients>
  <SystemRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SystemRecipients>
  <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>
  <Type>String</Type>
  <Units xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Units>
  <Weekdays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Weekdays>
  <ZoneId>String</ZoneId>
</CreateAlarm>

</soap12:Body>
</soap12:Envelope>

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

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

<CreateAlarmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Id>String</Id>
  <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>
</CreateAlarmResponse>

</soap12:Body>
</soap12:Envelope>