Richemont.Booster2.PublicApi

GetPosBrand

The following routes are available for this service:
GET	/security/pos	Get the list of pos groups where user is authorized

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.Security.ServiceModel

Namespace Global

    Namespace Richemont.Booster2.PublicApi.Security.ServiceModel

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

            '''<Summary>
            '''Mnemonic Code to Check
            '''</Summary>
            <ApiMember(Description:="Mnemonic Code to Check")>
            Public Overridable Property mnemonicCode As String

            '''<Summary>
            '''Business Unit Code
            '''</Summary>
            <ApiMember(Description:="Business Unit Code")>
            Public Overridable Property buCode As String

            '''<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
        End Class

        Public Partial Class GetPosBrandResponse
            '''<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 Users
            '''</Summary>
            <ApiMember(Description:="List of Users", IsRequired:=true)>
            Public Overridable Property elements As IEnumerable(Of PosBrand)
        End Class

        Public Partial Class PosBrand
            Inherits Scope
            '''<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 name As String

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

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

            '''<Summary>
            '''Pos country
            '''</Summary>
            <ApiMember(Description:="Pos country", IsRequired:=true)>
            Public Overridable Property country As String
        End Class

        Public Partial Class Scope
            '''<Summary>
            '''Scope Code - combination of BU / Brand
            '''</Summary>
            <ApiMember(Description:="Scope Code - combination of BU / Brand", IsRequired:=true)>
            Public Overridable Property scopeCode As String

            '''<Summary>
            '''Business Unit Code
            '''</Summary>
            <ApiMember(Description:="Business Unit Code", IsRequired:=true)>
            Public Overridable Property buCode As String

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

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

VB.NET GetPosBrand 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 /security/pos HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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