ScannerVision Web Server

<back to all web services

WebClientPicklistRequest

Requires Authentication
The following routes are available for this service:
GET/{Brand}/browse/{TemplateGuid}/{QuestionGuid}/{PicklistGuid}/
GET/{Brand}/browse/{TemplateGuid}/{QuestionGuid}/{PicklistGuid}/search/{SearchTerm}
GET/{Brand}/browse/{TemplateGuid}/{QuestionGuid}/{PicklistGuid}/{Path}
GET/{Brand}/browse/{TemplateGuid}/{QuestionGuid}/{PicklistGuid}/{Path}/search/{SearchTerm}
All Verbs/{Brand}/browse/{BrowseType}/
All Verbs/{Brand}/browse/{BrowseType}/
All Verbs/{Brand}/browse/{BrowseType}/{Path}
All Verbs/{Brand}/browse/{BrowseType}/{Path}
"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 BrowseRequest extends RequestBase {
    /** @param {{Path?:string,Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Path;
}
export class BrowsePicklistRequest extends BrowseRequest {
    /** @param {{PicklistGuid?:string,Answers?:{ [index: string]: string; },Path?:string,Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    PicklistGuid;
    /** @type {{ [index: string]: string; }} */
    Answers;
}
export class WebClientPicklistRequest extends BrowsePicklistRequest {
    /** @param {{TemplateGuid?:string,QuestionGuid?:string,SearchTerm?:string,PicklistGuid?:string,Answers?:{ [index: string]: string; },Path?:string,Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    TemplateGuid;
    /** @type {string} */
    QuestionGuid;
    /** @type {string} */
    SearchTerm;
}

JavaScript WebClientPicklistRequest DTOs

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

HTTP + CSV

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

POST /{Brand}/browse/{BrowseType}/ HTTP/1.1 
Host: buildmax.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"TemplateGuid":"String","QuestionGuid":"String","SearchTerm":"String","PicklistGuid":"String","Path":"String","Brand":"Desktop"}