ScannerVision Web Server

<back to all web services

JsonServerInformationRequest

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 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 .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/JsonServerInformationRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientHostName: String,
	UserName: String,
	IsPro: False,
	ClientId: String,
	ClientCode: String,
	ClientRegistrationCode: String,
	Token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ClientIpAddress: String,
	ClientGuid: String,
	ClientName: String,
	ClientId: String,
	UserHomeFolder: String,
	UserEmail: String,
	ServerVersion: String,
	AllowUpdate: False,
	FtpUsername: String,
	FtpPassword: String,
	AdminUsername: String,
	AdminPassword: String,
	FtpPort: 0,
	SupportedDocumentFormats: 
	[
		String
	],
	HpnVersion: String
}