ScannerVision Web Server

<back to all web services

JsonServerInformationRequest

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

Namespace Global

    Namespace ScannerVision.WebService.Json.Dto

        Public Partial Class JsonDto
        End Class

        Public Partial Class JsonRequestDto
            Inherits JsonDto
            Public Overridable Property ClientCode As String
            Public Overridable Property ClientRegistrationCode As String
            Public Overridable Property Token As String
        End Class

        Public Partial Class JsonServerInformationRequest
            Inherits JsonRequestDto
            Public Overridable Property ClientHostName As String
            Public Overridable Property UserName As String
            Public Overridable Property IsPro As Boolean
            Public Overridable Property ClientId As String
        End Class

        Public Partial Class JsonServerInformationResponse
            Inherits JsonDto
            Public Sub New()
                SupportedDocumentFormats = New String(){}
            End Sub

            Public Overridable Property ClientIpAddress As String
            Public Overridable Property ClientGuid As String
            Public Overridable Property ClientName As String
            Public Overridable Property ClientId As String
            Public Overridable Property UserHomeFolder As String
            Public Overridable Property UserEmail As String
            Public Overridable Property ServerVersion As String
            Public Overridable Property AllowUpdate As Boolean
            Public Overridable Property FtpUsername As String
            Public Overridable Property FtpPassword As String
            Public Overridable Property AdminUsername As String
            Public Overridable Property AdminPassword As String
            Public Overridable Property FtpPort As Integer
            Public Overridable Property SupportedDocumentFormats As String()
            Public Overridable Property HpnVersion As String
        End Class
    End Namespace
End Namespace

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