/
session_get ( session )

session_get ( session )

Owned by Former user (Deleted)
Function prototype

session_get (session, id)

API Version2.7.13 and higher
Supported interfacesSOAP, REST (from API Version 2.7.32)

Returns information about the session

Input

parameters:

Output

parameters:

  • result: XML with the information about the session
    • token: Session token. Introduced in API Version 2.7.15
    • user: The USER reference (different from username)
    • role: Active ROLE of the user in this session
    • team: Reference of the active TEAM in this session
    • team_code: Team code of the active TEAM. Introduced in API Version 2.7.20
    • professional: The PROFESSIONAL reference if the user is a professional (is member of a team), otherwise null (empty)
    • case: The CASE reference if the user is a professional (is member of a team), otherwise null (empty)
    • associate: The ASSOCIATE reference if the user is an associate of one or more CASEs, otherwise null (empty)
    • timezone: Time zone of the session (calculated based on the value of current_date)
  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language
  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request

sample:

session_get ( “LCAAAAAAAAAAAA”);

Response

sample:


<result>
  <?xml version="1.0" encoding="utf-8"?>
  <session>
    <user>16761</user>
    <professional>16761</professional>
    <case>14872</case>
    <associate>261</associate>
    <timezone>2</timezone>
    <language>EN</language>
    <role>39</role>
    <team>0</team>
  </session>
</result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>

Notes:


Return Error codes

ERROR CODE

INVALID_TOKEN

The session token provided is not valid

Related content