Requires the role: | manager |
POST | /customers |
---|
import Foundation
import ServiceStack
public class CreateCustomerRequest : PostOperationTenanted<CreateCustomerResponse>
{
public var email:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case email
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
email = try container.decodeIfPresent(String.self, forKey: .email)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if email != nil { try container.encode(email, forKey: .email) }
}
}
public class PostOperationTenanted<TResponse : Codable> : PostOperationUnTenanted<TResponse>, ITenantedRequest
{
public var organisationId:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case organisationId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
}
}
public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
required public init(){}
}
public class CreateCustomerResponse : Codable
{
public var responseStatus:ResponseStatus?
public var customer:Customer?
required public init(){}
}
public class Customer : IIdentifiableResource, Codable
{
public var id:String?
public var firstName:String?
public var lastName:String?
public var dateOfBirth:Date?
public var driversLicenceNo:String?
public var email:String?
public var phone:String?
public var preferredContactMethod:String?
public var addressLine1:String?
public var addressLine2:String?
public var suburb:String?
public var stateTerritory:String?
public var postcode:String?
public var bankAccount:BankAccount?
public var userAccountId:String?
required public init(){}
}
public class BankAccount : Codable
{
public var bsbNumber:String?
public var accountNumber:String?
required public init(){}
}
Swift CreateCustomerRequest DTOs
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 /customers HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
email: String,
organisationId: String
}
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 } }, customer: { id: String, firstName: String, lastName: String, driversLicenceNo: String, email: String, phone: String, preferredContactMethod: String, addressLine1: String, addressLine2: String, suburb: String, stateTerritory: String, postcode: String, bankAccount: { bsbNumber: String, accountNumber: String }, userAccountId: String } }