ScannerVision Web Server

<back to all web services

JsonServerInformationRequest

Requires Authentication
namespace ScannerVision.WebService.Json.Dto

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type JsonDto() = 
        class end

    [<AllowNullLiteral>]
    type JsonRequestDto() = 
        inherit JsonDto()
        member val ClientCode:String = null with get,set
        member val ClientRegistrationCode:String = null with get,set
        member val Token:String = null with get,set

    [<AllowNullLiteral>]
    type JsonServerInformationRequest() = 
        inherit JsonRequestDto()
        member val ClientHostName:String = null with get,set
        member val UserName:String = null with get,set
        member val IsPro:Boolean = new Boolean() with get,set
        member val ClientId:String = null with get,set

    [<AllowNullLiteral>]
    type JsonServerInformationResponse() = 
        inherit JsonDto()
        member val ClientIpAddress:String = null with get,set
        member val ClientGuid:String = null with get,set
        member val ClientName:String = null with get,set
        member val ClientId:String = null with get,set
        member val UserHomeFolder:String = null with get,set
        member val UserEmail:String = null with get,set
        member val ServerVersion:String = null with get,set
        member val AllowUpdate:Boolean = new Boolean() with get,set
        member val FtpUsername:String = null with get,set
        member val FtpPassword:String = null with get,set
        member val AdminUsername:String = null with get,set
        member val AdminPassword:String = null with get,set
        member val FtpPort:Int32 = new Int32() with get,set
        member val SupportedDocumentFormats:String[] = [||] with get,set
        member val HpnVersion:String = null with get,set

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