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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.Purchase.ServiceModel

Namespace Global

    Namespace Richemont.Booster2.PublicApi.Purchase.ServiceModel

        Public Partial Class GetPurchasablePos
            Implements IPagedRequest
            '''<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>
            '''Omit precise record count - save on performance
            '''</Summary>
            <ApiMember(Description:="Omit precise record count - save on performance")>
            Public Overridable Property noCount As Boolean

            '''<Summary>
            '''Sorting expression
            '''</Summary>
            <ApiMember(Description:="Sorting expression")>
            Public Overridable Property sortBy As String

            '''<Summary>
            '''Brand Trigram
            '''</Summary>
            <ApiMember(Description:="Brand Trigram", IsRequired:=true)>
            Public Overridable Property brand As String

            '''<Summary>
            '''Brand Context ID
            '''</Summary>
            <ApiMember(Description:="Brand Context ID")>
            Public Overridable Property boosterContextId As String
        End Class

        Public Partial Class GetPurchasablePosResponse
            '''<Summary>
            '''Index of the result set returnedr
            '''</Summary>
            <ApiMember(Description:="Index of the result set returnedr", 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>
            '''Total amount of pages / result sets
            '''</Summary>
            <ApiMember(Description:="Total amount of pages / result sets", IsRequired:=true)>
            Public Overridable Property totalPages As Integer

            '''<Summary>
            '''Total amount of results
            '''</Summary>
            <ApiMember(Description:="Total amount of results", IsRequired:=true)>
            Public Overridable Property totalResults As Integer

            '''<Summary>
            '''List of Pos
            '''</Summary>
            <ApiMember(Description:="List of Pos", IsRequired:=true)>
            Public Overridable Property elements As IEnumerable(Of Pos)
        End Class

        Public Partial Class Pos
            '''<Summary>
            '''POS Code
            '''</Summary>
            <ApiMember(Description:="POS Code", IsRequired:=true)>
            Public Overridable Property posCode As String

            '''<Summary>
            '''Name of the POS
            '''</Summary>
            <ApiMember(Description:="Name of the POS", IsRequired:=true)>
            Public Overridable Property name As String

            '''<Summary>
            '''City of the POS
            '''</Summary>
            <ApiMember(Description:="City of the POS", IsRequired:=true)>
            Public Overridable Property city As String

            '''<Summary>
            '''Address of the POS
            '''</Summary>
            <ApiMember(Description:="Address of the POS", IsRequired:=true)>
            Public Overridable Property address As String

            '''<Summary>
            '''Country of the POS
            '''</Summary>
            <ApiMember(Description:="Country of the POS", IsRequired:=true)>
            Public Overridable Property country As String

            '''<Summary>
            '''Brand of the POS
            '''</Summary>
            <ApiMember(Description:="Brand of the POS", IsRequired:=true)>
            Public Overridable Property brand As String
        End Class
    End Namespace
End Namespace

VB.NET GetPurchasablePos 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 /purchase/pos HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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