Richemont.Booster2.PublicApi

<back to all web services

CreateUser

Requires Authentication
The following routes are available for this service:
POST/usersCreate a new External User
<?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 CreateUserResponse implements JsonSerializable
{
    public function __construct(
        /** @description Unique Identifier of the User created in Booster */
        // @ApiMember(Description="Unique Identifier of the User created in Booster", IsRequired=true)
        /** @var string */
        public string $userId=''
    ) {
    }

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

class CreateUser implements JsonSerializable
{
    public function __construct(
        /** @description User E-mail */
        // @ApiMember(Description="User E-mail", IsRequired=true)
        /** @var string */
        public string $email='',

        /** @description User First Name */
        // @ApiMember(Description="User First Name", IsRequired=true)
        /** @var string */
        public string $firstName='',

        /** @description User Last Name */
        // @ApiMember(Description="User Last Name", IsRequired=true)
        /** @var string */
        public string $lastName='',

        /** @description User Culture */
        // @ApiMember(Description="User Culture", IsRequired=true)
        /** @var string */
        public string $culture='',

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

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

PHP CreateUser 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.

POST /users HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Security.ServiceModel">
  <countryId>String</countryId>
  <culture>String</culture>
  <email>String</email>
  <firstName>String</firstName>
  <lastName>String</lastName>
</CreateUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Security.ServiceModel">
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
</CreateUserResponse>