ConsumerApi

<back to all web services

UserStatusRequest

Consumer
The following routes are available for this service:
GET/user/status

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 UserStatusRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /user/status HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"status":"LoginOrSignup","suggestPwaInstallation":false,"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},"businessInvites":[{"inviteKey":"String","name":"String","invitingUserName":"String"}]}