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 .xml suffix or ?format=xml

HTTP + 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>