Trackunit API

GetAlarmLog

"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 AlarmRecipient {
    /** @param {{contactId?:string,sentVia?:string,phoneNumber?:string,email?:string,delivered?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    contactId;
    /** @type {string} */
    sentVia;
    /** @type {string} */
    phoneNumber;
    /** @type {string} */
    email;
    /** @type {boolean} */
    delivered;
}
export class AlarmLog {
    /** @param {{alarmId?:string,unitId?:string,triggeredAt?:string,address?:Address,location?:Location,recipients?:AlarmRecipient[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    alarmId;
    /** @type {string} */
    unitId;
    /** @type {string} */
    triggeredAt;
    /** @type {Address} */
    address;
    /** @type {Location} */
    location;
    /** @type {AlarmRecipient[]} */
    recipients;
}
export class GetAlarmLogResponse {
    /** @param {{list?:AlarmLog[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AlarmLog[]} */
    list;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetAlarmLog {
    /** @param {{unitId?:string,dateFrom?:string,dateTo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    unitId;
    /** @type {?string} */
    dateFrom;
    /** @type {?string} */
    dateTo;
}

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

<GetAlarmLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <UnitId>String</UnitId>
</GetAlarmLog>

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

<GetAlarmLogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <AlarmLog>
      <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>
      <Recipients>
        <AlarmRecipient>
          <ContactId>String</ContactId>
          <Delivered>false</Delivered>
          <Email>String</Email>
          <PhoneNumber>String</PhoneNumber>
          <SentVia>String</SentVia>
        </AlarmRecipient>
      </Recipients>
      <TriggeredAt>0001-01-01T00:00:00</TriggeredAt>
      <UnitId>String</UnitId>
    </AlarmLog>
  </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>
</GetAlarmLogResponse>

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