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 'package:servicestack/servicestack.dart';

// @DataContract
class UpdateKeyResponse implements IConvertible
{
    // @DataMember
    ResponseStatus? responseStatus;

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

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

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

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

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

    // @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
    bool? clear;

    // @DataMember
    List<String>? addUnits;

    // @DataMember
    List<String>? removeUnits;

    // @DataMember
    List<String>? addGroups;

    // @DataMember
    List<String>? removeGroups;

    UpdateKey({this.id,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.clear,this.addUnits,this.removeUnits,this.addGroups,this.removeGroups});
    UpdateKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        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'];
        clear = json['clear'];
        addUnits = JsonConverters.fromJson(json['addUnits'],'List<String>',context!);
        removeUnits = JsonConverters.fromJson(json['removeUnits'],'List<String>',context!);
        addGroups = JsonConverters.fromJson(json['addGroups'],'List<String>',context!);
        removeGroups = JsonConverters.fromJson(json['removeGroups'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        '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,
        'clear': clear,
        'addUnits': JsonConverters.toJson(addUnits,'List<String>',context!),
        'removeUnits': JsonConverters.toJson(removeUnits,'List<String>',context!),
        'addGroups': JsonConverters.toJson(addGroups,'List<String>',context!),
        'removeGroups': JsonConverters.toJson(removeGroups,'List<String>',context!)
    };

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

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

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