ScannerVision Web Server

JsonRegisterClientRequest

<?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 JsonDto implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

class JsonRequestDto extends JsonDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ClientCode=null,
        /** @var string|null */
        public ?string $ClientRegistrationCode=null,
        /** @var string|null */
        public ?string $Token=null
    ) {
    }

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

class JsonRegisterClientRequest extends JsonRequestDto implements JsonSerializable
{
    /**
     * @param string|null $ClientCode
     * @param string|null $ClientRegistrationCode
     * @param string|null $Token
     */
    public function __construct(
        ?string $ClientCode=null,
        ?string $ClientRegistrationCode=null,
        ?string $Token=null
    ) {
        parent::__construct($ClientCode,$ClientRegistrationCode,$Token);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

enum RegistrationResult : string
{
    case Success = 'Success';
    case ClientCodeNotFound = 'ClientCodeNotFound';
    case ClientAlreadyRegistered = 'ClientAlreadyRegistered';
    case Error = 'Error';
}

class JsonRegisterClientResponse extends JsonDto implements JsonSerializable
{
    public function __construct(
        /** @var RegistrationResult|null */
        public ?RegistrationResult $Result=null,
        /** @var string|null */
        public ?string $ErrorMessage=null,
        /** @var string|null */
        public ?string $ClientRegistrationCode=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Result'])) $this->Result = JsonConverters::from('RegistrationResult', $o['Result']);
        if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
        if (isset($o['ClientRegistrationCode'])) $this->ClientRegistrationCode = $o['ClientRegistrationCode'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Result)) $o['Result'] = JsonConverters::to('RegistrationResult', $this->Result);
        if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
        if (isset($this->ClientRegistrationCode)) $o['ClientRegistrationCode'] = $this->ClientRegistrationCode;
        return empty($o) ? new class(){} : $o;
    }
}

PHP JsonRegisterClientRequest DTOs

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

HTTP + OTHER

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

POST /jsonl/reply/JsonRegisterClientRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ClientCode":"String","ClientRegistrationCode":"String","Token":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Result":"Success","ErrorMessage":"String","ClientRegistrationCode":"String"}