"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 JsonServerInformationRequest extends JsonRequestDto {
/** @param {{ClientHostName?:string,UserName?:string,IsPro?:boolean,ClientId?:string,ClientCode?:string,ClientRegistrationCode?:string,Token?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
ClientHostName;
/** @type {string} */
UserName;
/** @type {boolean} */
IsPro;
/** @type {string} */
ClientId;
}
export class JsonServerInformationResponse extends JsonDto {
/** @param {{ClientIpAddress?:string,ClientGuid?:string,ClientName?:string,ClientId?:string,UserHomeFolder?:string,UserEmail?:string,ServerVersion?:string,AllowUpdate?:boolean,FtpUsername?:string,FtpPassword?:string,AdminUsername?:string,AdminPassword?:string,FtpPort?:number,SupportedDocumentFormats?:string[],HpnVersion?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
ClientIpAddress;
/** @type {string} */
ClientGuid;
/** @type {string} */
ClientName;
/** @type {string} */
ClientId;
/** @type {string} */
UserHomeFolder;
/** @type {string} */
UserEmail;
/** @type {string} */
ServerVersion;
/** @type {boolean} */
AllowUpdate;
/** @type {string} */
FtpUsername;
/** @type {string} */
FtpPassword;
/** @type {string} */
AdminUsername;
/** @type {string} */
AdminPassword;
/** @type {number} */
FtpPort;
/** @type {string[]} */
SupportedDocumentFormats;
/** @type {string} */
HpnVersion;
}
JavaScript JsonServerInformationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/JsonServerInformationRequest HTTP/1.1
Host: buildmax.org
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<JsonServerInformationRequest 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>
<ClientHostName>String</ClientHostName>
<ClientId>String</ClientId>
<IsPro>false</IsPro>
<UserName>String</UserName>
</JsonServerInformationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<JsonServerInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
<AdminPassword>String</AdminPassword>
<AdminUsername>String</AdminUsername>
<AllowUpdate>false</AllowUpdate>
<ClientGuid>String</ClientGuid>
<ClientId>String</ClientId>
<ClientIpAddress>String</ClientIpAddress>
<ClientName>String</ClientName>
<FtpPassword>String</FtpPassword>
<FtpPort>0</FtpPort>
<FtpUsername>String</FtpUsername>
<HpnVersion>String</HpnVersion>
<ServerVersion>String</ServerVersion>
<SupportedDocumentFormats xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SupportedDocumentFormats>
<UserEmail>String</UserEmail>
<UserHomeFolder>String</UserHomeFolder>
</JsonServerInformationResponse>