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 .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>