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 .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/JsonRegisterClientRequest HTTP/1.1 
Host: buildmax.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JsonRegisterClientRequest 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>
</JsonRegisterClientRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JsonRegisterClientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ClientRegistrationCode>String</ClientRegistrationCode>
  <ErrorMessage>String</ErrorMessage>
  <Result>Success</Result>
</JsonRegisterClientResponse>