Trackunit API

<back to all web services

CreateKey

The following routes are available for this service:
POST/Key
GET POST/CreateKey
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateKeyResponse:
    id: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateKey:
    name: Optional[str] = None
    serial_number: Optional[str] = None
    key_valid: Optional[str] = None
    key_expire: Optional[str] = None
    is_admin: Optional[bool] = None
    company_name: Optional[str] = None
    email: Optional[str] = None
    mobile: Optional[str] = None
    phone: Optional[str] = None
    note: Optional[str] = None
    expiration_date: Optional[datetime.datetime] = None
    employee_number: Optional[str] = None
    units: Optional[List[str]] = None
    groups: Optional[List[str]] = None

Python CreateKey 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 /Key HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
Content-Type: application/json
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: application/json
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"}}}