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
namespace Richemont.Booster2.PublicApi.Purchase.ServiceModel

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

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

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

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

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

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

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

    [<AllowNullLiteral>]
    type GetPurchasablePosResponse() = 
        ///<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 Pos
        ///</summary>
        [<ApiMember(Description="List of Pos", IsRequired=true)>]
        member val elements:IEnumerable<Pos> = null with get,set

    [<AllowNullLiteral>]
    type GetPurchasablePos() = 
        ///<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

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

        ///<summary>
        ///Brand Context ID
        ///</summary>
        [<ApiMember(Description="Brand Context ID")>]
        member val boosterContextId:String = null with get,set

F# GetPurchasablePos DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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