Billiecart API

CreatePersonRequest

The following routes are available for this service:
POST	/persons

import Foundation
import ServiceStack

public class CreatePersonRequest : PostOperationUnTenanted<CreatePersonResponse>
{
    public var userAccountId:String?
    public var timezone:String?
    public var phoneNumber:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case userAccountId
        case timezone
        case phoneNumber
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        userAccountId = try container.decodeIfPresent(String.self, forKey: .userAccountId)
        timezone = try container.decodeIfPresent(String.self, forKey: .timezone)
        phoneNumber = try container.decodeIfPresent(String.self, forKey: .phoneNumber)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if userAccountId != nil { try container.encode(userAccountId, forKey: .userAccountId) }
        if timezone != nil { try container.encode(timezone, forKey: .timezone) }
        if phoneNumber != nil { try container.encode(phoneNumber, forKey: .phoneNumber) }
    }
}

public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class CreatePersonResponse : 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(){}
}

Swift CreatePersonRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /persons HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	userAccountId: String,
	timezone: String,
	phoneNumber: 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
		}
	},
	person: 
	{
		name: 
		{
			firstName: String,
			lastName: String
		},
		displayName: String,
		email: String,
		phoneNumber: String,
		timezone: String,
		defaultOrganisationId: String,
		id: String
	}
}