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
GetPosBrand Parameters:
NameParameterData TypeRequiredDescription
brandquerystringYesBrand Trigram
mnemonicCodequerystringNoMnemonic Code to Check
buCodequerystringNoBusiness Unit Code
pagequeryintYesIndex of the result set returned
itemsqueryintYesSize of the result set returned
noCountqueryboolNoOmit precise record count - save on performance
sortByquerystringNoSorting expression
GetPosBrandResponse Parameters:
NameParameterData TypeRequiredDescription
pageformintYesIndex of the result set returnedr
itemsformintYesSize of the result set returned
totalPagesformintYesTotal amount of pages / result sets
totalResultsformintYesTotal amount of results
elementsformIEnumerable<PosBrand>YesList of Users
PosBrand Parameters:
NameParameterData TypeRequiredDescription
posCodeformstringYesPos code
nameformstringYesPos name
cityformstringYesPos city
addressformstringYesPos address
countryformstringYesPos country
Scope Parameters:
NameParameterData TypeRequiredDescription
scopeCodeformstringYesScope Code - combination of BU / Brand
buCodeformstringYesBusiness Unit Code
brandformstringYesBrand Trigram
descriptionformstringYesDescription of the combination

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

HTTP + JSV

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

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