Richemont.Booster2.PublicApi

<back to all web services

GetProductCollections

Requires Authentication
The following routes are available for this service:
GET/product-collection/{brand}/{posCode}Get customer product collections
<?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 ProductCollection implements JsonSerializable
{
    public function __construct(
        /** @description Product Collection description */
        // @ApiMember(Description="Product Collection description", IsRequired=true)
        /** @var string */
        public string $productCollection='',

        /** @description SAP ProductCollection ID, e.g. 'CA-1' */
        // @ApiMember(Description="SAP ProductCollection ID, e.g. 'CA-1'", IsRequired=true)
        /** @var string */
        public string $sapProductCollectionId='',

        /** @description Product Collection description translation */
        // @ApiMember(Description="Product Collection description translation", IsRequired=true)
        /** @var string */
        public string $translation=''
    ) {
    }

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

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

class GetProductCollections implements JsonSerializable
{
    public function __construct(
        /** @description Brand */
        // @ApiMember(Description="Brand", IsRequired=true)
        /** @var string */
        public string $brand='',

        /** @description POS Legacy */
        // @ApiMember(Description="POS Legacy", IsRequired=true)
        /** @var string */
        public string $posCode=''
    ) {
    }

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

PHP GetProductCollections 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 /product-collection/{brand}/{posCode} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[]