ScannerVision Web Server

<back to all web services

JsonFileUploadRequest

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 JsonFileUploadResponse extends JsonDto {
    /** @param {{ErrorMessage?:string,InError?:boolean,TemplateGuid?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    ErrorMessage;
    /** @type {boolean} */
    InError;
    /** @type {string} */
    TemplateGuid;
}
export class JsonFileUploadRequest extends JsonRequestDto {
    /** @param {{FileName?:string,RequestStream?:string,TemplateGuid?:string,ClientCode?:string,ClientRegistrationCode?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    FileName;
    /** @type {string} */
    RequestStream;
    /** @type {string} */
    TemplateGuid;
}

JavaScript JsonFileUploadRequest DTOs

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

HTTP + JSV

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

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

{
	FileName: String,
	TemplateGuid: String,
	ClientCode: String,
	ClientRegistrationCode: String,
	Token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorMessage: String,
	InError: False,
	TemplateGuid: String
}