Richemont.Booster2.PublicApi

<back to all web services

GetPersonalTitles

Requires Authentication
The following routes are available for this service:
GET/personalTitlesGet Personal Titles
<?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 PersonalTitle implements JsonSerializable
{
    public function __construct(
        /** @description Title */
        // @ApiMember(Description="Title", IsRequired=true)
        /** @var string */
        public string $title='',

        /** @description Gender description(s) */
        // @ApiMember(Description="Gender description(s)", IsRequired=true)
        /** @var array<string>|null */
        public ?array $gender=null,

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['gender'])) $this->gender = JsonConverters::fromArray('string', $o['gender']);
        if (isset($o['translation'])) $this->translation = $o['translation'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->gender)) $o['gender'] = JsonConverters::toArray('string', $this->gender);
        if (isset($this->translation)) $o['translation'] = $this->translation;
        return empty($o) ? new class(){} : $o;
    }
}

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

class GetPersonalTitles implements JsonSerializable
{
    public function __construct(
        /** @description Country Id */
        // @ApiMember(Description="Country Id", IsRequired=true)
        /** @var string */
        public string $countryId=''
    ) {
    }

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

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

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