FrameAppWS

<back to all web services

AuthenticateCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/authenticate
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Nwa.Model.Tipos.nwa.citizen
Imports Nwa.Model.Tipos.nwa.core
Imports Nwa.Model.Contexto.nwa.citizen

Namespace Global

    Namespace Nwa.Model.Contexto.nwa.citizen

        Public Partial Class Citizen
            Public Overridable Property Email As String
            Public Overridable Property DisplayName As String
            Public Overridable Property Avatar As String
            Public Overridable Property Theme As String
            Public Overridable Property PhoneNumber As String
            Public Overridable Property Provider As Long
            Public Overridable Property ProviderId As String
            Public Overridable Property Password As String
            Public Overridable Property Banned As String
            Public Overridable Property Status As String
        End Class
    End Namespace

    Namespace Nwa.Model.Tipos.nwa.citizen

        Public Partial Class AuthenticateCitizenRQ
            Public Overridable Property Email As String
            Public Overridable Property Password As String
            Public Overridable Property Provider As Nullable(Of Long)
            Public Overridable Property DisplayName As String
            Public Overridable Property PhoneNumber As String
            Public Overridable Property ProviderId As String
            Public Overridable Property MobileId As String
            Public Overridable Property MobileOS As String
            Public Overridable Property CreatedUser As String
        End Class

        Public Partial Class AuthenticateCitizenRS
            Inherits CoreRS
            Public Overridable Property Data As Citizen
        End Class
    End Namespace

    Namespace Nwa.Model.Tipos.nwa.core

        Public Partial Class CoreRS
            Public Overridable Property Code As String
            Public Overridable Property ErrorMessage As String
            Public Overridable Property ErrorStackTrace As String
        End Class
    End Namespace
End Namespace

VB.NET 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>