ScannerVision Web Server

<back to all web services

GetTemplates

Requires Authentication
The following routes are available for this service:
GET, POST/{Brand}/templates
All Verbs/kyocera/{Template*}
All Verbs/ta/{Template*}
All Verbs/utax/{Template*}
<?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 GetTemplates extends RequestBase implements JsonSerializable
{
    /**
     * @param Brand|null $Brand
     */
    public function __construct(
        ?Brand $Brand=null,
        /** @var string|null */
        public ?string $Template=null
    ) {
        parent::__construct($Brand);
    }

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

class ResponseBase extends DtoBase implements JsonSerializable
{
    /**
     * @param Brand|null $Brand
     */
    public function __construct(
        ?Brand $Brand=null,
        /** @var string|null */
        public ?string $SelectedUiLanguage=null,
        /** @var string|null */
        public ?string $svSession=null,
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $PageTip=null,
        /** @var bool|null */
        public ?bool $NewBrowser=null,
        /** @var bool|null */
        public ?bool $ScanFront400TA=null,
        /** @var bool|null */
        public ?bool $ScanFront400UTAX=null
    ) {
        parent::__construct($Brand);
    }

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

/**
 * @property string|null $Guid
 * @property DateTime $TemplateModificationDateTime
 * @property DateTime $IconModificationDateTime
 */
interface ITemplateModificationInfo
{
}

/**
 * @property string|null $QuestionGuid
 * @property string|null $ValueDisplayed
 * @property string|null $ValueReturned
 * @property bool $Answered
 * @property bool $RegexMatches
 * @property string|null $RegexHint
 */
interface IClientQuestion extends ITemplateQuestion
{
}

enum TemplateType : string
{
    case Workflow = 'Workflow';
    case FreeForm = 'FreeForm';
}

enum TemplateScheduleType : string
{
    case Interval = 'Interval';
    case Fixed = 'Fixed';
}

/**
 * @property DateInterval|null $Time
 * @property DateInterval|null $EndTime
 * @property bool|null $NoEndTime
 * @property TemplateScheduleType|null $Type
 */
interface ITemplateSchedule extends IInterface
{
}

/**
 * @property string|null $Username
 * @property string|null $Password
 */
interface ICredentials extends IInterface
{
}

/**
 * @property int|null $RejectAfter
 * @property string|null $RejectionPath
 * @property ICredentials|null $ShareCredentials
 */
interface IRejection
{
}

/**
 * @property string|null $RejectionPath
 * @property ICredentials|null $ShareCredentials
 */
interface IBadDocumentRejection extends IStatus
{
}

enum PdfLoadResolution : string
{
    case Default = 'Default';
    case Dpi100 = 'Dpi100';
    case Dpi150 = 'Dpi150';
    case Dpi200 = 'Dpi200';
    case Dpi300 = 'Dpi300';
    case Dpi400 = 'Dpi400';
    case Dpi500 = 'Dpi500';
    case Dpi600 = 'Dpi600';
}

/**
 * @property string|null $Name
 * @property string|null $Description
 * @property string|null $Icon
 * @property ITemplateSchedule|null $Schedule
 * @property IRejection|null $Rejection
 * @property IBadDocumentRejection|null $BadDocumentRejection
 * @property PdfLoadResolution|null $PdfLoadResolution
 */
interface IGeneral extends IInterface
{
}

interface ICaptureSource extends IStatus
{
}

/**
 * @property ReadOnlyCollection<ICaptureSource>|null $CaptureSources
 */
interface ICapture extends IInterface
{
}

/**
 * @property bool|null $IsSecure
 * @property string|null $SampleValue
 * @property string|null $Value
 */
interface IStringMetadata extends IMetadata
{
}

/**
 * @property string|null $XPathExpression
 * @property IStringMetadata|null $Metadata
 */
interface IXmlMetadataImportTagMapping extends IInterface
{
}

/**
 * @property string|null $Prefix
 * @property string|null $Name
 */
interface IXmlMetadataImportNamespaceMapping extends IInterface
{
}

/**
 * @property string|null $SampleDocumentName
 * @property ReadOnlyCollection<IXmlMetadataImportTagMapping>|null $TagMappings
 * @property ReadOnlyCollection<IXmlMetadataImportNamespaceMapping>|null $NamespaceMappings
 */
interface IXmlMetadataImport extends IStatus
{
}

enum NotificationType : string
{
    case FailureOnly = 'FailureOnly';
    case SuccessOnly = 'SuccessOnly';
    case Always = 'Always';
}

/**
 * @property string|null $Description
 * @property string|null $To
 * @property string|null $Subject
 * @property string|null $Body
 * @property string|null $Cc
 * @property string|null $Bcc
 * @property NotificationType|null $NotificationType
 */
interface INotification extends IStatus
{
}

/**
 * @property ReadOnlyCollection<INotification>|null $Notifications
 */
interface INotifications extends IStatus
{
}

/**
 * @property string|null $Property
 * @property string|null $ErrorMessage
 */
interface IValidationError
{
}

/**
 * @property ReadOnlyCollection<IValidationError>|null $Errors
 */
interface IValidationErrors
{
}

/**
 * @property IValidationErrors|null $ValidationErrors
 * @property bool $IsValid
 */
interface IValidator
{
}

/**
 * @property string|null $TemplateVersion
 * @property string|null $ScannerVisionVersion
 * @property string|null $Guid
 * @property string|null $BeginScript
 * @property string|null $EndScript
 * @property TemplateType $TemplateType
 * @property IGeneral|null $General
 * @property ICapture|null $Capture
 * @property IXmlMetadataImport|null $XmlMetadataImport
 * @property INotifications|null $Notifications
 * @property IValidator|null $Validator
 */
interface ITemplate extends IStatus
{
}

/**
 * @property string|null $Description
 * @property ByteArray|null $Icon
 * @property ITemplateModificationInfo|null $ModificationInfo
 * @property string|null $Name
 * @property array<IClientQuestion>|null $Questions
 * @property ITemplate|null $Template
 * @property string|null $TemplateGuid
 */
interface IClientTemplate
{
}

class GetTemplatesResponse extends ResponseBase implements JsonSerializable
{
    /**
     * @param Brand|null $Brand
     * @param string|null $SelectedUiLanguage
     * @param string|null $svSession
     * @param string|null $Title
     * @param string|null $PageTip
     * @param bool|null $NewBrowser
     * @param bool|null $ScanFront400TA
     * @param bool|null $ScanFront400UTAX
     */
    public function __construct(
        ?Brand $Brand=null,
        ?string $SelectedUiLanguage=null,
        ?string $svSession=null,
        ?string $Title=null,
        ?string $PageTip=null,
        ?bool $NewBrowser=null,
        ?bool $ScanFront400TA=null,
        ?bool $ScanFront400UTAX=null,
        /** @var array<IClientTemplate>|null */
        public ?array $Templates=null
    ) {
        parent::__construct($Brand,$SelectedUiLanguage,$svSession,$Title,$PageTip,$NewBrowser,$ScanFront400TA,$ScanFront400UTAX);
    }

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

PHP GetTemplates 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 /{Brand}/templates HTTP/1.1 
Host: buildmax.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Template":"String","Brand":"Desktop"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"SelectedUiLanguage":"String","svSession":"String","Title":"String","PageTip":"String","NewBrowser":false,"ScanFront400TA":false,"ScanFront400UTAX":false,"Brand":"Desktop"}