ScannerVision Web Server

<back to all web services

JsonServerInformationRequest

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JsonDto:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JsonRequestDto(JsonDto):
    client_code: Optional[str] = None
    client_registration_code: Optional[str] = None
    token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JsonServerInformationRequest(JsonRequestDto):
    client_host_name: Optional[str] = None
    user_name: Optional[str] = None
    is_pro: bool = False
    client_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JsonServerInformationResponse(JsonDto):
    client_ip_address: Optional[str] = None
    client_guid: Optional[str] = None
    client_name: Optional[str] = None
    client_id: Optional[str] = None
    user_home_folder: Optional[str] = None
    user_email: Optional[str] = None
    server_version: Optional[str] = None
    allow_update: bool = False
    ftp_username: Optional[str] = None
    ftp_password: Optional[str] = None
    admin_username: Optional[str] = None
    admin_password: Optional[str] = None
    ftp_port: int = 0
    supported_document_formats: Optional[List[str]] = None
    hpn_version: Optional[str] = None

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