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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<UserCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
<AcceptTermsOfService>false</AcceptTermsOfService>
<DateOfBirth xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
<d2p1:DayOfMonth>0</d2p1:DayOfMonth>
<d2p1:Month>0</d2p1:Month>
<d2p1:Year>0</d2p1:Year>
</DateOfBirth>
<Email>String</Email>
<FirstName>String</FirstName>
<Home xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
<d2p1:Address>
<d2p1:CountryCode>String</d2p1:CountryCode>
<d2p1:PostalCode>String</d2p1:PostalCode>
<d2p1:Region>String</d2p1:Region>
<d2p1:StreetName>String</d2p1:StreetName>
<d2p1:StreetNumber>String</d2p1:StreetNumber>
</d2p1:Address>
<d2p1:Latitude>0</d2p1:Latitude>
<d2p1:Longitude>0</d2p1:Longitude>
</Home>
<LastName>String</LastName>
<Password>String</Password>
<PasswordConfirmation>String</PasswordConfirmation>
<ReferFriendToken>String</ReferFriendToken>
<Sex>Male</Sex>
<Token>String</Token>
</UserCreateRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UserCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto"> <PasswordScore>0</PasswordScore> <ReferFriendAwarded>false</ReferFriendAwarded> <SentVerificationEmailWithRequestId>String</SentVerificationEmailWithRequestId> <UserGuid>00000000-0000-0000-0000-000000000000</UserGuid> </UserCreateResponse>