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.*;

public class dtos
{

    public static class AuthenticateCitizenRQ
    {
        public String Email = null;
        public String Password = null;
        public Long Provider = null;
        public String DisplayName = null;
        public String PhoneNumber = null;
        public String ProviderId = null;
        public String MobileId = null;
        public String MobileOS = null;
        public String CreatedUser = null;
        
        public String getEmail() { return Email; }
        public AuthenticateCitizenRQ setEmail(String value) { this.Email = value; return this; }
        public String getPassword() { return Password; }
        public AuthenticateCitizenRQ setPassword(String value) { this.Password = value; return this; }
        public Long getProvider() { return Provider; }
        public AuthenticateCitizenRQ setProvider(Long value) { this.Provider = value; return this; }
        public String getDisplayName() { return DisplayName; }
        public AuthenticateCitizenRQ setDisplayName(String value) { this.DisplayName = value; return this; }
        public String getPhoneNumber() { return PhoneNumber; }
        public AuthenticateCitizenRQ setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
        public String getProviderId() { return ProviderId; }
        public AuthenticateCitizenRQ setProviderId(String value) { this.ProviderId = value; return this; }
        public String getMobileId() { return MobileId; }
        public AuthenticateCitizenRQ setMobileId(String value) { this.MobileId = value; return this; }
        public String getMobileOS() { return MobileOS; }
        public AuthenticateCitizenRQ setMobileOS(String value) { this.MobileOS = value; return this; }
        public String getCreatedUser() { return CreatedUser; }
        public AuthenticateCitizenRQ setCreatedUser(String value) { this.CreatedUser = value; return this; }
    }

    public static class AuthenticateCitizenRS extends CoreRS
    {
        public Citizen Data = null;
        
        public Citizen getData() { return Data; }
        public AuthenticateCitizenRS setData(Citizen value) { this.Data = value; return this; }
    }

    public static class CoreRS
    {
        public String Code = null;
        public String ErrorMessage = null;
        public String ErrorStackTrace = null;
        
        public String getCode() { return Code; }
        public CoreRS setCode(String value) { this.Code = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public CoreRS setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getErrorStackTrace() { return ErrorStackTrace; }
        public CoreRS setErrorStackTrace(String value) { this.ErrorStackTrace = value; return this; }
    }

    public static class Citizen
    {
        public String Email = null;
        public String DisplayName = null;
        public String Avatar = null;
        public String Theme = null;
        public String PhoneNumber = null;
        public Long Provider = null;
        public String ProviderId = null;
        public String Password = null;
        public String Banned = null;
        public String Status = null;
        
        public String getEmail() { return Email; }
        public Citizen setEmail(String value) { this.Email = value; return this; }
        public String getDisplayName() { return DisplayName; }
        public Citizen setDisplayName(String value) { this.DisplayName = value; return this; }
        public String getAvatar() { return Avatar; }
        public Citizen setAvatar(String value) { this.Avatar = value; return this; }
        public String getTheme() { return Theme; }
        public Citizen setTheme(String value) { this.Theme = value; return this; }
        public String getPhoneNumber() { return PhoneNumber; }
        public Citizen setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
        public Long getProvider() { return Provider; }
        public Citizen setProvider(Long value) { this.Provider = value; return this; }
        public String getProviderId() { return ProviderId; }
        public Citizen setProviderId(String value) { this.ProviderId = value; return this; }
        public String getPassword() { return Password; }
        public Citizen setPassword(String value) { this.Password = value; return this; }
        public String getBanned() { return Banned; }
        public Citizen setBanned(String value) { this.Banned = value; return this; }
        public String getStatus() { return Status; }
        public Citizen setStatus(String value) { this.Status = value; return this; }
    }

}

Java AuthenticateCitizenRQ DTOs

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

HTTP + JSV

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