ScannerVision Web Server

<back to all web services

WebClientPicklistRequest

<?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};


enum Brand : string
{
    case Desktop = 'Desktop';
    case Hp = 'Hp';
    case Kyocera = 'Kyocera';
    case NeaScan = 'NeaScan';
    case Samsung = 'Samsung';
    case FujiXerox = 'FujiXerox';
    case Ta = 'Ta';
    case Utax = 'Utax';
    case Epson = 'Epson';
    case ScanFront400 = 'ScanFront400';
    case Sharp = 'Sharp';
    case Ricoh = 'Ricoh';
    case FujiFilm = 'FujiFilm';
}

class DtoBase implements JsonSerializable
{
    public function __construct(
        /** @var Brand|null */
        public ?Brand $Brand=null
    ) {
    }

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

class RequestBase extends DtoBase implements JsonSerializable
{
    /**
     * @param Brand|null $Brand
     */
    public function __construct(
        ?Brand $Brand=null
    ) {
        parent::__construct($Brand);
    }

    /** @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;
    }
}

class BrowseRequest extends RequestBase implements JsonSerializable
{
    /**
     * @param Brand|null $Brand
     */
    public function __construct(
        ?Brand $Brand=null,
        /** @var string|null */
        public ?string $Path=null
    ) {
        parent::__construct($Brand);
    }

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

class BrowsePicklistRequest extends BrowseRequest implements JsonSerializable
{
    /**
     * @param Brand|null $Brand
     * @param string|null $Path
     */
    public function __construct(
        ?Brand $Brand=null,
        ?string $Path=null,
        /** @var string|null */
        public ?string $PicklistGuid=null,
        /** @var array<string,string>|null */
        public ?array $Answers=null
    ) {
        parent::__construct($Brand,$Path);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['PicklistGuid'])) $this->PicklistGuid = $o['PicklistGuid'];
        if (isset($o['Answers'])) $this->Answers = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Answers']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->PicklistGuid)) $o['PicklistGuid'] = $this->PicklistGuid;
        if (isset($this->Answers)) $o['Answers'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Answers);
        return empty($o) ? new class(){} : $o;
    }
}

class WebClientPicklistRequest extends BrowsePicklistRequest implements JsonSerializable
{
    /**
     * @param Brand|null $Brand
     * @param string|null $Path
     * @param string|null $PicklistGuid
     * @param array<string,string>|null $Answers
     */
    public function __construct(
        ?Brand $Brand=null,
        ?string $Path=null,
        ?string $PicklistGuid=null,
        ?array $Answers=null,
        /** @var string|null */
        public ?string $TemplateGuid=null,
        /** @var string|null */
        public ?string $QuestionGuid=null,
        /** @var string|null */
        public ?string $SearchTerm=null
    ) {
        parent::__construct($Brand,$Path,$PicklistGuid,$Answers);
    }

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

PHP WebClientPicklistRequest DTOs

POST /{Brand}/browse/{BrowseType}/ HTTP/1.1 
Host: buildmax.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TemplateGuid: String,
	QuestionGuid: String,
	SearchTerm: String,
	PicklistGuid: String,
	Path: String,
	Brand: Desktop
}