ConsumerApi

ProfileGetRequest

Consumer

**Requires Authentication**
Required role:	Consumer

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


export module ConsumerApi
{
    // @ts-nocheck

    export enum Locale
    {
        EnUs = 'EnUs',
        NbNo = 'NbNo',
    }

    export class DateOfBirth
    {
        public year?: number;
        public month?: number;
        public dayOfMonth?: number;

        public constructor(init?: Partial<DateOfBirth>) { (Object as any).assign(this, init); }
    }

    export enum Sex
    {
        Male = 'Male',
        Female = 'Female',
    }

    export class UserAddress
    {
        public streetName: string;
        public streetNumber: string;
        public postalCode: string;
        public region: string;
        public countryCode: string;

        public constructor(init?: Partial<UserAddress>) { (Object as any).assign(this, init); }
    }

    export class HomeLocation
    {
        public address: UserAddress;
        public latitude?: number;
        public longitude?: number;

        public constructor(init?: Partial<HomeLocation>) { (Object as any).assign(this, init); }
    }

    export enum DistanceUnit
    {
        Kilometer = 'Kilometer',
        Mile = 'Mile',
    }

}

TypeScript 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: unstable-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>
    <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>