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

export class Scope
{
    /** @description Scope Code - combination of BU / Brand */
    // @ApiMember(Description="Scope Code - combination of BU / Brand", IsRequired=true)
    public scopeCode: string;

    /** @description Business Unit Code */
    // @ApiMember(Description="Business Unit Code", IsRequired=true)
    public buCode: string;

    /** @description Brand Trigram */
    // @ApiMember(Description="Brand Trigram", IsRequired=true)
    public brand: string;

    /** @description Description of the combination */
    // @ApiMember(Description="Description of the combination", IsRequired=true)
    public description: string;

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

export class PosBrand extends Scope
{
    /** @description Pos code */
    // @ApiMember(Description="Pos code", IsRequired=true)
    public posCode: string;

    /** @description Pos name */
    // @ApiMember(Description="Pos name", IsRequired=true)
    public name: string;

    /** @description Pos city */
    // @ApiMember(Description="Pos city", IsRequired=true)
    public city: string;

    /** @description Pos address */
    // @ApiMember(Description="Pos address", IsRequired=true)
    public address: string;

    /** @description Pos country */
    // @ApiMember(Description="Pos country", IsRequired=true)
    public country: string;

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

export class GetPosBrandResponse
{
    /** @description Index of the result set returnedr */
    // @ApiMember(Description="Index of the result set returnedr", IsRequired=true)
    public page: number;

    /** @description Size of the result set returned */
    // @ApiMember(Description="Size of the result set returned", IsRequired=true)
    public items: number;

    /** @description Total amount of pages / result sets */
    // @ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
    public totalPages: number;

    /** @description Total amount of results */
    // @ApiMember(Description="Total amount of results", IsRequired=true)
    public totalResults: number;

    /** @description List of Users */
    // @ApiMember(Description="List of Users", IsRequired=true)
    public elements: PosBrand[];

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

export class GetPosBrand implements IPagedRequest
{
    /** @description Brand Trigram */
    // @ApiMember(Description="Brand Trigram", IsRequired=true)
    public brand: string;

    /** @description Mnemonic Code to Check */
    // @ApiMember(Description="Mnemonic Code to Check")
    public mnemonicCode: string;

    /** @description Business Unit Code */
    // @ApiMember(Description="Business Unit Code")
    public buCode: string;

    /** @description Index of the result set returned */
    // @ApiMember(Description="Index of the result set returned", IsRequired=true)
    public page: number;

    /** @description Size of the result set returned */
    // @ApiMember(Description="Size of the result set returned", IsRequired=true)
    public items: number;

    /** @description Omit precise record count - save on performance */
    // @ApiMember(Description="Omit precise record count - save on performance")
    public noCount: boolean;

    /** @description Sorting expression */
    // @ApiMember(Description="Sorting expression")
    public sortBy: string;

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

TypeScript GetPosBrand DTOs

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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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