Trackunit API

<back to all web services

CreateAlarm

"use strict";
export class CreateAlarmResponse {
    /** @param {{id?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class TemperatureAlarmLimits {
    /** @param {{temperature1LowerLimit?:number,temperature1UpperLimit?:number,temperature2LowerLimit?:number,temperature2UpperLimit?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    temperature1LowerLimit;
    /** @type {?number} */
    temperature1UpperLimit;
    /** @type {?number} */
    temperature2LowerLimit;
    /** @type {?number} */
    temperature2UpperLimit;
}
export class ADVoltageAlarmLimits {
    /** @param {{adVoltageLowerLimit?:number,adVoltageUpperLimit?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    adVoltageLowerLimit;
    /** @type {?number} */
    adVoltageUpperLimit;
}
export class Location {
    /** @param {{latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
}
export class TimeOfDay {
    /** @param {{hour?:number,minute?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    hour;
    /** @type {number} */
    minute;
}
export class CreateAlarm {
    /** @param {{name?:string,type?:string,enabled?:boolean,allUnits?:boolean,units?:string[],groups?:string[],emailRecipients?:string[],systemRecipients?:string[],smsRecipients?:string[],temperatureLimits?:TemperatureAlarmLimits,adVoltageLimits?:ADVoltageAlarmLimits,adVoltageInputIndex?:number,threshold?:number,batteryLevel?:number,location?:Location,radius?:number,inputIndex?:number,interval?:number,pointId?:string,expectedArrivalTime?:string,powerLevel?:number,weekdays?:string[],timeStart?:TimeOfDay,timeEnd?:TimeOfDay,zoneId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    name;
    /** @type {string} */
    type;
    /** @type {?boolean} */
    enabled;
    /** @type {?boolean} */
    allUnits;
    /** @type {string[]} */
    units;
    /** @type {string[]} */
    groups;
    /** @type {string[]} */
    emailRecipients;
    /** @type {string[]} */
    systemRecipients;
    /** @type {string[]} */
    smsRecipients;
    /** @type {TemperatureAlarmLimits} */
    temperatureLimits;
    /** @type {ADVoltageAlarmLimits} */
    adVoltageLimits;
    /** @type {?number} */
    adVoltageInputIndex;
    /** @type {?number} */
    threshold;
    /** @type {?number} */
    batteryLevel;
    /** @type {Location} */
    location;
    /** @type {?number} */
    radius;
    /** @type {?number} */
    inputIndex;
    /** @type {?number} */
    interval;
    /** @type {string} */
    pointId;
    /** @type {?string} */
    expectedArrivalTime;
    /** @type {?number} */
    powerLevel;
    /** @type {string[]} */
    weekdays;
    /** @type {TimeOfDay} */
    timeStart;
    /** @type {TimeOfDay} */
    timeEnd;
    /** @type {string} */
    zoneId;
}

JavaScript CreateAlarm 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: CreateAlarm

<?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>

<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>

</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>

<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>

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