FrameAppWS

<back to all web services

AuthenticateCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/authenticate
import java.math.*
import java.util.*
import net.servicestack.client.*


open class AuthenticateCitizenRQ
{
    var Email:String? = null
    var Password:String? = null
    var Provider:Long? = null
    var DisplayName:String? = null
    var PhoneNumber:String? = null
    var ProviderId:String? = null
    var MobileId:String? = null
    var MobileOS:String? = null
    var CreatedUser:String? = null
}

open class AuthenticateCitizenRS : CoreRS()
{
    var Data:Citizen? = null
}

open class CoreRS
{
    var Code:String? = null
    var ErrorMessage:String? = null
    var ErrorStackTrace:String? = null
}

open class Citizen
{
    var Email:String? = null
    var DisplayName:String? = null
    var Avatar:String? = null
    var Theme:String? = null
    var PhoneNumber:String? = null
    var Provider:Long? = null
    var ProviderId:String? = null
    var Password:String? = null
    var Banned:String? = null
    var Status:String? = null
}

Kotlin AuthenticateCitizenRQ 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 /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>