| GET | /stock/{brand}/movement | Get movements |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.Stock.ServiceModel
Namespace Global
Namespace Richemont.Booster2.PublicApi.Stock.ServiceModel
Public Partial Class GetMovements
Inherits MovementsRequest
Implements IPagedRequest
'''<Summary>
'''Index of the result set returned
'''</Summary>
<ApiMember(Description:="Index of the result set returned")>
Public Overridable Property page As Integer
'''<Summary>
'''Size of the result set returned
'''</Summary>
<ApiMember(Description:="Size of the result set returned")>
Public Overridable Property items As Integer
'''<Summary>
'''Omit precise record count - save on performance
'''</Summary>
<ApiMember(Description:="Omit precise record count - save on performance")>
Public Overridable Property noCount As Boolean
End Class
Public Partial Class GetMovementsResponse
'''<Summary>
'''Total Pages
'''</Summary>
<ApiMember(Description:="Total Pages", IsRequired:=true)>
Public Overridable Property totalPages As Integer
'''<Summary>
'''Total Results
'''</Summary>
<ApiMember(Description:="Total Results", IsRequired:=true)>
Public Overridable Property totalResults As Integer
'''<Summary>
'''Index of the result set returned
'''</Summary>
<ApiMember(Description:="Index of the result set returned", IsRequired:=true)>
Public Overridable Property page As Integer
'''<Summary>
'''Size of the result set returned
'''</Summary>
<ApiMember(Description:="Size of the result set returned", IsRequired:=true)>
Public Overridable Property items As Integer
'''<Summary>
'''List of movements
'''</Summary>
<ApiMember(Description:="List of movements", IsRequired:=true)>
Public Overridable Property elements As IEnumerable(Of Movement)
End Class
Public Partial Class Movement
'''<Summary>
'''Movement Id
'''</Summary>
<ApiMember(Description:="Movement Id", IsRequired:=true)>
Public Overridable Property movementId As Integer
'''<Summary>
'''Pos Code
'''</Summary>
<ApiMember(Description:="Pos Code", IsRequired:=true)>
Public Overridable Property posCode As String
'''<Summary>
'''Pos Name
'''</Summary>
<ApiMember(Description:="Pos Name", IsRequired:=true)>
Public Overridable Property posName As String
'''<Summary>
'''Created By
'''</Summary>
<ApiMember(Description:="Created By", IsRequired:=true)>
Public Overridable Property createdBy As String
'''<Summary>
'''Movement Date
'''</Summary>
<ApiMember(Description:="Movement Date", IsRequired:=true)>
Public Overridable Property movementDate As String
'''<Summary>
'''Article Code
'''</Summary>
<ApiMember(Description:="Article Code", IsRequired:=true)>
Public Overridable Property articleCode As String
'''<Summary>
'''Serial Number
'''</Summary>
<ApiMember(Description:="Serial Number", IsRequired:=true)>
Public Overridable Property serialNumber As String
'''<Summary>
'''Quantity
'''</Summary>
<ApiMember(Description:="Quantity", IsRequired:=true)>
Public Overridable Property quantity As Integer
'''<Summary>
'''Movement Type Id
'''</Summary>
<ApiMember(Description:="Movement Type Id", IsRequired:=true)>
Public Overridable Property movementTypeId As Integer
'''<Summary>
'''Comments
'''</Summary>
<ApiMember(Description:="Comments", IsRequired:=true)>
Public Overridable Property comments As String
End Class
Public Partial Class MovementsRequest
Public Sub New()
posCodes = New List(Of String)
movementTypeIds = New List(Of Integer)
End Sub
'''<Summary>
'''Brand
'''</Summary>
<ApiMember(Description:="Brand", IsRequired:=true)>
Public Overridable Property brand As String
'''<Summary>
'''POS Legacy
'''</Summary>
<ApiMember(Description:="POS Legacy", IsRequired:=true)>
Public Overridable Property posCodes As List(Of String)
'''<Summary>
'''Movement Type Ids
'''</Summary>
<ApiMember(Description:="Movement Type Ids")>
Public Overridable Property movementTypeIds As List(Of Integer)
'''<Summary>
'''Search Key (Article or SerialNumber)
'''</Summary>
<ApiMember(Description:="Search Key (Article or SerialNumber)")>
Public Overridable Property searchKey As String
'''<Summary>
'''In Stock Since date from
'''</Summary>
<ApiMember(Description:="In Stock Since date from ")>
Public Overridable Property dateFrom As Nullable(Of Date)
'''<Summary>
'''In Stock Since date to
'''</Summary>
<ApiMember(Description:="In Stock Since date to")>
Public Overridable Property dateTo As Nullable(Of Date)
'''<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 Overridable Property sortBy As String
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetMovementsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Stock.ServiceModel"> <elements i:nil="true" /> <items>0</items> <page>0</page> <totalPages>0</totalPages> <totalResults>0</totalResults> </GetMovementsResponse>