Trackunit API

<back to all web services

UpdateKey

The following routes are available for this service:
PUT/Key
PUT/Key/{Id}
GET POST/UpdateKey
GET POST/UpdateKey/{Id}
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 UpdateKeyResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateKey:
    id: Optional[str] = None
    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
    clear: Optional[bool] = None
    add_units: Optional[List[str]] = None
    remove_units: Optional[List[str]] = None
    add_groups: Optional[List[str]] = None
    remove_groups: Optional[List[str]] = None

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

<UpdateKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <AddGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddGroups>
  <AddUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddUnits>
  <Clear>false</Clear>
  <CompanyName>String</CompanyName>
  <Email>String</Email>
  <EmployeeNumber>String</EmployeeNumber>
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <Id>String</Id>
  <IsAdmin>false</IsAdmin>
  <KeyExpire>String</KeyExpire>
  <KeyValid>String</KeyValid>
  <Mobile>String</Mobile>
  <Name>String</Name>
  <Note>String</Note>
  <Phone>String</Phone>
  <RemoveGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemoveGroups>
  <RemoveUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemoveUnits>
  <SerialNumber>String</SerialNumber>
</UpdateKey>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <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>
</UpdateKeyResponse>