Richemont.Booster2.PublicApi

<back to all web services

GetPurchasablePos

Requires Authentication
The following routes are available for this service:
GET/purchase/posGet a list of authorized pos that can place orders
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetPurchasablePos implements IPagedRequest
    {
        /**
        * 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;

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

        /**
        * Brand Context ID
        */
        @ApiMember(Description="Brand Context ID")
        public String boosterContextId = null;
        
        public Integer getPage() { return page; }
        public GetPurchasablePos setPage(Integer value) { this.page = value; return this; }
        public Integer getItems() { return items; }
        public GetPurchasablePos setItems(Integer value) { this.items = value; return this; }
        public Boolean isNoCount() { return noCount; }
        public GetPurchasablePos setNoCount(Boolean value) { this.noCount = value; return this; }
        public String getSortBy() { return sortBy; }
        public GetPurchasablePos setSortBy(String value) { this.sortBy = value; return this; }
        public String getBrand() { return brand; }
        public GetPurchasablePos setBrand(String value) { this.brand = value; return this; }
        public String getBoosterContextId() { return boosterContextId; }
        public GetPurchasablePos setBoosterContextId(String value) { this.boosterContextId = value; return this; }
    }

    public static class GetPurchasablePosResponse
    {
        /**
        * 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 Pos
        */
        @ApiMember(Description="List of Pos", IsRequired=true)
        public ArrayList<Pos> elements = null;
        
        public Integer getPage() { return page; }
        public GetPurchasablePosResponse setPage(Integer value) { this.page = value; return this; }
        public Integer getItems() { return items; }
        public GetPurchasablePosResponse setItems(Integer value) { this.items = value; return this; }
        public Integer getTotalPages() { return totalPages; }
        public GetPurchasablePosResponse setTotalPages(Integer value) { this.totalPages = value; return this; }
        public Integer getTotalResults() { return totalResults; }
        public GetPurchasablePosResponse setTotalResults(Integer value) { this.totalResults = value; return this; }
        public ArrayList<Pos> getElements() { return elements; }
        public GetPurchasablePosResponse setElements(ArrayList<Pos> value) { this.elements = value; return this; }
    }

    public static class Pos
    {
        /**
        * POS Code
        */
        @ApiMember(Description="POS Code", IsRequired=true)
        public String posCode = null;

        /**
        * Name of the POS
        */
        @ApiMember(Description="Name of the POS", IsRequired=true)
        public String name = null;

        /**
        * City of the POS
        */
        @ApiMember(Description="City of the POS", IsRequired=true)
        public String city = null;

        /**
        * Address of the POS
        */
        @ApiMember(Description="Address of the POS", IsRequired=true)
        public String address = null;

        /**
        * Country of the POS
        */
        @ApiMember(Description="Country of the POS", IsRequired=true)
        public String country = null;

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

}

Java GetPurchasablePos DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /purchase/pos HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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