Richemont.Booster2.PublicApi

<back to all web services

GetCountries

Requires Authentication
The following routes are available for this service:
GET/countriesGet Countries API
<?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 Country implements JsonSerializable
{
    public function __construct(
        /** @description Country id */
        // @ApiMember(Description="Country id", IsRequired=true)
        /** @var string */
        public string $countryId='',

        /** @description Country description */
        // @ApiMember(Description="Country description", IsRequired=true)
        /** @var string */
        public string $countryDs='',

        /** @description Trasnlation of country description based on user language settings */
        // @ApiMember(Description="Trasnlation of country description based on user language settings")
        /** @var string|null */
        public ?string $translation=null,

        /** @description Telephone prefix */
        // @ApiMember(Description="Telephone prefix", IsRequired=true)
        /** @var string */
        public string $telephonePrefix=''
    ) {
    }

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

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

class GetCountries implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetCountries 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 /countries HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[]