ConsumerApi

<back to all web services

UserCreateRequest

Consumer
The following routes are available for this service:
POST/signup/create_user

export module ConsumerApi
{
    // @ts-nocheck

    export enum Sex
    {
        Male = 'Male',
        Female = 'Female',
    }

    export class DateOfBirth
    {
        public year?: number;
        public month?: number;
        public dayOfMonth?: number;

        public constructor(init?: Partial<DateOfBirth>) { (Object as any).assign(this, init); }
    }

    export class UserAddress
    {
        public streetName: string;
        public streetNumber: string;
        public postalCode: string;
        public region: string;
        public countryCode: string;

        public constructor(init?: Partial<UserAddress>) { (Object as any).assign(this, init); }
    }

    export class HomeLocation
    {
        public address: UserAddress;
        public latitude?: number;
        public longitude?: number;

        public constructor(init?: Partial<HomeLocation>) { (Object as any).assign(this, init); }
    }

}

TypeScript UserCreateRequest 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 /signup/create_user HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	token: String,
	firstName: String,
	lastName: String,
	sex: Male,
	dateOfBirth: 
	{
		year: 0,
		month: 0,
		dayOfMonth: 0
	},
	email: String,
	password: String,
	passwordConfirmation: String,
	home: 
	{
		address: 
		{
			streetName: String,
			streetNumber: String,
			postalCode: String,
			region: String,
			countryCode: String
		},
		latitude: 0,
		longitude: 0
	},
	acceptTermsOfService: False,
	referFriendToken: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	sentVerificationEmailWithRequestId: String,
	passwordScore: 0,
	userGuid: 00000000-0000-0000-0000-000000000000,
	referFriendAwarded: False
}