FrameAppWS

<back to all web services

UpdateCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/update
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 Citizen:
    email: Optional[str] = None
    display_name: Optional[str] = None
    avatar: Optional[str] = None
    theme: Optional[str] = None
    phone_number: Optional[str] = None
    provider: Optional[int] = None
    provider_id: Optional[str] = None
    password: Optional[str] = None
    banned: Optional[str] = None
    status: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateCitizenRQ:
    email: Optional[str] = None
    display_name: Optional[str] = None
    avatar: Optional[str] = None
    theme: Optional[str] = None
    phone_number: Optional[str] = None
    current_password: Optional[str] = None
    password: Optional[str] = None

Python UpdateCitizenRQ DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /citizen/update HTTP/1.1 
Host: ws.jimsnwa.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Email":"String","DisplayName":"String","Avatar":"String","Theme":"String","PhoneNumber":"String","CurrentPassword":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Data":{"Email":"String","DisplayName":"String","Avatar":"String","Theme":"String","PhoneNumber":"String","Provider":0,"ProviderId":"String","Password":"String","Banned":"String","Status":"String"},"Code":"String","ErrorMessage":"String","ErrorStackTrace":"String"}