Trackunit API

<back to all web services

CreateKey

The following routes are available for this service:
POST/Key
GET POST/CreateKey
namespace Trackunit.API

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type CreateKeyResponse() = 
        [<DataMember>]
        member val Id:String = null with get,set

        [<DataMember>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CreateKey() = 
        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val SerialNumber:String = null with get,set

        [<DataMember>]
        member val KeyValid:String = null with get,set

        [<DataMember>]
        member val KeyExpire:String = null with get,set

        [<DataMember>]
        member val IsAdmin:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val CompanyName:String = null with get,set

        [<DataMember>]
        member val Email:String = null with get,set

        [<DataMember>]
        member val Mobile:String = null with get,set

        [<DataMember>]
        member val Phone:String = null with get,set

        [<DataMember>]
        member val Note:String = null with get,set

        [<DataMember>]
        member val ExpirationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val EmployeeNumber:String = null with get,set

        [<DataMember>]
        member val Units:String[] = null with get,set

        [<DataMember>]
        member val Groups:String[] = null with get,set

F# 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>