ScannerVision Web Server

<back to all web services

PostQuestion

<?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 QuestionRequestDto extends RequestBase implements JsonSerializable
{
    /**
     * @param Brand|null $Brand
     */
    public function __construct(
        ?Brand $Brand=null,
        /** @var string|null */
        public ?string $TemplateGuid=null,
        /** @var string|null */
        public ?string $QuestionGuid=null,
        /** @var string|null */
        public ?string $Parent=null,
        /** @var string|null */
        public ?string $FolderBrowser=null
    ) {
        parent::__construct($Brand);
    }

    /** @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['Parent'])) $this->Parent = $o['Parent'];
        if (isset($o['FolderBrowser'])) $this->FolderBrowser = $o['FolderBrowser'];
    }
    
    /** @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->Parent)) $o['Parent'] = $this->Parent;
        if (isset($this->FolderBrowser)) $o['FolderBrowser'] = $this->FolderBrowser;
        return empty($o) ? new class(){} : $o;
    }
}

class PostQuestion extends QuestionRequestDto implements JsonSerializable
{
    /**
     * @param Brand|null $Brand
     * @param string|null $TemplateGuid
     * @param string|null $QuestionGuid
     * @param string|null $Parent
     * @param string|null $FolderBrowser
     */
    public function __construct(
        ?Brand $Brand=null,
        ?string $TemplateGuid=null,
        ?string $QuestionGuid=null,
        ?string $Parent=null,
        ?string $FolderBrowser=null,
        /** @var string|null */
        public ?string $QuestionValueReturned=null,
        /** @var string|null */
        public ?string $QuestionValueDisplayed=null,
        /** @var string|null */
        public ?string $SelectedFolder=null
    ) {
        parent::__construct($Brand,$TemplateGuid,$QuestionGuid,$Parent,$FolderBrowser);
    }

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

PHP PostQuestion DTOs

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

{
	QuestionValueReturned: String,
	QuestionValueDisplayed: String,
	SelectedFolder: String,
	TemplateGuid: String,
	QuestionGuid: String,
	Parent: String,
	FolderBrowser: String,
	Brand: Desktop
}