Billiecart API

<back to all web services

RegisterUserRequest

The following routes are available for this service:
POST/users/register
import Foundation
import ServiceStack

public class RegisterUserRequest : PostOperationUnTenanted<RegisterUserResponse>
{
    public var firstName:String?
    public var lastName:String?
    public var email:String?
    public var password:String?
    public var timezone:String?
    public var termsAndConditionsAccepted:Bool?

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

    private enum CodingKeys : String, CodingKey {
        case firstName
        case lastName
        case email
        case password
        case timezone
        case termsAndConditionsAccepted
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        firstName = try container.decodeIfPresent(String.self, forKey: .firstName)
        lastName = try container.decodeIfPresent(String.self, forKey: .lastName)
        email = try container.decodeIfPresent(String.self, forKey: .email)
        password = try container.decodeIfPresent(String.self, forKey: .password)
        timezone = try container.decodeIfPresent(String.self, forKey: .timezone)
        termsAndConditionsAccepted = try container.decodeIfPresent(Bool.self, forKey: .termsAndConditionsAccepted)
    }

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

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

public class RegisterUserResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var userId:String?
    public var referrerUrl:String?

    required public init(){}
}


Swift RegisterUserRequest 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 /users/register HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	firstName: String,
	lastName: String,
	email: String,
	password: String,
	timezone: String,
	termsAndConditionsAccepted: False
}
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
		}
	},
	userId: String,
	referrerUrl: String
}