ConsumerApi

<back to all web services

LoginWithMobileNumberUseShortCodeRequest

Consumer
The following routes are available for this service:
POST/login/mobile/use_short_code
LoginWithMobileNumberUseShortCodeRequest Parameters:
NameParameterData TypeRequiredDescription
TokenbodystringYes
ShortCodebodystringYes
LoginWithMobileNumberUseShortCodeResponse Parameters:
NameParameterData TypeRequiredDescription
UserProfileformUserProfileDtoYes
UserProfileDto Parameters:
NameParameterData TypeRequiredDescription
LocaleformLocaleNo
UserGuidformGuidNo
FirstNameformstringNo
LastNameformstringNo
ProfilePhotoUrlformstringNo
MobilePhoneformstringYes
MobilePhoneVerifiedformboolNo
EmailformstringNo
EmailVerifiedformboolNo
HasPasswordformboolNo
DateOfBirthformDateOfBirthYes
SexformSex?No
HomeformHomeLocationYes
ShowDistancesInformDistanceUnitNo
LegalIdentityVerifiedformboolNo
ManagesPlacesInBusinessWebformboolNo
PointsTotalformlongNo
Locale Enum:
EnUs
NbNo
DateOfBirth Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
MonthformintNo
DayOfMonthformintNo
Sex Enum:
Male
Female
HomeLocation Parameters:
NameParameterData TypeRequiredDescription
AddressformUserAddressYes
LatitudeformfloatNo
LongitudeformfloatNo
UserAddress Parameters:
NameParameterData TypeRequiredDescription
StreetNameformstringYes
StreetNumberformstringYes
PostalCodeformstringYes
RegionformstringYes
CountryCodeformstringYes
DistanceUnit Enum:
Kilometer
Mile

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