GET api/usersession/{clientKey}

V2 - Gets a new or active session for the currently logged in user. The session will be linked to the supplied clientKey. If the maximum number of sessions for this user with this key has been reached, an empty invalid session is returned.
It is usually not nessecary to manually request a new active session as one is created upon login.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientKey		string	Required

Body Parameters

None.

Response Information

Resource Description

UserSession

Name	Description	Type	Additional information
ApiSessionID	The ApiSessionID is only used internally. This value is not used for updates	integer	None.
IP	The IP references IP address from where the user started the session. This value is read-only This value is not used for updates	string	None.
UserID	The UserID references to the Main (often parent) account.	globally unique identifier	None.
SessionKey	The Sessionkey is generated upon creation of a new session. This key needs to be supplied through the custom header X-SessionKey: X-SessionKey: 11111111-2222-3333-4444-555555555555 If this value contains an empty GUID (00000000-0000-0000-0000-000000000000), the requested sessionn could not be created.	globally unique identifier	None.
IsActive	A boolean value indicating if this session is currently active.	boolean	None.
CreateDate	The creation date/time for this session	date	Data type: DateTime
AccessDate	The last access date/time for this session	date	Data type: DateTime
AccessCount	The number of accesses for this session	integer	None.
EndDate	The date/time on which this session has ended.	date	Data type: DateTime

Response Formats

application/json, text/json, text/javascript

Sample:

Sample not available.