ConsumerApi

<back to all web services

LoginWithMobileNumberUseShortCodeRequest

<?php namespace ConsumerApi;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum Locale : string
{
    case EnUs = 'EnUs';
    case NbNo = 'NbNo';
}

class DateOfBirth implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $year=0,
        /** @var int */
        public int $month=0,
        /** @var int */
        public int $dayOfMonth=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['year'])) $this->year = $o['year'];
        if (isset($o['month'])) $this->month = $o['month'];
        if (isset($o['dayOfMonth'])) $this->dayOfMonth = $o['dayOfMonth'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->year)) $o['year'] = $this->year;
        if (isset($this->month)) $o['month'] = $this->month;
        if (isset($this->dayOfMonth)) $o['dayOfMonth'] = $this->dayOfMonth;
        return empty($o) ? new class(){} : $o;
    }
}

enum Sex : string
{
    case Male = 'Male';
    case Female = 'Female';
}

class UserAddress implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $streetName='',
        /** @var string */
        public string $streetNumber='',
        /** @var string */
        public string $postalCode='',
        /** @var string */
        public string $region='',
        /** @var string */
        public string $countryCode=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['streetName'])) $this->streetName = $o['streetName'];
        if (isset($o['streetNumber'])) $this->streetNumber = $o['streetNumber'];
        if (isset($o['postalCode'])) $this->postalCode = $o['postalCode'];
        if (isset($o['region'])) $this->region = $o['region'];
        if (isset($o['countryCode'])) $this->countryCode = $o['countryCode'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->streetName)) $o['streetName'] = $this->streetName;
        if (isset($this->streetNumber)) $o['streetNumber'] = $this->streetNumber;
        if (isset($this->postalCode)) $o['postalCode'] = $this->postalCode;
        if (isset($this->region)) $o['region'] = $this->region;
        if (isset($this->countryCode)) $o['countryCode'] = $this->countryCode;
        return empty($o) ? new class(){} : $o;
    }
}

class HomeLocation implements JsonSerializable
{
    public function __construct(
        /** @var UserAddress|null */
        public ?UserAddress $address=null,
        /** @var float */
        public float $latitude=0.0,
        /** @var float */
        public float $longitude=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['address'])) $this->address = JsonConverters::from('UserAddress', $o['address']);
        if (isset($o['latitude'])) $this->latitude = $o['latitude'];
        if (isset($o['longitude'])) $this->longitude = $o['longitude'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->address)) $o['address'] = JsonConverters::to('UserAddress', $this->address);
        if (isset($this->latitude)) $o['latitude'] = $this->latitude;
        if (isset($this->longitude)) $o['longitude'] = $this->longitude;
        return empty($o) ? new class(){} : $o;
    }
}

enum DistanceUnit : string
{
    case Kilometer = 'Kilometer';
    case Mile = 'Mile';
}

PHP LoginWithMobileNumberUseShortCodeRequest DTOs

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>