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 .xml suffix or ?format=xml

HTTP + XML

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

<GetPosBrandResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Security.ServiceModel">
  <elements i:nil="true" />
  <items>0</items>
  <page>0</page>
  <totalPages>0</totalPages>
  <totalResults>0</totalResults>
</GetPosBrandResponse>