ScannerVision Web Server

JsonMetadataUploadRequest

"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 JsonMetadataUploadRequest extends JsonRequestDto {
    /** @param {{UploadFileName?:string,OriginalFileName?:string,TemplateGuid?:string,ClientIpAddress?:string,ClientGuid?:string,ClientName?:string,ClientId?:string,ClientSerialNumber?:string,UserName?:string,UserEmail?:string,UserHomeFolder?:string,TemplateQuestions?:{ [index: string]: string; },GlobalQuestions?:{ [index: string]: string; },ClientCode?:string,ClientRegistrationCode?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    UploadFileName;
    /** @type {string} */
    OriginalFileName;
    /** @type {string} */
    TemplateGuid;
    /** @type {string} */
    ClientIpAddress;
    /** @type {string} */
    ClientGuid;
    /** @type {string} */
    ClientName;
    /** @type {string} */
    ClientId;
    /** @type {string} */
    ClientSerialNumber;
    /** @type {string} */
    UserName;
    /** @type {string} */
    UserEmail;
    /** @type {string} */
    UserHomeFolder;
    /** @type {{ [index: string]: string; }} */
    TemplateQuestions;
    /** @type {{ [index: string]: string; }} */
    GlobalQuestions;
}
export class JsonMetadataUploadResponse extends JsonDto {
    /** @param {{TemplateGuid?:string,InError?:boolean,ErrorMessage?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    TemplateGuid;
    /** @type {boolean} */
    InError;
    /** @type {string} */
    ErrorMessage;
}

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

<JsonMetadataUploadRequest 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>
  <ClientGuid>String</ClientGuid>
  <ClientId>String</ClientId>
  <ClientIpAddress>String</ClientIpAddress>
  <ClientName>String</ClientName>
  <ClientSerialNumber>String</ClientSerialNumber>
  <GlobalQuestions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <OriginalFileName>String</OriginalFileName>
  <TemplateGuid>String</TemplateGuid>
  <TemplateQuestions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <UploadFileName>String</UploadFileName>
  <UserEmail>String</UserEmail>
  <UserHomeFolder>String</UserHomeFolder>
  <UserName>String</UserName>
</JsonMetadataUploadRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JsonMetadataUploadResponse 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>
</JsonMetadataUploadResponse>