| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Clients/{Id} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Clients |
import Foundation
import ServiceStack
public class Clients : ClientObject
{
public var apiKey:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case apiKey
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
apiKey = try container.decodeIfPresent(String.self, forKey: .apiKey)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if apiKey != nil { try container.encode(apiKey, forKey: .apiKey) }
}
}
public class ClientObject : Codable
{
public var id:String
public var name:String
public var address1:String
public var address2:String
public var city:String
public var state:String
public var zip:String
public var subscriptionId:String
public var active:Bool
public var entDate:Date
public var modDate:Date
required public init(){}
}
public class ClientsResponse : Codable
{
public var responseStatus:ResponseStatus
public var clients:[ClientObject] = []
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Clients/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: 00000000000000000000000000000000,
Id: 00000000000000000000000000000000,
Name: String,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
SubscriptionId: 00000000000000000000000000000000,
Active: False,
EntDate: 0001-01-01,
ModDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Clients:
[
{
Id: 00000000000000000000000000000000,
Name: String,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
SubscriptionId: 00000000000000000000000000000000,
Active: False,
EntDate: 0001-01-01,
ModDate: 0001-01-01
}
]
}