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 .xml suffix or ?format=xml

HTTP + 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>