Richemont.Booster2.PublicApi

<back to all web services

GetMovements

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/movementGet movements
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.Stock.ServiceModel;

namespace Richemont.Booster2.PublicApi.Stock.ServiceModel
{
    public partial class GetMovements
        : MovementsRequest, IPagedRequest
    {
        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [ApiMember(Description="Index of the result set returned")]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned")]
        public virtual int items { get; set; }

        ///<summary>
        ///Omit precise record count - save on performance
        ///</summary>
        [ApiMember(Description="Omit precise record count - save on performance")]
        public virtual bool noCount { get; set; }
    }

    public partial class GetMovementsResponse
    {
        ///<summary>
        ///Total Pages
        ///</summary>
        [ApiMember(Description="Total Pages", IsRequired=true)]
        public virtual int totalPages { get; set; }

        ///<summary>
        ///Total Results
        ///</summary>
        [ApiMember(Description="Total Results", IsRequired=true)]
        public virtual int totalResults { get; set; }

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [ApiMember(Description="Index of the result set returned", IsRequired=true)]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned", IsRequired=true)]
        public virtual int items { get; set; }

        ///<summary>
        ///List of movements
        ///</summary>
        [ApiMember(Description="List of movements", IsRequired=true)]
        public virtual IEnumerable<Movement> elements { get; set; }
    }

    public partial class Movement
    {
        ///<summary>
        ///Movement Id
        ///</summary>
        [ApiMember(Description="Movement Id", IsRequired=true)]
        public virtual int movementId { get; set; }

        ///<summary>
        ///Pos Code
        ///</summary>
        [ApiMember(Description="Pos Code", IsRequired=true)]
        public virtual string posCode { get; set; }

        ///<summary>
        ///Pos Name
        ///</summary>
        [ApiMember(Description="Pos Name", IsRequired=true)]
        public virtual string posName { get; set; }

        ///<summary>
        ///Created By
        ///</summary>
        [ApiMember(Description="Created By", IsRequired=true)]
        public virtual string createdBy { get; set; }

        ///<summary>
        ///Movement Date
        ///</summary>
        [ApiMember(Description="Movement Date", IsRequired=true)]
        public virtual string movementDate { get; set; }

        ///<summary>
        ///Article Code
        ///</summary>
        [ApiMember(Description="Article Code", IsRequired=true)]
        public virtual string articleCode { get; set; }

        ///<summary>
        ///Serial Number
        ///</summary>
        [ApiMember(Description="Serial Number", IsRequired=true)]
        public virtual string serialNumber { get; set; }

        ///<summary>
        ///Quantity
        ///</summary>
        [ApiMember(Description="Quantity", IsRequired=true)]
        public virtual int quantity { get; set; }

        ///<summary>
        ///Movement Type Id
        ///</summary>
        [ApiMember(Description="Movement Type Id", IsRequired=true)]
        public virtual int movementTypeId { get; set; }

        ///<summary>
        ///Comments
        ///</summary>
        [ApiMember(Description="Comments", IsRequired=true)]
        public virtual string comments { get; set; }
    }

    public partial class MovementsRequest
    {
        public MovementsRequest()
        {
            posCodes = new List<string>{};
            movementTypeIds = new List<int>{};
        }

        ///<summary>
        ///Brand
        ///</summary>
        [ApiMember(Description="Brand", IsRequired=true)]
        public virtual string brand { get; set; }

        ///<summary>
        ///POS Legacy
        ///</summary>
        [ApiMember(Description="POS Legacy", IsRequired=true)]
        public virtual List<string> posCodes { get; set; }

        ///<summary>
        ///Movement Type Ids
        ///</summary>
        [ApiMember(Description="Movement Type Ids")]
        public virtual List<int> movementTypeIds { get; set; }

        ///<summary>
        ///Search Key (Article or SerialNumber)
        ///</summary>
        [ApiMember(Description="Search Key (Article or SerialNumber)")]
        public virtual string searchKey { get; set; }

        ///<summary>
        ///In Stock Since date from 
        ///</summary>
        [ApiMember(Description="In Stock Since date from ")]
        public virtual DateTime? dateFrom { get; set; }

        ///<summary>
        ///In Stock Since date to
        ///</summary>
        [ApiMember(Description="In Stock Since date to")]
        public virtual DateTime? dateTo { get; set; }

        ///<summary>
        ///Sort by date could be: 'DateDESC' or 'DateASC' (default is descending) 
        ///</summary>
        [ApiMember(Description="Sort by date could be: 'DateDESC' or 'DateASC' (default is descending) ")]
        public virtual string sortBy { get; set; }
    }

}

C# GetMovements DTOs

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 /stock/{brand}/movement HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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