FrameAppWS

<back to all web services

AuthenticateCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/authenticate
namespace Nwa.Model.Contexto.nwa.citizen

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CoreRS() = 
        member val Code:String = null with get,set
        member val ErrorMessage:String = null with get,set
        member val ErrorStackTrace:String = null with get,set

    [<AllowNullLiteral>]
    type Citizen() = 
        member val Email:String = null with get,set
        member val DisplayName:String = null with get,set
        member val Avatar:String = null with get,set
        member val Theme:String = null with get,set
        member val PhoneNumber:String = null with get,set
        member val Provider:Int64 = new Int64() with get,set
        member val ProviderId:String = null with get,set
        member val Password:String = null with get,set
        member val Banned:String = null with get,set
        member val Status:String = null with get,set

    [<AllowNullLiteral>]
    type AuthenticateCitizenRS() = 
        inherit CoreRS()
        member val Data:Citizen = null with get,set

    [<AllowNullLiteral>]
    type AuthenticateCitizenRQ() = 
        member val Email:String = null with get,set
        member val Password:String = null with get,set
        member val Provider:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val DisplayName:String = null with get,set
        member val PhoneNumber:String = null with get,set
        member val ProviderId:String = null with get,set
        member val MobileId:String = null with get,set
        member val MobileOS:String = null with get,set
        member val CreatedUser:String = null with get,set

F# 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"}