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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetPosBrand implements IPagedRequest
    {
        /**
        * Brand Trigram
        */
        @ApiMember(Description="Brand Trigram", IsRequired=true)
        public String brand = null;

        /**
        * Mnemonic Code to Check
        */
        @ApiMember(Description="Mnemonic Code to Check")
        public String mnemonicCode = null;

        /**
        * Business Unit Code
        */
        @ApiMember(Description="Business Unit Code")
        public String buCode = null;

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

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

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

        /**
        * Sorting expression
        */
        @ApiMember(Description="Sorting expression")
        public String sortBy = null;
        
        public String getBrand() { return brand; }
        public GetPosBrand setBrand(String value) { this.brand = value; return this; }
        public String getMnemonicCode() { return mnemonicCode; }
        public GetPosBrand setMnemonicCode(String value) { this.mnemonicCode = value; return this; }
        public String getBuCode() { return buCode; }
        public GetPosBrand setBuCode(String value) { this.buCode = value; return this; }
        public Integer getPage() { return page; }
        public GetPosBrand setPage(Integer value) { this.page = value; return this; }
        public Integer getItems() { return items; }
        public GetPosBrand setItems(Integer value) { this.items = value; return this; }
        public Boolean isNoCount() { return noCount; }
        public GetPosBrand setNoCount(Boolean value) { this.noCount = value; return this; }
        public String getSortBy() { return sortBy; }
        public GetPosBrand setSortBy(String value) { this.sortBy = value; return this; }
    }

    public static class GetPosBrandResponse
    {
        /**
        * Index of the result set returnedr
        */
        @ApiMember(Description="Index of the result set returnedr", IsRequired=true)
        public Integer page = null;

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

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

        /**
        * Total amount of results
        */
        @ApiMember(Description="Total amount of results", IsRequired=true)
        public Integer totalResults = null;

        /**
        * List of Users
        */
        @ApiMember(Description="List of Users", IsRequired=true)
        public ArrayList<PosBrand> elements = null;
        
        public Integer getPage() { return page; }
        public GetPosBrandResponse setPage(Integer value) { this.page = value; return this; }
        public Integer getItems() { return items; }
        public GetPosBrandResponse setItems(Integer value) { this.items = value; return this; }
        public Integer getTotalPages() { return totalPages; }
        public GetPosBrandResponse setTotalPages(Integer value) { this.totalPages = value; return this; }
        public Integer getTotalResults() { return totalResults; }
        public GetPosBrandResponse setTotalResults(Integer value) { this.totalResults = value; return this; }
        public ArrayList<PosBrand> getElements() { return elements; }
        public GetPosBrandResponse setElements(ArrayList<PosBrand> value) { this.elements = value; return this; }
    }

    public static class PosBrand extends Scope
    {
        /**
        * Pos code
        */
        @ApiMember(Description="Pos code", IsRequired=true)
        public String posCode = null;

        /**
        * Pos name
        */
        @ApiMember(Description="Pos name", IsRequired=true)
        public String name = null;

        /**
        * Pos city
        */
        @ApiMember(Description="Pos city", IsRequired=true)
        public String city = null;

        /**
        * Pos address
        */
        @ApiMember(Description="Pos address", IsRequired=true)
        public String address = null;

        /**
        * Pos country
        */
        @ApiMember(Description="Pos country", IsRequired=true)
        public String country = null;
        
        public String getPosCode() { return posCode; }
        public PosBrand setPosCode(String value) { this.posCode = value; return this; }
        public String getName() { return name; }
        public PosBrand setName(String value) { this.name = value; return this; }
        public String getCity() { return city; }
        public PosBrand setCity(String value) { this.city = value; return this; }
        public String getAddress() { return address; }
        public PosBrand setAddress(String value) { this.address = value; return this; }
        public String getCountry() { return country; }
        public PosBrand setCountry(String value) { this.country = value; return this; }
    }

    public static class Scope
    {
        /**
        * Scope Code - combination of BU / Brand
        */
        @ApiMember(Description="Scope Code - combination of BU / Brand", IsRequired=true)
        public String scopeCode = null;

        /**
        * Business Unit Code
        */
        @ApiMember(Description="Business Unit Code", IsRequired=true)
        public String buCode = null;

        /**
        * Brand Trigram
        */
        @ApiMember(Description="Brand Trigram", IsRequired=true)
        public String brand = null;

        /**
        * Description of the combination
        */
        @ApiMember(Description="Description of the combination", IsRequired=true)
        public String description = null;
        
        public String getScopeCode() { return scopeCode; }
        public Scope setScopeCode(String value) { this.scopeCode = value; return this; }
        public String getBuCode() { return buCode; }
        public Scope setBuCode(String value) { this.buCode = value; return this; }
        public String getBrand() { return brand; }
        public Scope setBrand(String value) { this.brand = value; return this; }
        public String getDescription() { return description; }
        public Scope setDescription(String value) { this.description = value; return this; }
    }

}

Java GetPosBrand DTOs

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>