Trackunit API

<back to all web services

CreateAlarm

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

    // @DataMember
    public responseStatus: ResponseStatus;

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

// @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 CreateAlarm
{
    // @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<CreateAlarm>) { (Object as any).assign(this, init); }
}

TypeScript CreateAlarm DTOs

POST /Alarm HTTP/1.1 
Host: api.trackunit.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

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