ScannerVision Web Server

PostQuestion

The following routes are available for this service:
POST	/{Brand}/question/{TemplateGuid}/{QuestionGuid}

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 QuestionRequestDto(RequestBase):
    template_guid: Optional[str] = None
    question_guid: Optional[str] = None
    parent: Optional[str] = None
    folder_browser: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostQuestion(QuestionRequestDto):
    question_value_returned: Optional[str] = None
    question_value_displayed: Optional[str] = None
    selected_folder: Optional[str] = None

Python PostQuestion DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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
}