Trackunit API

<back to all web services

CreateKey

The following routes are available for this service:
POST/Key
GET POST/CreateKey
import 'package:servicestack/servicestack.dart';

// @DataContract
class CreateKeyResponse implements IConvertible
{
    // @DataMember
    String? id;

    // @DataMember
    ResponseStatus? responseStatus;

    CreateKeyResponse({this.id,this.responseStatus});
    CreateKeyResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "CreateKeyResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class CreateKey implements IConvertible
{
    // @DataMember
    String? name;

    // @DataMember
    String? serialNumber;

    // @DataMember
    String? keyValid;

    // @DataMember
    String? keyExpire;

    // @DataMember
    bool? isAdmin;

    // @DataMember
    String? companyName;

    // @DataMember
    String? email;

    // @DataMember
    String? mobile;

    // @DataMember
    String? phone;

    // @DataMember
    String? note;

    // @DataMember
    DateTime? expirationDate;

    // @DataMember
    String? employeeNumber;

    // @DataMember
    List<String>? units;

    // @DataMember
    List<String>? groups;

    CreateKey({this.name,this.serialNumber,this.keyValid,this.keyExpire,this.isAdmin,this.companyName,this.email,this.mobile,this.phone,this.note,this.expirationDate,this.employeeNumber,this.units,this.groups});
    CreateKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        serialNumber = json['serialNumber'];
        keyValid = json['keyValid'];
        keyExpire = json['keyExpire'];
        isAdmin = json['isAdmin'];
        companyName = json['companyName'];
        email = json['email'];
        mobile = json['mobile'];
        phone = json['phone'];
        note = json['note'];
        expirationDate = JsonConverters.fromJson(json['expirationDate'],'DateTime',context!);
        employeeNumber = json['employeeNumber'];
        units = JsonConverters.fromJson(json['units'],'List<String>',context!);
        groups = JsonConverters.fromJson(json['groups'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'serialNumber': serialNumber,
        'keyValid': keyValid,
        'keyExpire': keyExpire,
        'isAdmin': isAdmin,
        'companyName': companyName,
        'email': email,
        'mobile': mobile,
        'phone': phone,
        'note': note,
        'expirationDate': JsonConverters.toJson(expirationDate,'DateTime',context!),
        'employeeNumber': employeeNumber,
        'units': JsonConverters.toJson(units,'List<String>',context!),
        'groups': JsonConverters.toJson(groups,'List<String>',context!)
    };

    getTypeName() => "CreateKey";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.trackunit.com', types: <String, TypeInfo> {
    'CreateKeyResponse': TypeInfo(TypeOf.Class, create:() => CreateKeyResponse()),
    'CreateKey': TypeInfo(TypeOf.Class, create:() => CreateKey()),
});

Dart 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>