FrameAppWS

<back to all web services

AuthenticateCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/authenticate
AuthenticateCitizenRQ Parameters:
NameParameterData TypeRequiredDescription
EmailquerystringNo
PasswordquerystringNo
Providerquerylong?No
DisplayNamequerystringNo
PhoneNumberquerystringNo
ProviderIdquerystringNo
MobileIdquerystringNo
MobileOSquerystringNo
CreatedUserquerystringNo
AuthenticateCitizenRS Parameters:
NameParameterData TypeRequiredDescription
DataformCitizenNo
CoreRS Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ErrorMessageformstringNo
ErrorStackTraceformstringNo
Citizen Parameters:
NameParameterData TypeRequiredDescription
EmailformstringNo
DisplayNameformstringNo
AvatarformstringNo
ThemeformstringNo
PhoneNumberformstringNo
ProviderformlongNo
ProviderIdformstringNo
PasswordformstringNo
BannedformstringNo
StatusformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
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"}