ConsumerApi

<back to all web services

UserCreateRequest

Consumer
The following routes are available for this service:
POST/signup/create_user
"use strict";
/** @typedef {'Male'|'Female'} */
export var Sex;
(function (Sex) {
    Sex["Male"] = "Male"
    Sex["Female"] = "Female"
})(Sex || (Sex = {}));
export class DateOfBirth {
    /** @param {{year?:number,month?:number,dayOfMonth?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    year;
    /** @type {?number} */
    month;
    /** @type {?number} */
    dayOfMonth;
}
export class UserAddress {
    /** @param {{streetName?:string,streetNumber?:string,postalCode?:string,region?:string,countryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    streetName;
    /** @type {string} */
    streetNumber;
    /** @type {string} */
    postalCode;
    /** @type {string} */
    region;
    /** @type {string} */
    countryCode;
}
export class HomeLocation {
    /** @param {{address?:UserAddress,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UserAddress} */
    address;
    /** @type {?number} */
    latitude;
    /** @type {?number} */
    longitude;
}

JavaScript 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
}