POST | /Key | ||
---|---|---|---|
GET POST | /CreateKey |
import Foundation
import ServiceStack
// @DataContract
public class CreateKey : Codable
{
// @DataMember
public var name:String
// @DataMember
public var serialNumber:String
// @DataMember
public var keyValid:String
// @DataMember
public var keyExpire:String
// @DataMember
public var isAdmin:Bool?
// @DataMember
public var companyName:String
// @DataMember
public var email:String
// @DataMember
public var mobile:String
// @DataMember
public var phone:String
// @DataMember
public var note:String
// @DataMember
public var expirationDate:Date?
// @DataMember
public var employeeNumber:String
// @DataMember
public var units:[String]
// @DataMember
public var groups:[String]
required public init(){}
}
// @DataContract
public class CreateKeyResponse : Codable
{
// @DataMember
public var id:String
// @DataMember
public var responseStatus:ResponseStatus
required public init(){}
}
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 /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>