ConsumerApi

<back to all web services

UserStatusRequest

Consumer
The following routes are available for this service:
GET/user/status
"use strict";
/** @typedef {'EnUs'|'NbNo'} */
export var Locale;
(function (Locale) {
    Locale["EnUs"] = "EnUs"
    Locale["NbNo"] = "NbNo"
})(Locale || (Locale = {}));
export class DateOfBirth {
    /** @param {{year?:number,month?:number,dayOfMonth?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    year;
    /** @type {?number} */
    month;
    /** @type {?number} */
    dayOfMonth;
}
/** @typedef {'Male'|'Female'} */
export var Sex;
(function (Sex) {
    Sex["Male"] = "Male"
    Sex["Female"] = "Female"
})(Sex || (Sex = {}));
export class UserAddress {
    /** @param {{streetName?:string,streetNumber?:string,postalCode?:string,region?:string,countryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    streetName;
    /** @type {string} */
    streetNumber;
    /** @type {string} */
    postalCode;
    /** @type {string} */
    region;
    /** @type {string} */
    countryCode;
}
export class HomeLocation {
    /** @param {{address?:UserAddress,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UserAddress} */
    address;
    /** @type {?number} */
    latitude;
    /** @type {?number} */
    longitude;
}
/** @typedef {'Kilometer'|'Mile'} */
export var DistanceUnit;
(function (DistanceUnit) {
    DistanceUnit["Kilometer"] = "Kilometer"
    DistanceUnit["Mile"] = "Mile"
})(DistanceUnit || (DistanceUnit = {}));

JavaScript 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"}]}