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