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

namespace Richemont.Booster2.PublicApi.Security.ServiceModel
{
    public partial class GetPosBrand
        : IPagedRequest
    {
        ///<summary>
        ///Brand Trigram
        ///</summary>
        [ApiMember(Description="Brand Trigram", IsRequired=true)]
        public virtual string brand { get; set; }

        ///<summary>
        ///Mnemonic Code to Check
        ///</summary>
        [ApiMember(Description="Mnemonic Code to Check")]
        public virtual string mnemonicCode { get; set; }

        ///<summary>
        ///Business Unit Code
        ///</summary>
        [ApiMember(Description="Business Unit Code")]
        public virtual string buCode { get; set; }

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [ApiMember(Description="Index of the result set returned", IsRequired=true)]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned", IsRequired=true)]
        public virtual int items { get; set; }

        ///<summary>
        ///Omit precise record count - save on performance
        ///</summary>
        [ApiMember(Description="Omit precise record count - save on performance")]
        public virtual bool noCount { get; set; }

        ///<summary>
        ///Sorting expression
        ///</summary>
        [ApiMember(Description="Sorting expression")]
        public virtual string sortBy { get; set; }
    }

    public partial class GetPosBrandResponse
    {
        ///<summary>
        ///Index of the result set returnedr
        ///</summary>
        [ApiMember(Description="Index of the result set returnedr", IsRequired=true)]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned", IsRequired=true)]
        public virtual int items { get; set; }

        ///<summary>
        ///Total amount of pages / result sets
        ///</summary>
        [ApiMember(Description="Total amount of pages / result sets", IsRequired=true)]
        public virtual int totalPages { get; set; }

        ///<summary>
        ///Total amount of results
        ///</summary>
        [ApiMember(Description="Total amount of results", IsRequired=true)]
        public virtual int totalResults { get; set; }

        ///<summary>
        ///List of Users
        ///</summary>
        [ApiMember(Description="List of Users", IsRequired=true)]
        public virtual IEnumerable<PosBrand> elements { get; set; }
    }

    public partial class PosBrand
        : Scope
    {
        ///<summary>
        ///Pos code
        ///</summary>
        [ApiMember(Description="Pos code", IsRequired=true)]
        public virtual string posCode { get; set; }

        ///<summary>
        ///Pos name
        ///</summary>
        [ApiMember(Description="Pos name", IsRequired=true)]
        public virtual string name { get; set; }

        ///<summary>
        ///Pos city
        ///</summary>
        [ApiMember(Description="Pos city", IsRequired=true)]
        public virtual string city { get; set; }

        ///<summary>
        ///Pos address
        ///</summary>
        [ApiMember(Description="Pos address", IsRequired=true)]
        public virtual string address { get; set; }

        ///<summary>
        ///Pos country
        ///</summary>
        [ApiMember(Description="Pos country", IsRequired=true)]
        public virtual string country { get; set; }
    }

    public partial class Scope
    {
        ///<summary>
        ///Scope Code - combination of BU / Brand
        ///</summary>
        [ApiMember(Description="Scope Code - combination of BU / Brand", IsRequired=true)]
        public virtual string scopeCode { get; set; }

        ///<summary>
        ///Business Unit Code
        ///</summary>
        [ApiMember(Description="Business Unit Code", IsRequired=true)]
        public virtual string buCode { get; set; }

        ///<summary>
        ///Brand Trigram
        ///</summary>
        [ApiMember(Description="Brand Trigram", IsRequired=true)]
        public virtual string brand { get; set; }

        ///<summary>
        ///Description of the combination
        ///</summary>
        [ApiMember(Description="Description of the combination", IsRequired=true)]
        public virtual string description { get; set; }
    }

}

C# 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}