Trackunit API

<back to all web services

GetActiveAlarm

The following routes are available for this service:
GET/activeAlarm
GET POST/GetActiveAlarm
"use strict";
export class Address {
    /** @param {{country?:string,zipCode?:string,city?:string,streetAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    country;
    /** @type {string} */
    zipCode;
    /** @type {string} */
    city;
    /** @type {string} */
    streetAddress;
}
export class Location {
    /** @param {{latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
}
export class ActiveAlarm {
    /** @param {{alarmId?:string,unitId?:string,triggeredAt?:string,address?:Address,location?:Location}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    alarmId;
    /** @type {string} */
    unitId;
    /** @type {?string} */
    triggeredAt;
    /** @type {Address} */
    address;
    /** @type {Location} */
    location;
}
export class GetActiveAlarmResponse {
    /** @param {{list?:ActiveAlarm[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ActiveAlarm[]} */
    list;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetActiveAlarm {
    constructor(init) { Object.assign(this, init) }
}

JavaScript GetActiveAlarm DTOs

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

HTTP + XML

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

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

<GetActiveAlarm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetActiveAlarmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <ActiveAlarm>
      <Address>
        <City>String</City>
        <Country>String</Country>
        <StreetAddress>String</StreetAddress>
        <ZipCode>String</ZipCode>
      </Address>
      <AlarmId>String</AlarmId>
      <Location>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </Location>
      <TriggeredAt>0001-01-01T00:00:00</TriggeredAt>
      <UnitId>String</UnitId>
    </ActiveAlarm>
  </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>
</GetActiveAlarmResponse>