FrameAppWS

<back to all web services

RegisterCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/register
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 CoreRS:
    code: Optional[str] = None
    error_message: Optional[str] = None
    error_stack_trace: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegisterCitizenRS(CoreRS):
    data: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegisterCitizenRQ:
    id: Optional[str] = None
    email: Optional[str] = None
    display_name: Optional[str] = None
    phone_number: Optional[str] = None
    provider: Optional[int] = None
    provider_id: Optional[str] = None
    mobile_id: Optional[str] = None
    mobile_o_s: Optional[str] = None
    password: Optional[str] = None
    created_user: Optional[str] = None

Python RegisterCitizenRQ 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 /citizen/register HTTP/1.1 
Host: ws.jimsnwa.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Email: String,
	DisplayName: String,
	PhoneNumber: String,
	Provider: 0,
	ProviderId: String,
	MobileId: String,
	MobileOS: String,
	Password: String,
	CreatedUser: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: String,
	Code: String,
	ErrorMessage: String,
	ErrorStackTrace: String
}