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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/JsonServerInformationRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/csv
Content-Type: text/csv
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/csv
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"}