ScannerVision Web Server

<back to all web services

JsonServerInformationRequest

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

public class dtos
{

    public static class JsonServerInformationRequest extends JsonRequestDto
    {
        public String ClientHostName = null;
        public String UserName = null;
        public Boolean IsPro = null;
        public String ClientId = null;
        
        public String getClientHostName() { return ClientHostName; }
        public JsonServerInformationRequest setClientHostName(String value) { this.ClientHostName = value; return this; }
        public String getUserName() { return UserName; }
        public JsonServerInformationRequest setUserName(String value) { this.UserName = value; return this; }
        public Boolean getIsPro() { return IsPro; }
        public JsonServerInformationRequest setIsPro(Boolean value) { this.IsPro = value; return this; }
        public String getClientId() { return ClientId; }
        public JsonServerInformationRequest setClientId(String value) { this.ClientId = value; return this; }
    }

    public static class JsonRequestDto extends JsonDto
    {
        public String ClientCode = null;
        public String ClientRegistrationCode = null;
        public String Token = null;
        
        public String getClientCode() { return ClientCode; }
        public JsonRequestDto setClientCode(String value) { this.ClientCode = value; return this; }
        public String getClientRegistrationCode() { return ClientRegistrationCode; }
        public JsonRequestDto setClientRegistrationCode(String value) { this.ClientRegistrationCode = value; return this; }
        public String getToken() { return Token; }
        public JsonRequestDto setToken(String value) { this.Token = value; return this; }
    }

    public static class JsonDto
    {
        
    }

    public static class JsonServerInformationResponse extends JsonDto
    {
        public String ClientIpAddress = null;
        public String ClientGuid = null;
        public String ClientName = null;
        public String ClientId = null;
        public String UserHomeFolder = null;
        public String UserEmail = null;
        public String ServerVersion = null;
        public Boolean AllowUpdate = null;
        public String FtpUsername = null;
        public String FtpPassword = null;
        public String AdminUsername = null;
        public String AdminPassword = null;
        public Integer FtpPort = null;
        public ArrayList<String> SupportedDocumentFormats = null;
        public String HpnVersion = null;
        
        public String getClientIpAddress() { return ClientIpAddress; }
        public JsonServerInformationResponse setClientIpAddress(String value) { this.ClientIpAddress = value; return this; }
        public String getClientGuid() { return ClientGuid; }
        public JsonServerInformationResponse setClientGuid(String value) { this.ClientGuid = value; return this; }
        public String getClientName() { return ClientName; }
        public JsonServerInformationResponse setClientName(String value) { this.ClientName = value; return this; }
        public String getClientId() { return ClientId; }
        public JsonServerInformationResponse setClientId(String value) { this.ClientId = value; return this; }
        public String getUserHomeFolder() { return UserHomeFolder; }
        public JsonServerInformationResponse setUserHomeFolder(String value) { this.UserHomeFolder = value; return this; }
        public String getUserEmail() { return UserEmail; }
        public JsonServerInformationResponse setUserEmail(String value) { this.UserEmail = value; return this; }
        public String getServerVersion() { return ServerVersion; }
        public JsonServerInformationResponse setServerVersion(String value) { this.ServerVersion = value; return this; }
        public Boolean isAllowUpdate() { return AllowUpdate; }
        public JsonServerInformationResponse setAllowUpdate(Boolean value) { this.AllowUpdate = value; return this; }
        public String getFtpUsername() { return FtpUsername; }
        public JsonServerInformationResponse setFtpUsername(String value) { this.FtpUsername = value; return this; }
        public String getFtpPassword() { return FtpPassword; }
        public JsonServerInformationResponse setFtpPassword(String value) { this.FtpPassword = value; return this; }
        public String getAdminUsername() { return AdminUsername; }
        public JsonServerInformationResponse setAdminUsername(String value) { this.AdminUsername = value; return this; }
        public String getAdminPassword() { return AdminPassword; }
        public JsonServerInformationResponse setAdminPassword(String value) { this.AdminPassword = value; return this; }
        public Integer getFtpPort() { return FtpPort; }
        public JsonServerInformationResponse setFtpPort(Integer value) { this.FtpPort = value; return this; }
        public ArrayList<String> getSupportedDocumentFormats() { return SupportedDocumentFormats; }
        public JsonServerInformationResponse setSupportedDocumentFormats(ArrayList<String> value) { this.SupportedDocumentFormats = value; return this; }
        public String getHpnVersion() { return HpnVersion; }
        public JsonServerInformationResponse setHpnVersion(String value) { this.HpnVersion = value; return this; }
    }

}

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