ScannerVision Web Server

<back to all web services

JsonVpdLicensedRequest

<?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 JsonVpdLicensedRequest 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,
        /** @var string|null */
        public ?string $ClientHostName=null
    ) {
        parent::__construct($ClientCode,$ClientRegistrationCode,$Token);
    }

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

class JsonVpdLicensedResponse extends JsonDto implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $IsLicensed=null
    ) {
    }

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

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

POST /json/reply/JsonVpdLicensedRequest HTTP/1.1 
Host: buildmax.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ClientHostName":"String","ClientCode":"String","ClientRegistrationCode":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsLicensed":false}