Back to API references

SOAP API method WebSession_loggedOn

Description

This method returns false if noone is logged on.

Parameters

Name Type Description
id * string Unique identifier (id) of the object WebSession. The method only applies to the websession with this id.
preserved boolean If the user logged off during the session, return the object he used to be logged on with
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
profile Structure of type 'profile'
subprofile Structure of type 'subprofile'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'profile'

Name Type Description
id int The ID of the profile.
code string The code of the profile.
extra string The extra data of the profile.
created timestamp The timestamp when the profile was created.
modified timestamp The timestamp when the profile was last modified.
lastexport timestamp The last timestamp when the profile was exported.
fields Map Map of all fields of the profile, this property is only returned when the parameter 'allproperties' is set to true
interests Map Map of all interests of the profile, this property is only returned when the parameter 'allproperties' is set to true

Structure 'subprofile'

Name Type Description
id int The ID of the subprofile.
code string The code of the subprofile.
created timestamp The timestamp when the subprofile was created.
modified timestamp The timestamp when the subprofile was last modified.
lastexport timestamp The last timestamp when the subprofile was exported.
fields Map Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true