Richemont.Booster2.PublicApi

<back to all web services

GetMovements

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/movementGet movements
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetMovements extends MovementsRequest implements IPagedRequest
    {
        /**
        * Index of the result set returned
        */
        @ApiMember(Description="Index of the result set returned")
        public Integer page = null;

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

        /**
        * Omit precise record count - save on performance
        */
        @ApiMember(Description="Omit precise record count - save on performance")
        public Boolean noCount = null;
        
        public Integer getPage() { return page; }
        public GetMovements setPage(Integer value) { this.page = value; return this; }
        public Integer getItems() { return items; }
        public GetMovements setItems(Integer value) { this.items = value; return this; }
        public Boolean isNoCount() { return noCount; }
        public GetMovements setNoCount(Boolean value) { this.noCount = value; return this; }
    }

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

        /**
        * POS Legacy
        */
        @ApiMember(Description="POS Legacy", IsRequired=true)
        public ArrayList<String> posCodes = null;

        /**
        * Movement Type Ids
        */
        @ApiMember(Description="Movement Type Ids")
        public ArrayList<Integer> movementTypeIds = null;

        /**
        * Search Key (Article or SerialNumber)
        */
        @ApiMember(Description="Search Key (Article or SerialNumber)")
        public String searchKey = null;

        /**
        * In Stock Since date from 
        */
        @ApiMember(Description="In Stock Since date from ")
        public Date dateFrom = null;

        /**
        * In Stock Since date to
        */
        @ApiMember(Description="In Stock Since date to")
        public Date dateTo = null;

        /**
        * Sort by date could be: 'DateDESC' or 'DateASC' (default is descending) 
        */
        @ApiMember(Description="Sort by date could be: 'DateDESC' or 'DateASC' (default is descending) ")
        public String sortBy = null;
        
        public String getBrand() { return brand; }
        public MovementsRequest setBrand(String value) { this.brand = value; return this; }
        public ArrayList<String> getPosCodes() { return posCodes; }
        public MovementsRequest setPosCodes(ArrayList<String> value) { this.posCodes = value; return this; }
        public ArrayList<Integer> getMovementTypeIds() { return movementTypeIds; }
        public MovementsRequest setMovementTypeIds(ArrayList<Integer> value) { this.movementTypeIds = value; return this; }
        public String getSearchKey() { return searchKey; }
        public MovementsRequest setSearchKey(String value) { this.searchKey = value; return this; }
        public Date getDateFrom() { return dateFrom; }
        public MovementsRequest setDateFrom(Date value) { this.dateFrom = value; return this; }
        public Date getDateTo() { return dateTo; }
        public MovementsRequest setDateTo(Date value) { this.dateTo = value; return this; }
        public String getSortBy() { return sortBy; }
        public MovementsRequest setSortBy(String value) { this.sortBy = value; return this; }
    }

    public static class GetMovementsResponse
    {
        /**
        * Total Pages
        */
        @ApiMember(Description="Total Pages", IsRequired=true)
        public Integer totalPages = null;

        /**
        * Total Results
        */
        @ApiMember(Description="Total Results", IsRequired=true)
        public Integer totalResults = 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;

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

    public static class Movement
    {
        /**
        * Movement Id
        */
        @ApiMember(Description="Movement Id", IsRequired=true)
        public Integer movementId = null;

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

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

        /**
        * Created By
        */
        @ApiMember(Description="Created By", IsRequired=true)
        public String createdBy = null;

        /**
        * Movement Date
        */
        @ApiMember(Description="Movement Date", IsRequired=true)
        public String movementDate = null;

        /**
        * Article Code
        */
        @ApiMember(Description="Article Code", IsRequired=true)
        public String articleCode = null;

        /**
        * Serial Number
        */
        @ApiMember(Description="Serial Number", IsRequired=true)
        public String serialNumber = null;

        /**
        * Quantity
        */
        @ApiMember(Description="Quantity", IsRequired=true)
        public Integer quantity = null;

        /**
        * Movement Type Id
        */
        @ApiMember(Description="Movement Type Id", IsRequired=true)
        public Integer movementTypeId = null;

        /**
        * Comments
        */
        @ApiMember(Description="Comments", IsRequired=true)
        public String comments = null;
        
        public Integer getMovementId() { return movementId; }
        public Movement setMovementId(Integer value) { this.movementId = value; return this; }
        public String getPosCode() { return posCode; }
        public Movement setPosCode(String value) { this.posCode = value; return this; }
        public String getPosName() { return posName; }
        public Movement setPosName(String value) { this.posName = value; return this; }
        public String getCreatedBy() { return createdBy; }
        public Movement setCreatedBy(String value) { this.createdBy = value; return this; }
        public String getMovementDate() { return movementDate; }
        public Movement setMovementDate(String value) { this.movementDate = value; return this; }
        public String getArticleCode() { return articleCode; }
        public Movement setArticleCode(String value) { this.articleCode = value; return this; }
        public String getSerialNumber() { return serialNumber; }
        public Movement setSerialNumber(String value) { this.serialNumber = value; return this; }
        public Integer getQuantity() { return quantity; }
        public Movement setQuantity(Integer value) { this.quantity = value; return this; }
        public Integer getMovementTypeId() { return movementTypeId; }
        public Movement setMovementTypeId(Integer value) { this.movementTypeId = value; return this; }
        public String getComments() { return comments; }
        public Movement setComments(String value) { this.comments = value; return this; }
    }

}

Java GetMovements DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /stock/{brand}/movement HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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