ConsumerApi

<back to all web services

LoginWithMobileNumberUseShortCodeRequest

Consumer
The following routes are available for this service:
POST/login/mobile/use_short_code
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum

# module ConsumerApi


class Locale(str, Enum):
    EN_US = 'EnUs'
    NB_NO = 'NbNo'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DateOfBirth:
    year: int = 0
    month: int = 0
    day_of_month: int = 0


class Sex(str, Enum):
    MALE = 'Male'
    FEMALE = 'Female'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserAddress:
    street_name: Optional[str] = None
    street_number: Optional[str] = None
    postal_code: Optional[str] = None
    region: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HomeLocation:
    address: Optional[UserAddress] = None
    latitude: float = 0.0
    longitude: float = 0.0


class DistanceUnit(str, Enum):
    KILOMETER = 'Kilometer'
    MILE = 'Mile'


Python LoginWithMobileNumberUseShortCodeRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /login/mobile/use_short_code HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"token":"String","shortCode":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"userProfile":{"locale":"EnUs","firstName":"String","lastName":"String","profilePhotoUrl":"String","mobilePhone":"String","mobilePhoneVerified":false,"email":"String","emailVerified":false,"hasPassword":false,"dateOfBirth":{"year":0,"month":0,"dayOfMonth":0},"sex":"Male","home":{"address":{"streetName":"String","streetNumber":"String","postalCode":"String","region":"String","countryCode":"String"},"latitude":0,"longitude":0},"showDistancesIn":"Kilometer","legalIdentityVerified":false,"managesPlacesInBusinessWeb":false,"pointsTotal":0}}