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}

export enum Brand
{
    Desktop = 'Desktop',
    Hp = 'Hp',
    Kyocera = 'Kyocera',
    NeaScan = 'NeaScan',
    Samsung = 'Samsung',
    FujiXerox = 'FujiXerox',
    Ta = 'Ta',
    Utax = 'Utax',
    Epson = 'Epson',
    ScanFront400 = 'ScanFront400',
    Sharp = 'Sharp',
    Ricoh = 'Ricoh',
    FujiFilm = 'FujiFilm',
}

export class DtoBase
{
    public Brand: Brand;

    public constructor(init?: Partial<DtoBase>) { (Object as any).assign(this, init); }
}

export class RequestBase extends DtoBase
{

    public constructor(init?: Partial<RequestBase>) { super(init); (Object as any).assign(this, init); }
}

export class BrowseRequest extends RequestBase
{
    public Path: string;

    public constructor(init?: Partial<BrowseRequest>) { super(init); (Object as any).assign(this, init); }
}

export class BrowsePicklistRequest extends BrowseRequest
{
    public PicklistGuid: string;
    public Answers: { [index: string]: string; };

    public constructor(init?: Partial<BrowsePicklistRequest>) { super(init); (Object as any).assign(this, init); }
}

export class WebClientPicklistRequest extends BrowsePicklistRequest
{
    public TemplateGuid: string;
    public QuestionGuid: string;
    public SearchTerm: string;

    public constructor(init?: Partial<WebClientPicklistRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript WebClientPicklistRequest 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.

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

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