ConsumerApi

<back to all web services

LoginWithMobileNumberUseShortCodeRequest

Consumer
The following routes are available for this service:
POST/login/mobile/use_short_code
namespace ConsumerApi

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type Locale =
        | EnUs = 0
        | NbNo = 1

    [<AllowNullLiteral>]
    type DateOfBirth() = 
        member val Year:Int32 = new Int32() with get,set
        member val Month:Int32 = new Int32() with get,set
        member val DayOfMonth:Int32 = new Int32() with get,set

    type Sex =
        | Male = 0
        | Female = 1

    [<AllowNullLiteral>]
    type UserAddress() = 
        member val StreetName:String = null with get,set
        member val StreetNumber:String = null with get,set
        member val PostalCode:String = null with get,set
        member val Region:String = null with get,set
        member val CountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type HomeLocation() = 
        member val Address:UserAddress = null with get,set
        member val Latitude:Single = new Single() with get,set
        member val Longitude:Single = new Single() with get,set

    type DistanceUnit =
        | Kilometer = 0
        | Mile = 1

F# LoginWithMobileNumberUseShortCodeRequest DTOs

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 /login/mobile/use_short_code HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	token: String,
	shortCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}