ScannerVision Web Server

<back to all web services

JsonServerInformationRequest

Requires Authentication
JsonServerInformationRequest Parameters:
NameParameterData TypeRequiredDescription
ClientHostNamequerystringNo
UserNamequerystringNo
IsProqueryboolNo
ClientIdquerystringNo
JsonRequestDto Parameters:
NameParameterData TypeRequiredDescription
ClientCodeformstringNo
ClientRegistrationCodeformstringNo
TokenformstringNo
JsonServerInformationResponse Parameters:
NameParameterData TypeRequiredDescription
ClientIpAddressformstringNo
ClientGuidformstringNo
ClientNameformstringNo
ClientIdformstringNo
UserHomeFolderformstringNo
UserEmailformstringNo
ServerVersionformstringNo
AllowUpdateformboolNo
FtpUsernameformstringNo
FtpPasswordformstringNo
AdminUsernameformstringNo
AdminPasswordformstringNo
FtpPortformintNo
SupportedDocumentFormatsformstring[]No
HpnVersionformstringNo

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
}