GET POST | /GetKey | ||
---|---|---|---|
GET POST | /GetKey/{Id} | ||
GET | /Key | ||
GET | /Key/{Id} |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Trackunit.API
Namespace Global
Namespace Trackunit.API
<DataContract>
Public Partial Class GetKey
<DataMember>
Public Overridable Property Id As String
End Class
<DataContract>
Public Partial Class GetKeyResponse
<DataMember>
Public Overridable Property List As List(Of Key)
<DataMember>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
<DataContract>
Public Partial Class Key
<DataMember>
Public Overridable Property Id As String
<DataMember>
Public Overridable Property Name As String
<DataMember>
Public Overridable Property SerialNumber As String
<DataMember>
Public Overridable Property KeyValid As String
<DataMember>
Public Overridable Property KeyExpire As String
<DataMember>
Public Overridable Property IsAdmin As Boolean?
<DataMember>
Public Overridable Property CompanyName As String
<DataMember>
Public Overridable Property Email As String
<DataMember>
Public Overridable Property Mobile As String
<DataMember>
Public Overridable Property Phone As String
<DataMember>
Public Overridable Property Note As String
<DataMember>
Public Overridable Property ExpirationDate As Date?
<DataMember>
Public Overridable Property EmployeeNumber As String
<DataMember>
Public Overridable Property Units As String()
<DataMember>
Public Overridable Property Groups As String()
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /GetKey HTTP/1.1
Host: api.trackunit.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Id>String</Id>
</GetKey>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <List> <Key> <CompanyName>String</CompanyName> <Email>String</Email> <EmployeeNumber>String</EmployeeNumber> <ExpirationDate>0001-01-01T00:00:00</ExpirationDate> <Groups xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </Groups> <Id>String</Id> <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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </Units> </Key> </List> <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> </GetKeyResponse>