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 .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 /xml/reply/JsonFileUploadRequest HTTP/1.1 
Host: buildmax.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JsonFileUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ClientCode>String</ClientCode>
  <ClientRegistrationCode>String</ClientRegistrationCode>
  <Token>String</Token>
  <FileName>String</FileName>
  <RequestStream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
  <TemplateGuid>String</TemplateGuid>
</JsonFileUploadRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JsonFileUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ErrorMessage>String</ErrorMessage>
  <InError>false</InError>
  <TemplateGuid>String</TemplateGuid>
</JsonFileUploadResponse>