ScannerVision Web Server

GetQuestion

The following routes are available for this service:
GET	/{Brand}/question/{TemplateGuid}/{QuestionGuid}
GET	/{Brand}/question/{TemplateGuid}/{QuestionGuid}/page/{PageNumber}
GET	/{Brand}/question/{TemplateGuid}/{QuestionGuid}/{ParsedRoot}/folder/revisited/{FolderBrowser}
GET	/{Brand}/question/{TemplateGuid}/{QuestionGuid}/{ParsedRoot}/folder/revisited/{FolderBrowser}/page/{PageNumber}
GET	/{Brand}/question/{TemplateGuid}/{QuestionGuid}/{ParsedRoot}/folder/revisited/{FolderBrowser}/search/{SearchTerm}
GET	/{Brand}/question/{TemplateGuid}/{QuestionGuid}/{ParsedRoot}/folder/revisited/{FolderBrowser}/search/{SearchTerm}/page/{PageNumber}

"use strict";
/** @typedef {'Desktop'|'Hp'|'Kyocera'|'NeaScan'|'Samsung'|'FujiXerox'|'Ta'|'Utax'|'Epson'|'ScanFront400'|'Sharp'|'Ricoh'|'FujiFilm'} */
export var Brand;
(function (Brand) {
    Brand["Desktop"] = "Desktop"
    Brand["Hp"] = "Hp"
    Brand["Kyocera"] = "Kyocera"
    Brand["NeaScan"] = "NeaScan"
    Brand["Samsung"] = "Samsung"
    Brand["FujiXerox"] = "FujiXerox"
    Brand["Ta"] = "Ta"
    Brand["Utax"] = "Utax"
    Brand["Epson"] = "Epson"
    Brand["ScanFront400"] = "ScanFront400"
    Brand["Sharp"] = "Sharp"
    Brand["Ricoh"] = "Ricoh"
    Brand["FujiFilm"] = "FujiFilm"
})(Brand || (Brand = {}));
export class DtoBase {
    /** @param {{Brand?:Brand}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Brand} */
    Brand;
}
export class RequestBase extends DtoBase {
    /** @param {{Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class QuestionRequestDto extends RequestBase {
    /** @param {{TemplateGuid?:string,QuestionGuid?:string,Parent?:string,FolderBrowser?:string,Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    TemplateGuid;
    /** @type {string} */
    QuestionGuid;
    /** @type {string} */
    Parent;
    /** @type {string} */
    FolderBrowser;
}
export class GetQuestion extends QuestionRequestDto {
    /** @param {{ParsedRoot?:string,SearchTerm?:string,PageNumber?:number,TemplateGuid?:string,QuestionGuid?:string,Parent?:string,FolderBrowser?:string,Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    ParsedRoot;
    /** @type {string} */
    SearchTerm;
    /** @type {number} */
    PageNumber;
}
export class ResponseBase extends DtoBase {
    /** @param {{SelectedUiLanguage?:string,svSession?:string,Title?:string,PageTip?:string,NewBrowser?:boolean,ScanFront400TA?:boolean,ScanFront400UTAX?:boolean,Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    SelectedUiLanguage;
    /** @type {string} */
    svSession;
    /** @type {string} */
    Title;
    /** @type {string} */
    PageTip;
    /** @type {boolean} */
    NewBrowser;
    /** @type {boolean} */
    ScanFront400TA;
    /** @type {boolean} */
    ScanFront400UTAX;
}
/** @typedef {'Workflow'|'FreeForm'} */
export var TemplateType;
(function (TemplateType) {
    TemplateType["Workflow"] = "Workflow"
    TemplateType["FreeForm"] = "FreeForm"
})(TemplateType || (TemplateType = {}));
/** @typedef {'Interval'|'Fixed'} */
export var TemplateScheduleType;
(function (TemplateScheduleType) {
    TemplateScheduleType["Interval"] = "Interval"
    TemplateScheduleType["Fixed"] = "Fixed"
})(TemplateScheduleType || (TemplateScheduleType = {}));
/** @typedef {'Default'|'Dpi100'|'Dpi150'|'Dpi200'|'Dpi300'|'Dpi400'|'Dpi500'|'Dpi600'} */
export var PdfLoadResolution;
(function (PdfLoadResolution) {
    PdfLoadResolution["Default"] = "Default"
    PdfLoadResolution["Dpi100"] = "Dpi100"
    PdfLoadResolution["Dpi150"] = "Dpi150"
    PdfLoadResolution["Dpi200"] = "Dpi200"
    PdfLoadResolution["Dpi300"] = "Dpi300"
    PdfLoadResolution["Dpi400"] = "Dpi400"
    PdfLoadResolution["Dpi500"] = "Dpi500"
    PdfLoadResolution["Dpi600"] = "Dpi600"
})(PdfLoadResolution || (PdfLoadResolution = {}));
/** @typedef {'FailureOnly'|'SuccessOnly'|'Always'} */
export var NotificationType;
(function (NotificationType) {
    NotificationType["FailureOnly"] = "FailureOnly"
    NotificationType["SuccessOnly"] = "SuccessOnly"
    NotificationType["Always"] = "Always"
})(NotificationType || (NotificationType = {}));
export class ScanResponseBase extends ResponseBase {
    /** @param {{Template?:IClientTemplate,GlobalQuestions?:IClientQuestion[],CanEnableScanButton?:boolean,SelectedUiLanguage?:string,svSession?:string,Title?:string,PageTip?:string,NewBrowser?:boolean,ScanFront400TA?:boolean,ScanFront400UTAX?:boolean,Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {IClientTemplate} */
    Template;
    /** @type {IClientQuestion[]} */
    GlobalQuestions;
    /** @type {boolean} */
    CanEnableScanButton;
}
export class GetQuestionResponse extends ScanResponseBase {
    /** @param {{Question?:IClientQuestion,RegexMatches?:boolean,RegexHint?:string,SelectedFolder?:string,LoggedInUser?:IUser,MetadataParser?:IMetadataParserEx,ParsedRoot?:string,FolderBrowser?:string,Parent?:string,SearchTerm?:string,PageNumber?:number,Template?:IClientTemplate,GlobalQuestions?:IClientQuestion[],CanEnableScanButton?:boolean,SelectedUiLanguage?:string,svSession?:string,Title?:string,PageTip?:string,NewBrowser?:boolean,ScanFront400TA?:boolean,ScanFront400UTAX?:boolean,Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {IClientQuestion} */
    Question;
    /** @type {boolean} */
    RegexMatches;
    /** @type {string} */
    RegexHint;
    /** @type {string} */
    SelectedFolder;
    /** @type {IUser} */
    LoggedInUser;
    /** @type {IMetadataParserEx} */
    MetadataParser;
    /** @type {string} */
    ParsedRoot;
    /** @type {string} */
    FolderBrowser;
    /** @type {string} */
    Parent;
    /** @type {string} */
    SearchTerm;
    /** @type {?number} */
    PageNumber;
}

JavaScript GetQuestion 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}/question/{TemplateGuid}/{QuestionGuid} HTTP/1.1 
Host: buildmax.org 
Accept: application/json

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

{"RegexMatches":false,"RegexHint":"String","SelectedFolder":"String","ParsedRoot":"String","FolderBrowser":"String","Parent":"String","SearchTerm":"String","PageNumber":0,"CanEnableScanButton":true,"SelectedUiLanguage":"String","svSession":"String","Title":"String","PageTip":"String","NewBrowser":false,"ScanFront400TA":false,"ScanFront400UTAX":false,"Brand":"Desktop"}