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

namespace Richemont.Booster2.PublicApi.Security.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Scope() = 
        ///<summary>
        ///Scope Code - combination of BU / Brand
        ///</summary>
        [<ApiMember(Description="Scope Code - combination of BU / Brand", IsRequired=true)>]
        member val scopeCode:String = null with get,set

        ///<summary>
        ///Business Unit Code
        ///</summary>
        [<ApiMember(Description="Business Unit Code", IsRequired=true)>]
        member val buCode:String = null with get,set

        ///<summary>
        ///Brand Trigram
        ///</summary>
        [<ApiMember(Description="Brand Trigram", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///Description of the combination
        ///</summary>
        [<ApiMember(Description="Description of the combination", IsRequired=true)>]
        member val description:String = null with get,set

    [<AllowNullLiteral>]
    type PosBrand() = 
        inherit Scope()
        ///<summary>
        ///Pos code
        ///</summary>
        [<ApiMember(Description="Pos code", IsRequired=true)>]
        member val posCode:String = null with get,set

        ///<summary>
        ///Pos name
        ///</summary>
        [<ApiMember(Description="Pos name", IsRequired=true)>]
        member val name:String = null with get,set

        ///<summary>
        ///Pos city
        ///</summary>
        [<ApiMember(Description="Pos city", IsRequired=true)>]
        member val city:String = null with get,set

        ///<summary>
        ///Pos address
        ///</summary>
        [<ApiMember(Description="Pos address", IsRequired=true)>]
        member val address:String = null with get,set

        ///<summary>
        ///Pos country
        ///</summary>
        [<ApiMember(Description="Pos country", IsRequired=true)>]
        member val country:String = null with get,set

    [<AllowNullLiteral>]
    type GetPosBrandResponse() = 
        ///<summary>
        ///Index of the result set returnedr
        ///</summary>
        [<ApiMember(Description="Index of the result set returnedr", IsRequired=true)>]
        member val page:Int32 = new Int32() with get,set

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [<ApiMember(Description="Size of the result set returned", IsRequired=true)>]
        member val items:Int32 = new Int32() with get,set

        ///<summary>
        ///Total amount of pages / result sets
        ///</summary>
        [<ApiMember(Description="Total amount of pages / result sets", IsRequired=true)>]
        member val totalPages:Int32 = new Int32() with get,set

        ///<summary>
        ///Total amount of results
        ///</summary>
        [<ApiMember(Description="Total amount of results", IsRequired=true)>]
        member val totalResults:Int32 = new Int32() with get,set

        ///<summary>
        ///List of Users
        ///</summary>
        [<ApiMember(Description="List of Users", IsRequired=true)>]
        member val elements:IEnumerable<PosBrand> = null with get,set

    [<AllowNullLiteral>]
    type GetPosBrand() = 
        ///<summary>
        ///Brand Trigram
        ///</summary>
        [<ApiMember(Description="Brand Trigram", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///Mnemonic Code to Check
        ///</summary>
        [<ApiMember(Description="Mnemonic Code to Check")>]
        member val mnemonicCode:String = null with get,set

        ///<summary>
        ///Business Unit Code
        ///</summary>
        [<ApiMember(Description="Business Unit Code")>]
        member val buCode:String = null with get,set

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [<ApiMember(Description="Index of the result set returned", IsRequired=true)>]
        member val page:Int32 = new Int32() with get,set

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [<ApiMember(Description="Size of the result set returned", IsRequired=true)>]
        member val items:Int32 = new Int32() with get,set

        ///<summary>
        ///Omit precise record count - save on performance
        ///</summary>
        [<ApiMember(Description="Omit precise record count - save on performance")>]
        member val noCount:Boolean = new Boolean() with get,set

        ///<summary>
        ///Sorting expression
        ///</summary>
        [<ApiMember(Description="Sorting expression")>]
        member val sortBy:String = null with get,set

F# GetPosBrand 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 /security/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
}