ConsumerApi

<back to all web services

UserCreateRequest

Consumer
The following routes are available for this service:
POST/signup/create_user
UserCreateRequest Parameters:
NameParameterData TypeRequiredDescription
TokenbodystringYes
FirstNamebodystringYes
LastNamebodystringYes
SexbodySexNo
DateOfBirthbodyDateOfBirthYes
EmailbodystringYes
PasswordbodystringYes
PasswordConfirmationbodystringYes
HomebodyHomeLocationYes
AcceptTermsOfServicebodyboolNo
ReferFriendTokenbodystringNo
Sex Enum:
Male
Female
DateOfBirth Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
MonthformintNo
DayOfMonthformintNo
HomeLocation Parameters:
NameParameterData TypeRequiredDescription
AddressformUserAddressYes
LatitudeformfloatNo
LongitudeformfloatNo
UserAddress Parameters:
NameParameterData TypeRequiredDescription
StreetNameformstringYes
StreetNumberformstringYes
PostalCodeformstringYes
RegionformstringYes
CountryCodeformstringYes
UserCreateResponse Parameters:
NameParameterData TypeRequiredDescription
SentVerificationEmailWithRequestIdformstringYes
PasswordScoreformint?No
UserGuidformGuid?No
ReferFriendAwardedformboolNo

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