api_auth

<back to all web services

CurrentSessionRequest

The following routes are available for this service:
GET/api/accountInformation about current logged-in user
UserInfo Parameters:
NameParameterData TypeRequiredDescription
PersonIDformlongNo
NameformstringNo
EmailformstringNo
Telephoneformlong?No
HyperIDformstringNo
IsConfirmedformboolNo
IsEmailConfirmedformboolNo
IsTelephoneConfirmedformboolNo
IsAddressConfirmedformboolNo
IsPassportConfirmedformboolNo
DatacenterIDformbyteNo
SessionIDformlongNo
MailNodeIDformint?No
CanResendConfirmationformboolNo
LanguageformstringNo
ServerTimeformDateTimeNo
ExpirationTimeformDateTimeNoExpiration time of current session
UserAgentformUserAgentInfoNo
SessionKeyformstringNo
MinAuthLevelformintNo
SessionAuthLevelformintNo
UserAgentInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DeviceNameformstringNo
DeviceTypeformshortNo
OSTypeformshortNo
OSVersionformstringNo
BrowserNameformstringNo
BrowserVersionformstringNo

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.

GET /api/account HTTP/1.1 
Host: 1.hyper.id 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	personID: 0,
	name: String,
	email: String,
	telephone: 0,
	hyperID: String,
	isConfirmed: False,
	isEmailConfirmed: False,
	isTelephoneConfirmed: False,
	isAddressConfirmed: False,
	isPassportConfirmed: False,
	datacenterID: 0,
	sessionID: 0,
	mailNodeID: 0,
	canResendConfirmation: False,
	language: String,
	userAgent: 
	{
		name: String,
		deviceName: String,
		deviceType: 0,
		osType: 0,
		osVersion: String,
		browserName: String,
		browserVersion: String
	},
	sessionKey: String,
	minAuthLevel: 0,
	sessionAuthLevel: 0
}