Trackunit API

<back to all web services

CreateKey

The following routes are available for this service:
POST/Key
GET POST/CreateKey
"use strict";
export class CreateKeyResponse {
    /** @param {{id?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class CreateKey {
    /** @param {{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} */
    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;
}

JavaScript CreateKey DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"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"]}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"id":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}