ScannerVision Web Server

<back to all web services

JsonServerInformationRequest

Requires Authentication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ScannerVision.WebService.Json.Dto;

namespace ScannerVision.WebService.Json.Dto
{
    public partial class JsonDto
    {
    }

    public partial class JsonRequestDto
        : JsonDto
    {
        public virtual string ClientCode { get; set; }
        public virtual string ClientRegistrationCode { get; set; }
        public virtual string Token { get; set; }
    }

    public partial class JsonServerInformationRequest
        : JsonRequestDto
    {
        public virtual string ClientHostName { get; set; }
        public virtual string UserName { get; set; }
        public virtual bool IsPro { get; set; }
        public virtual string ClientId { get; set; }
    }

    public partial class JsonServerInformationResponse
        : JsonDto
    {
        public JsonServerInformationResponse()
        {
            SupportedDocumentFormats = new string[]{};
        }

        public virtual string ClientIpAddress { get; set; }
        public virtual string ClientGuid { get; set; }
        public virtual string ClientName { get; set; }
        public virtual string ClientId { get; set; }
        public virtual string UserHomeFolder { get; set; }
        public virtual string UserEmail { get; set; }
        public virtual string ServerVersion { get; set; }
        public virtual bool AllowUpdate { get; set; }
        public virtual string FtpUsername { get; set; }
        public virtual string FtpPassword { get; set; }
        public virtual string AdminUsername { get; set; }
        public virtual string AdminPassword { get; set; }
        public virtual int FtpPort { get; set; }
        public virtual string[] SupportedDocumentFormats { get; set; }
        public virtual string HpnVersion { get; set; }
    }

}

C# 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>