ConsumerApi

ProfileGetRequest

Consumer

**Requires Authentication**
Required role:	Consumer

The following routes are available for this service:
GET	/profile

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 ProfileGetRequest 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.

GET /profile HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProfileGetResponse 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>
    <HasAccessToBackofficeWeb>false</HasAccessToBackofficeWeb>
    <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>
</ProfileGetResponse>