Trackunit API

<back to all web services

GetKey

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

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

    // @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<Key>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetKeyResponse
{
    // @DataMember
    public list: Key[];

    // @DataMember
    public responseStatus: ResponseStatus;

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

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

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

TypeScript GetKey DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"id":"String"}

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

{"list":[{"id":"String","name":"String","serialNumber":"String","keyValid":"String","keyExpire":"String","isAdmin":false,"companyName":"String","email":"String","mobile":"String","phone":"String","note":"String","expirationDate":"0001-01-01T00:00:00.0000000Z","employeeNumber":"String","units":["String"],"groups":["String"]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}