Richemont.Booster2.PublicApi

<back to all web services

GetSalesReps

Requires Authentication
The following routes are available for this service:
GET/salesReps/{brand}/{posCode}Get Sales Reps
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class SalesRep implements JsonSerializable
{
    public function __construct(
        /** @description First name of sales representative */
        // @ApiMember(Description="First name of sales representative", IsRequired=true)
        /** @var string */
        public string $firstName='',

        /** @description Last name of sales representative */
        // @ApiMember(Description="Last name of sales representative", IsRequired=true)
        /** @var string */
        public string $lastName='',

        /** @description Email address of sales representative */
        // @ApiMember(Description="Email address of sales representative", IsRequired=true)
        /** @var string */
        public string $email='',

        /** @description User ID of sales representative */
        // @ApiMember(Description="User ID of sales representative", IsRequired=true)
        /** @var string */
        public string $userId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['firstName'])) $this->firstName = $o['firstName'];
        if (isset($o['lastName'])) $this->lastName = $o['lastName'];
        if (isset($o['email'])) $this->email = $o['email'];
        if (isset($o['userId'])) $this->userId = $o['userId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->firstName)) $o['firstName'] = $this->firstName;
        if (isset($this->lastName)) $o['lastName'] = $this->lastName;
        if (isset($this->email)) $o['email'] = $this->email;
        if (isset($this->userId)) $o['userId'] = $this->userId;
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template array of SalesRep
 */
class GetSalesRepsResponse extends \ArrayObject implements JsonSerializable
{
    public function __construct(SalesRep ...$items) {
        parent::__construct($items, \ArrayObject::STD_PROP_LIST);
    }
    
    /** @throws \Exception */
    public function append($value): void {
        if ($value instanceof SalesRep)
            parent::append($value);
        else
            throw new \Exception("Can only append a SalesRep to " . __CLASS__);
    }
    
    /** @throws Exception */
    public function fromMap($o): void {
        foreach ($o as $item) {
            $el = new SalesRep();
            $el->fromMap($item);
            $this->append($el);
        }
    }
    
    /** @throws Exception */
    public function jsonSerialize(): array {
        return parent::getArrayCopy();
    }
}

class GetSalesReps implements JsonSerializable
{
    public function __construct(
        /** @description Brand Triagram, e.g. CAR, IWC, VAC */
        // @ApiMember(Description="Brand Triagram, e.g. CAR, IWC, VAC", IsRequired=true)
        /** @var string */
        public string $brand='',

        /** @description Point of Sale Code, e.g. ES100:102048 */
        // @ApiMember(Description="Point of Sale Code, e.g. ES100:102048", IsRequired=true)
        /** @var string */
        public string $posCode='',

        /** @description Booster Customer Id */
        // @ApiMember(Description="Booster Customer Id")
        /** @var int|null */
        public ?int $boosterCustomerId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['brand'])) $this->brand = $o['brand'];
        if (isset($o['posCode'])) $this->posCode = $o['posCode'];
        if (isset($o['boosterCustomerId'])) $this->boosterCustomerId = $o['boosterCustomerId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->brand)) $o['brand'] = $this->brand;
        if (isset($this->posCode)) $o['posCode'] = $this->posCode;
        if (isset($this->boosterCustomerId)) $o['boosterCustomerId'] = $this->boosterCustomerId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetSalesReps DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /salesReps/{brand}/{posCode} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfSalesRep xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.POS.ServiceModel" />