ConsumerApi

<back to all web services

ProfileUpdateHomeLocationRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
PUT/profile/update-home
"use strict";
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;
}

JavaScript ProfileUpdateHomeLocationRequest 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.

PUT /profile/update-home HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"home":{"address":{"streetName":"String","streetNumber":"String","postalCode":"String","region":"String","countryCode":"String"},"latitude":0,"longitude":0}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"homeLocation":{"address":{"streetName":"String","streetNumber":"String","postalCode":"String","region":"String","countryCode":"String"},"latitude":0,"longitude":0}}