Trackunit API

GetKey

The following routes are available for this service:
GET POST	/GetKey
GET POST	/GetKey/{Id}
GET	/Key
GET	/Key/{Id}

"use strict";
export class Key {
    /** @param {{id?:string,name?:string,serialNumber?:string,keyValid?:string,keyExpire?:string,isAdmin?:boolean,companyName?:string,email?:string,mobile?:string,phone?:string,note?:string,expirationDate?:string,employeeNumber?:string,units?:string[],groups?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    name;
    /** @type {string} */
    serialNumber;
    /** @type {string} */
    keyValid;
    /** @type {string} */
    keyExpire;
    /** @type {?boolean} */
    isAdmin;
    /** @type {string} */
    companyName;
    /** @type {string} */
    email;
    /** @type {string} */
    mobile;
    /** @type {string} */
    phone;
    /** @type {string} */
    note;
    /** @type {?string} */
    expirationDate;
    /** @type {string} */
    employeeNumber;
    /** @type {string[]} */
    units;
    /** @type {string[]} */
    groups;
}
export class GetKeyResponse {
    /** @param {{list?:Key[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Key[]} */
    list;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetKey {
    /** @param {{id?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
}

JavaScript GetKey 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 /GetKey HTTP/1.1 
Host: api.trackunit.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<GetKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <Key>
      <CompanyName>String</CompanyName>
      <Email>String</Email>
      <EmployeeNumber>String</EmployeeNumber>
      <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
      <Groups xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Groups>
      <Id>String</Id>
      <IsAdmin>false</IsAdmin>
      <KeyExpire>String</KeyExpire>
      <KeyValid>String</KeyValid>
      <Mobile>String</Mobile>
      <Name>String</Name>
      <Note>String</Note>
      <Phone>String</Phone>
      <SerialNumber>String</SerialNumber>
      <Units xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Units>
    </Key>
  </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>
</GetKeyResponse>