ScannerVision Web Server

<back to all web services

JsonBrowsePicklistRequest

Requires Authentication
"use strict";
export class JsonDto {
    constructor(init) { Object.assign(this, init) }
}
export class JsonRequestDto extends JsonDto {
    /** @param {{ClientCode?:string,ClientRegistrationCode?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    ClientCode;
    /** @type {string} */
    ClientRegistrationCode;
    /** @type {string} */
    Token;
}
export class JsonBrowseRequest extends JsonRequestDto {
    /** @param {{Path?:string,ClientCode?:string,ClientRegistrationCode?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Path;
}
export class JsonBrowsePicklistRequest extends JsonBrowseRequest {
    /** @param {{TemplateGuid?:string,PicklistGuid?:string,Answers?:{ [index: string]: string; },Path?:string,ClientCode?:string,ClientRegistrationCode?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    TemplateGuid;
    /** @type {string} */
    PicklistGuid;
    /** @type {{ [index: string]: string; }} */
    Answers;
}
export class JsonBrowseResponse {
    /** @param {{Path?:string,Folders?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Path;
    /** @type {string[]} */
    Folders;
}

JavaScript JsonBrowsePicklistRequest 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 /csv/reply/JsonBrowsePicklistRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"TemplateGuid":"String","PicklistGuid":"String","Path":"String","ClientCode":"String","ClientRegistrationCode":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Path":"String","Folders":["String"]}