Trackunit API

CreateKey

The following routes are available for this service:
POST	/Key
GET POST	/CreateKey


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

    // @DataMember
    public responseStatus: ResponseStatus;

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

// @DataContract
export class CreateKey
{
    // @DataMember
    public name: string;

    // @DataMember
    public serialNumber: string;

    // @DataMember
    public keyValid: string;

    // @DataMember
    public keyExpire: string;

    // @DataMember
    public isAdmin?: boolean;

    // @DataMember
    public companyName: string;

    // @DataMember
    public email: string;

    // @DataMember
    public mobile: string;

    // @DataMember
    public phone: string;

    // @DataMember
    public note: string;

    // @DataMember
    public expirationDate?: string;

    // @DataMember
    public employeeNumber: string;

    // @DataMember
    public units: string[];

    // @DataMember
    public groups: string[];

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

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

<CreateKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <CompanyName>String</CompanyName>
  <Email>String</Email>
  <EmployeeNumber>String</EmployeeNumber>
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Groups>
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Units>
</CreateKey>

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

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