Trackunit API

<back to all web services

CreateAlarm

The following routes are available for this service:
POST/Alarm
GET POST/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

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

HTTP + OTHER

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

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

{"name":"String","type":"String","enabled":false,"allUnits":false,"units":["String"],"groups":["String"],"emailRecipients":["String"],"systemRecipients":["String"],"smsRecipients":["String"],"temperatureLimits":{"temperature1LowerLimit":0,"temperature1UpperLimit":0,"temperature2LowerLimit":0,"temperature2UpperLimit":0},"adVoltageLimits":{"adVoltageLowerLimit":0,"adVoltageUpperLimit":0},"adVoltageInputIndex":0,"threshold":0,"batteryLevel":0,"location":{"latitude":0,"longitude":0},"radius":0,"inputIndex":0,"interval":0,"pointId":"String","expectedArrivalTime":"0001-01-01T00:00:00.0000000Z","powerLevel":0,"weekdays":["String"],"timeStart":{"hour":0,"minute":0},"timeEnd":{"hour":0,"minute":0},"zoneId":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"id":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}