ScannerVision Web Server

<back to all web services

JsonRegisterClientRequest

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JsonDto:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JsonRequestDto(JsonDto):
    client_code: Optional[str] = None
    client_registration_code: Optional[str] = None
    token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JsonRegisterClientRequest(JsonRequestDto):
    pass


class RegistrationResult(str, Enum):
    SUCCESS = 'Success'
    CLIENT_CODE_NOT_FOUND = 'ClientCodeNotFound'
    CLIENT_ALREADY_REGISTERED = 'ClientAlreadyRegistered'
    ERROR = 'Error'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JsonRegisterClientResponse(JsonDto):
    result: Optional[RegistrationResult] = None
    error_message: Optional[str] = None
    client_registration_code: Optional[str] = None

Python 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
}