Trackunit API

GetAlarm


// @DataContract
export class TemperatureAlarmLimits
{
    // @DataMember
    public temperature1LowerLimit?: number;

    // @DataMember
    public temperature1UpperLimit?: number;

    // @DataMember
    public temperature2LowerLimit?: number;

    // @DataMember
    public temperature2UpperLimit?: number;

    public constructor(init?: Partial<TemperatureAlarmLimits>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ADVoltageAlarmLimits
{
    // @DataMember
    public adVoltageLowerLimit?: number;

    // @DataMember
    public adVoltageUpperLimit?: number;

    public constructor(init?: Partial<ADVoltageAlarmLimits>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Location
{
    // @DataMember
    public latitude: number;

    // @DataMember
    public longitude: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

// @DataContract
export class TimeOfDay
{
    // @DataMember
    public hour: number;

    // @DataMember
    public minute: number;

    public constructor(init?: Partial<TimeOfDay>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Alarm
{
    // @DataMember
    public id: string;

    // @DataMember
    public created?: string;

    // @DataMember
    public name: string;

    // @DataMember
    public type: string;

    // @DataMember
    public enabled?: boolean;

    // @DataMember
    public allUnits?: boolean;

    // @DataMember
    public units: string[];

    // @DataMember
    public groups: string[];

    // @DataMember
    public emailRecipients: string[];

    // @DataMember
    public systemRecipients: string[];

    // @DataMember
    public smsRecipients: string[];

    // @DataMember
    public temperatureLimits: TemperatureAlarmLimits;

    // @DataMember
    public adVoltageLimits: ADVoltageAlarmLimits;

    // @DataMember
    public adVoltageInputIndex?: number;

    // @DataMember
    public threshold?: number;

    // @DataMember
    public batteryLevel?: number;

    // @DataMember
    public location: Location;

    // @DataMember
    public radius?: number;

    // @DataMember
    public inputIndex?: number;

    // @DataMember
    public interval?: number;

    // @DataMember
    public pointId: string;

    // @DataMember
    public expectedArrivalTime?: string;

    // @DataMember
    public powerLevel?: number;

    // @DataMember
    public weekdays: string[];

    // @DataMember
    public timeStart: TimeOfDay;

    // @DataMember
    public timeEnd: TimeOfDay;

    // @DataMember
    public zoneId: string;

    public constructor(init?: Partial<Alarm>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAlarmResponse
{
    // @DataMember
    public list: Alarm[];

    // @DataMember
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetAlarmResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAlarm
{
    // @DataMember
    public id: string;

    public constructor(init?: Partial<GetAlarm>) { (Object as any).assign(this, init); }
}

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

<GetAlarm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Id>String</Id>
</GetAlarm>

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

<GetAlarmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <Alarm>
      <ADVoltageInputIndex>0</ADVoltageInputIndex>
      <ADVoltageLimits>
        <ADVoltageLowerLimit>0</ADVoltageLowerLimit>
        <ADVoltageUpperLimit>0</ADVoltageUpperLimit>
      </ADVoltageLimits>
      <AllUnits>false</AllUnits>
      <BatteryLevel>0</BatteryLevel>
      <Created>0001-01-01T00:00:00</Created>
      <EmailRecipients xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </EmailRecipients>
      <Enabled>false</Enabled>
      <ExpectedArrivalTime>0001-01-01T00:00:00</ExpectedArrivalTime>
      <Groups xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Groups>
      <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>
      <SmsRecipients xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </SmsRecipients>
      <SystemRecipients xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Units>
      <Weekdays xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Weekdays>
      <ZoneId>String</ZoneId>
    </Alarm>
  </List>
  <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>
</GetAlarmResponse>

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