ScannerVision Web Server

<back to all web services

JsonRegisterClientRequest

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 JsonRegisterClientRequest() = 
        inherit JsonRequestDto()

    type RegistrationResult =
        | Success = 0
        | ClientCodeNotFound = 1
        | ClientAlreadyRegistered = 2
        | Error = 3

    [<AllowNullLiteral>]
    type JsonRegisterClientResponse() = 
        inherit JsonDto()
        member val Result:RegistrationResult = new RegistrationResult() with get,set
        member val ErrorMessage:String = null with get,set
        member val ClientRegistrationCode:String = null with get,set

F# JsonRegisterClientRequest 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/JsonRegisterClientRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientCode: String,
	ClientRegistrationCode: String,
	Token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Result: Success,
	ErrorMessage: String,
	ClientRegistrationCode: String
}