Richemont.Booster2.PublicApi

<back to all web services

GetPosBrand

Requires Authentication
The following routes are available for this service:
GET/security/posGet the list of pos groups where user is authorized
"use strict";
export class Scope {
    /** @param {{scopeCode?:string,buCode?:string,brand?:string,description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Scope Code - combination of BU / Brand */
    scopeCode;
    /**
     * @type {string}
     * @description Business Unit Code */
    buCode;
    /**
     * @type {string}
     * @description Brand Trigram */
    brand;
    /**
     * @type {string}
     * @description Description of the combination */
    description;
}
export class PosBrand extends Scope {
    /** @param {{posCode?:string,name?:string,city?:string,address?:string,country?:string,scopeCode?:string,buCode?:string,brand?:string,description?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Pos code */
    posCode;
    /**
     * @type {string}
     * @description Pos name */
    name;
    /**
     * @type {string}
     * @description Pos city */
    city;
    /**
     * @type {string}
     * @description Pos address */
    address;
    /**
     * @type {string}
     * @description Pos country */
    country;
}
export class GetPosBrandResponse {
    /** @param {{page?:number,items?:number,totalPages?:number,totalResults?:number,elements?:PosBrand[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Index of the result set returnedr */
    page;
    /**
     * @type {number}
     * @description Size of the result set returned */
    items;
    /**
     * @type {number}
     * @description Total amount of pages / result sets */
    totalPages;
    /**
     * @type {number}
     * @description Total amount of results */
    totalResults;
    /**
     * @type {PosBrand[]}
     * @description List of Users */
    elements;
}
export class GetPosBrand {
    /** @param {{brand?:string,mnemonicCode?:string,buCode?:string,page?:number,items?:number,noCount?:boolean,sortBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Brand Trigram */
    brand;
    /**
     * @type {string}
     * @description Mnemonic Code to Check */
    mnemonicCode;
    /**
     * @type {string}
     * @description Business Unit Code */
    buCode;
    /**
     * @type {number}
     * @description Index of the result set returned */
    page;
    /**
     * @type {number}
     * @description Size of the result set returned */
    items;
    /**
     * @type {boolean}
     * @description Omit precise record count - save on performance */
    noCount;
    /**
     * @type {string}
     * @description Sorting expression */
    sortBy;
}

JavaScript GetPosBrand 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 /security/pos HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"page":0,"items":0,"totalPages":0,"totalResults":0}