| All Verbs | /citizen/authenticate |
|---|
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 AuthenticateCitizenRQ:
email: Optional[str] = None
password: Optional[str] = None
provider: Optional[int] = None
display_name: Optional[str] = None
phone_number: Optional[str] = None
provider_id: Optional[str] = None
mobile_id: Optional[str] = None
mobile_o_s: Optional[str] = None
created_user: Optional[str] = None
Python AuthenticateCitizenRQ DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /citizen/authenticate HTTP/1.1
Host: ws.jimsnwa.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AuthenticateCitizenRQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.citizen">
<CreatedUser>String</CreatedUser>
<DisplayName>String</DisplayName>
<Email>String</Email>
<MobileId>String</MobileId>
<MobileOS>String</MobileOS>
<Password>String</Password>
<PhoneNumber>String</PhoneNumber>
<Provider>0</Provider>
<ProviderId>String</ProviderId>
</AuthenticateCitizenRQ>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AuthenticateCitizenRS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.citizen">
<Code xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</Code>
<ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</ErrorMessage>
<ErrorStackTrace xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</ErrorStackTrace>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nwa.Model.Contexto.nwa.citizen">
<d2p1:Avatar>String</d2p1:Avatar>
<d2p1:Banned>String</d2p1:Banned>
<d2p1:DisplayName>String</d2p1:DisplayName>
<d2p1:Email>String</d2p1:Email>
<d2p1:Password>String</d2p1:Password>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:Provider>0</d2p1:Provider>
<d2p1:ProviderId>String</d2p1:ProviderId>
<d2p1:Status>String</d2p1:Status>
<d2p1:Theme>String</d2p1:Theme>
</Data>
</AuthenticateCitizenRS>