ScannerVision Web Server

<back to all web services

GetJsonTemplateRequest

"use strict";
export class JsonDto {
    constructor(init) { Object.assign(this, init) }
}
export class GetJsonTemplateRequest extends JsonDto {
    /** @param {{Guid?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Guid;
}
export class JsonScanSettings {
    /** @param {{ScanType?:string,ScanTypeLocked?:boolean,ScanColour?:string,ScanColourLocked?:boolean,ScanResolution?:string,ScanResolutionLocked?:boolean,ScanSide?:string,ScanSideLocked?:boolean,ScanSize?:string,ScanSizeLocked?:boolean,ScanOrientation?:string,ScanOrientationLocked?:boolean,ScanSource?:string,ScanSourceLocked?:boolean,ScanContinuously?:boolean,ScanContinuouslyLocked?:boolean,IsMixedSizes?:boolean,IsMixedSizesLocked?:boolean,MinimumPageCount?:number,MaximumPageCount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ScanType;
    /** @type {boolean} */
    ScanTypeLocked;
    /** @type {string} */
    ScanColour;
    /** @type {boolean} */
    ScanColourLocked;
    /** @type {string} */
    ScanResolution;
    /** @type {boolean} */
    ScanResolutionLocked;
    /** @type {string} */
    ScanSide;
    /** @type {boolean} */
    ScanSideLocked;
    /** @type {string} */
    ScanSize;
    /** @type {boolean} */
    ScanSizeLocked;
    /** @type {string} */
    ScanOrientation;
    /** @type {boolean} */
    ScanOrientationLocked;
    /** @type {string} */
    ScanSource;
    /** @type {boolean} */
    ScanSourceLocked;
    /** @type {boolean} */
    ScanContinuously;
    /** @type {boolean} */
    ScanContinuouslyLocked;
    /** @type {boolean} */
    IsMixedSizes;
    /** @type {boolean} */
    IsMixedSizesLocked;
    /** @type {number} */
    MinimumPageCount;
    /** @type {number} */
    MaximumPageCount;
}
export class JsonTemplate {
    /** @param {{Name?:string,Description?:string,Guid?:string,TemplateModificationDate?:string,IconModificationDate?:string,Icon?:string,TemplateQuestions?:JsonQuestion[],GlobalQuestions?:JsonQuestion[],ScanSettings?:JsonScanSettings}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    Guid;
    /** @type {string} */
    TemplateModificationDate;
    /** @type {string} */
    IconModificationDate;
    /** @type {string} */
    Icon;
    /** @type {JsonQuestion[]} */
    TemplateQuestions;
    /** @type {JsonQuestion[]} */
    GlobalQuestions;
    /** @type {JsonScanSettings} */
    ScanSettings;
}
export class GetJsonTemplateResponse extends JsonDto {
    /** @param {{Template?:JsonTemplate}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {JsonTemplate} */
    Template;
}
/** @typedef {'Edit'|'List'|'EditList'|'Browse'|'Password'|'Date'|'Time'|'Boolean'|'Integer'|'Double'|'BrowseList'} */
export var QuestionType;
(function (QuestionType) {
    QuestionType["Edit"] = "Edit"
    QuestionType["List"] = "List"
    QuestionType["EditList"] = "EditList"
    QuestionType["Browse"] = "Browse"
    QuestionType["Password"] = "Password"
    QuestionType["Date"] = "Date"
    QuestionType["Time"] = "Time"
    QuestionType["Boolean"] = "Boolean"
    QuestionType["Integer"] = "Integer"
    QuestionType["Double"] = "Double"
    QuestionType["BrowseList"] = "BrowseList"
})(QuestionType || (QuestionType = {}));
export class JsonQuestion {
    /** @param {{PlQuestionType?:QuestionType,Question?:string,TagName?:string,Default?:string,ToolTip?:string,SampleValue?:string,Regex?:string,Minimum?:number,Maximum?:number,Required?:boolean,Dynamic?:boolean,PicklistGuid?:string,TemplateGuid?:string,HideDefaultValue?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {QuestionType} */
    PlQuestionType;
    /** @type {string} */
    Question;
    /** @type {string} */
    TagName;
    /** @type {string} */
    Default;
    /** @type {string} */
    ToolTip;
    /** @type {string} */
    SampleValue;
    /** @type {string} */
    Regex;
    /** @type {number} */
    Minimum;
    /** @type {number} */
    Maximum;
    /** @type {boolean} */
    Required;
    /** @type {boolean} */
    Dynamic;
    /** @type {string} */
    PicklistGuid;
    /** @type {string} */
    TemplateGuid;
    /** @type {boolean} */
    HideDefaultValue;
}

JavaScript GetJsonTemplateRequest DTOs

POST /csv/reply/GetJsonTemplateRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Guid":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'GetJsonTemplateResponse' using the custom 'csv' filter}No parameterless constructor defined for this object.