Documentation Center

status

Status of the current login session

Description

Returns the web session's current session ID and the current user name

Parameters

action
status

Example URL

http://<host>:<port>/<context>/web/session.xql?action=status

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure. The current session ID and user name are returned as a sub-element: <info name="user" value="UserName"/><info name="sessionId" value="Session#"/>

Failed Result

In the case of an error, this function returns a standard API result element with a non-zero statusCode (such as, <result status='FAIL' statusCode='200' message='Localized Failure Message' messageKey='message.key'/>). Refer to API Error Code Reference.