ScannerVision Web Server

GetFile

The following routes are available for this service:
All Verbs	/{Brand}/files/{FileName}

"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 GetFile extends RequestBase {
    /** @param {{FileName?:string,Brand?:Brand}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    FileName;
}

JavaScript GetFile DTOs

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

HTTP + XML

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

POST /{Brand}/files/{FileName} HTTP/1.1 
Host: buildmax.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.ServiceModel">
  <Brand>Desktop</Brand>
  <FileName>String</FileName>
</GetFile>