API Documentation, version 2


POST /api/login

Logs on users or displays basic user information if logged on.

Arguments:

Parameter:Type:Required:Description:
passstringNopassword
prettybooleanNoTurns on pretty JSON output
userstringNousername (email)

Returns:

Parameter:Type:Description:
checksnumberThe number of current checks
fullnamestringThe full name of the user
loginstringThe login ID of the user (email)
messagesnumberThe number of unread messages
okaybooleanWhether the operation was successful.

Example output:

{
	"login": "foo@bar.com",
	"checks": 37,
	"messages": 0,
	"okay": true,
	"fullname": "John Doe"
}