ScannerVision Web Server

JsonServerInformationRequest


export class JsonDto
{

    public constructor(init?: Partial<JsonDto>) { (Object as any).assign(this, init); }
}

export class JsonRequestDto extends JsonDto
{
    public ClientCode: string;
    public ClientRegistrationCode: string;
    public Token: string;

    public constructor(init?: Partial<JsonRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export class JsonServerInformationRequest extends JsonRequestDto
{
    public ClientHostName: string;
    public UserName: string;
    public IsPro: boolean;
    public ClientId: string;

    public constructor(init?: Partial<JsonServerInformationRequest>) { super(init); (Object as any).assign(this, init); }
}

export class JsonServerInformationResponse extends JsonDto
{
    public ClientIpAddress: string;
    public ClientGuid: string;
    public ClientName: string;
    public ClientId: string;
    public UserHomeFolder: string;
    public UserEmail: string;
    public ServerVersion: string;
    public AllowUpdate: boolean;
    public FtpUsername: string;
    public FtpPassword: string;
    public AdminUsername: string;
    public AdminPassword: string;
    public FtpPort: number;
    public SupportedDocumentFormats: string[];
    public HpnVersion: string;

    public constructor(init?: Partial<JsonServerInformationResponse>) { super(init); (Object as any).assign(this, init); }
}

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