FrameAppWS

AuthenticateCitizenRQ

The following routes are available for this service:
All Verbs	/citizen/authenticate

**AuthenticateCitizenRQ** Parameters:
Name	Parameter	Data Type	Required
Email	query	string	No
Password	query	string	No
Provider	query	long?	No
DisplayName	query	string	No
PhoneNumber	query	string	No
ProviderId	query	string	No
MobileId	query	string	No
MobileOS	query	string	No
CreatedUser	query	string	No

**AuthenticateCitizenRS** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	Citizen	No

**CoreRS** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
ErrorMessage	form	string	No
ErrorStackTrace	form	string	No

**Citizen** Parameters:
Name	Parameter	Data Type	Required
Email	form	string	No
DisplayName	form	string	No
Avatar	form	string	No
Theme	form	string	No
PhoneNumber	form	string	No
Provider	form	long	No
ProviderId	form	string	No
Password	form	string	No
Banned	form	string	No
Status	form	string	No

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>