ConsumerApi

<back to all web services

LoginWithMobileNumberUseShortCodeRequest

Consumer
The following routes are available for this service:
POST/login/mobile/use_short_code
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


enum class Locale
{
    EnUs,
    NbNo,
}

open class DateOfBirth
{
    open var year:Int? = null
    open var month:Int? = null
    open var dayOfMonth:Int? = null
}

enum class Sex
{
    Male,
    Female,
}

open class HomeLocation
{
    open var address:UserAddress? = null
    open var latitude:Float? = null
    open var longitude:Float? = null
}

open class UserAddress
{
    open var streetName:String? = null
    open var streetNumber:String? = null
    open var postalCode:String? = null
    open var region:String? = null
    open var countryCode:String? = null
}

enum class DistanceUnit
{
    Kilometer,
    Mile,
}

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

<LoginWithMobileNumberUseShortCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <ShortCode>String</ShortCode>
  <Token>String</Token>
</LoginWithMobileNumberUseShortCodeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LoginWithMobileNumberUseShortCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <UserProfile>
    <DateOfBirth xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:DayOfMonth>0</d3p1:DayOfMonth>
      <d3p1:Month>0</d3p1:Month>
      <d3p1:Year>0</d3p1:Year>
    </DateOfBirth>
    <Email>String</Email>
    <EmailVerified>false</EmailVerified>
    <FirstName>String</FirstName>
    <HasPassword>false</HasPassword>
    <Home xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Address>
        <d3p1:CountryCode>String</d3p1:CountryCode>
        <d3p1:PostalCode>String</d3p1:PostalCode>
        <d3p1:Region>String</d3p1:Region>
        <d3p1:StreetName>String</d3p1:StreetName>
        <d3p1:StreetNumber>String</d3p1:StreetNumber>
      </d3p1:Address>
      <d3p1:Latitude>0</d3p1:Latitude>
      <d3p1:Longitude>0</d3p1:Longitude>
    </Home>
    <LastName>String</LastName>
    <LegalIdentityVerified>false</LegalIdentityVerified>
    <Locale>EnUs</Locale>
    <ManagesPlacesInBusinessWeb>false</ManagesPlacesInBusinessWeb>
    <MobilePhone>String</MobilePhone>
    <MobilePhoneVerified>false</MobilePhoneVerified>
    <PointsTotal>0</PointsTotal>
    <ProfilePhotoUrl>String</ProfilePhotoUrl>
    <Sex>Male</Sex>
    <ShowDistancesIn>Kilometer</ShowDistancesIn>
    <UserGuid>00000000-0000-0000-0000-000000000000</UserGuid>
  </UserProfile>
</LoginWithMobileNumberUseShortCodeResponse>