Requires the role: | manager |
GET | /persons/{Id} |
---|
import Foundation
import ServiceStack
public class GetPersonRequest : GetOperationUnTenanted<GetPersonResponse>
{
public var id:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
id = try container.decodeIfPresent(String.self, forKey: .id)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if id != nil { try container.encode(id, forKey: .id) }
}
}
public class GetOperationUnTenanted<TResponse : Codable> : IHasGetOptions, IGet, Codable
{
public var embed:String?
required public init(){}
}
public class GetPersonResponse : Codable
{
public var responseStatus:ResponseStatus?
public var person:Person?
required public init(){}
}
public class Person : IIdentifiableResource, Codable
{
public var name:UserAccountName?
public var displayName:String?
public var email:String?
public var phoneNumber:String?
public var timezone:String?
public var defaultOrganisationId:String?
public var id:String?
required public init(){}
}
public class UserAccountName : Codable
{
public var firstName:String?
public var lastName:String?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /persons/{Id} HTTP/1.1 Host: staging-api.billiecart.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"person":{"name":{"firstName":"String","lastName":"String"},"displayName":"String","email":"String","phoneNumber":"String","timezone":"String","defaultOrganisationId":"String","id":"String"}}