ScannerVision Web Server

UploadedRequest

The following routes are available for this service:
GET	/{Brand}/uploaded/{TemplateGuid}/
GET	/{Brand}/uploaded/{TemplateGuid}/{FileNameGuid}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class Brand(str, Enum):
    DESKTOP = 'Desktop'
    HP = 'Hp'
    KYOCERA = 'Kyocera'
    NEA_SCAN = 'NeaScan'
    SAMSUNG = 'Samsung'
    FUJI_XEROX = 'FujiXerox'
    TA = 'Ta'
    UTAX = 'Utax'
    EPSON = 'Epson'
    SCAN_FRONT400 = 'ScanFront400'
    SHARP = 'Sharp'
    RICOH = 'Ricoh'
    FUJI_FILM = 'FujiFilm'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DtoBase:
    brand: Optional[Brand] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RequestBase(DtoBase):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadedRequest(RequestBase):
    template_guid: Optional[str] = None
    file_name_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseBase(DtoBase):
    selected_ui_language: Optional[str] = None
    sv_session: Optional[str] = None
    title: Optional[str] = None
    page_tip: Optional[str] = None
    new_browser: bool = False
    scan_front400_t_a: bool = False
    scan_front400_u_t_a_x: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadResponse(ResponseBase):
    in_error: bool = False
    error_message: Optional[str] = None
    template_guid: Optional[str] = None

Python UploadedRequest 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.

GET /{Brand}/uploaded/{TemplateGuid}/ HTTP/1.1 
Host: buildmax.org 
Accept: application/json

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

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