ScannerVision Web Server

JsonRegisterClientRequest

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 .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>