Richemont.Booster2.PublicApi

<back to all web services

GetPosBrand

Requires Authentication
The following routes are available for this service:
GET/security/posGet the list of pos groups where user is authorized
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetPosBrand : IPagedRequest
{
    /**
    * Brand Trigram
    */
    @ApiMember(Description="Brand Trigram", IsRequired=true)
    var brand:String? = null

    /**
    * Mnemonic Code to Check
    */
    @ApiMember(Description="Mnemonic Code to Check")
    var mnemonicCode:String? = null

    /**
    * Business Unit Code
    */
    @ApiMember(Description="Business Unit Code")
    var buCode:String? = null

    /**
    * Index of the result set returned
    */
    @ApiMember(Description="Index of the result set returned", IsRequired=true)
    var page:Int? = null

    /**
    * Size of the result set returned
    */
    @ApiMember(Description="Size of the result set returned", IsRequired=true)
    var items:Int? = null

    /**
    * Omit precise record count - save on performance
    */
    @ApiMember(Description="Omit precise record count - save on performance")
    var noCount:Boolean? = null

    /**
    * Sorting expression
    */
    @ApiMember(Description="Sorting expression")
    var sortBy:String? = null
}

open class GetPosBrandResponse
{
    /**
    * Index of the result set returnedr
    */
    @ApiMember(Description="Index of the result set returnedr", IsRequired=true)
    var page:Int? = null

    /**
    * Size of the result set returned
    */
    @ApiMember(Description="Size of the result set returned", IsRequired=true)
    var items:Int? = null

    /**
    * Total amount of pages / result sets
    */
    @ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
    var totalPages:Int? = null

    /**
    * Total amount of results
    */
    @ApiMember(Description="Total amount of results", IsRequired=true)
    var totalResults:Int? = null

    /**
    * List of Users
    */
    @ApiMember(Description="List of Users", IsRequired=true)
    var elements:ArrayList<PosBrand> = ArrayList<PosBrand>()
}

open class PosBrand : Scope()
{
    /**
    * Pos code
    */
    @ApiMember(Description="Pos code", IsRequired=true)
    var posCode:String? = null

    /**
    * Pos name
    */
    @ApiMember(Description="Pos name", IsRequired=true)
    var name:String? = null

    /**
    * Pos city
    */
    @ApiMember(Description="Pos city", IsRequired=true)
    var city:String? = null

    /**
    * Pos address
    */
    @ApiMember(Description="Pos address", IsRequired=true)
    var address:String? = null

    /**
    * Pos country
    */
    @ApiMember(Description="Pos country", IsRequired=true)
    var country:String? = null
}

open class Scope
{
    /**
    * Scope Code - combination of BU / Brand
    */
    @ApiMember(Description="Scope Code - combination of BU / Brand", IsRequired=true)
    var scopeCode:String? = null

    /**
    * Business Unit Code
    */
    @ApiMember(Description="Business Unit Code", IsRequired=true)
    var buCode:String? = null

    /**
    * Brand Trigram
    */
    @ApiMember(Description="Brand Trigram", IsRequired=true)
    var brand:String? = null

    /**
    * Description of the combination
    */
    @ApiMember(Description="Description of the combination", IsRequired=true)
    var description:String? = null
}

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