FrameAppWS

AuthenticateCitizenRQ

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


export class CoreRS
{
    public Code?: string;
    public ErrorMessage?: string;
    public ErrorStackTrace?: string;

    public constructor(init?: Partial<CoreRS>) { (Object as any).assign(this, init); }
}

export class Citizen
{
    public Email?: string;
    public DisplayName?: string;
    public Avatar?: string;
    public Theme?: string;
    public PhoneNumber?: string;
    public Provider?: number;
    public ProviderId?: string;
    public Password?: string;
    public Banned?: string;
    public Status?: string;

    public constructor(init?: Partial<Citizen>) { (Object as any).assign(this, init); }
}

export class AuthenticateCitizenRS extends CoreRS
{
    public Data?: Citizen;

    public constructor(init?: Partial<AuthenticateCitizenRS>) { super(init); (Object as any).assign(this, init); }
}

export class AuthenticateCitizenRQ
{
    public Email?: string;
    public Password?: string;
    public Provider?: number;
    public DisplayName?: string;
    public PhoneNumber?: string;
    public ProviderId?: string;
    public MobileId?: string;
    public MobileOS?: string;
    public CreatedUser?: string;

    public constructor(init?: Partial<AuthenticateCitizenRQ>) { (Object as any).assign(this, init); }
}

TypeScript 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
}