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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Email":"String","Password":"String","Provider":0,"DisplayName":"String","PhoneNumber":"String","ProviderId":"String","MobileId":"String","MobileOS":"String","CreatedUser":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}