ScannerVision Web Server

<back to all web services

JsonServerInformationRequest

Requires Authentication
import java.math.*
import java.util.*
import net.servicestack.client.*


open class JsonServerInformationRequest : JsonRequestDto()
{
    var ClientHostName:String? = null
    var UserName:String? = null
    var IsPro:Boolean? = null
    var ClientId:String? = null
}

open class JsonRequestDto : JsonDto()
{
    var ClientCode:String? = null
    var ClientRegistrationCode:String? = null
    var Token:String? = null
}

open class JsonDto
{
}

open class JsonServerInformationResponse : JsonDto()
{
    var ClientIpAddress:String? = null
    var ClientGuid:String? = null
    var ClientName:String? = null
    var ClientId:String? = null
    var UserHomeFolder:String? = null
    var UserEmail:String? = null
    var ServerVersion:String? = null
    var AllowUpdate:Boolean? = null
    var FtpUsername:String? = null
    var FtpPassword:String? = null
    var AdminUsername:String? = null
    var AdminPassword:String? = null
    var FtpPort:Int? = null
    var SupportedDocumentFormats:ArrayList<String>? = null
    var HpnVersion:String? = null
}

Kotlin 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
}