ScannerVision Web Server

<back to all web services

JsonRegisterClientRequest

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 JsonRegisterClientRequest
        : JsonRequestDto
    {
    }

    public partial class JsonRegisterClientResponse
        : JsonDto
    {
        public virtual RegistrationResult Result { get; set; }
        public virtual string ErrorMessage { get; set; }
        public virtual string ClientRegistrationCode { get; set; }
        public enum RegistrationResult
        {
            Success,
            ClientCodeNotFound,
            ClientAlreadyRegistered,
            Error,
        }

    }

    public partial class JsonRequestDto
        : JsonDto
    {
        public virtual string ClientCode { get; set; }
        public virtual string ClientRegistrationCode { get; set; }
        public virtual string Token { get; set; }
    }

}

C# 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
}