Back to API references

SOAP API method WebSession_subProfile


If the user who is visiting the website is logged on as a subprofile, this method returns the appropriate subprofile. If the user is not logged on, or if he is logged on as a profile, this method returns false. If the user logs off during his visit to the website, you can still retrieve the subprofile he used to be logged on with, by supplying the boolean parameter 'preserved'.


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 subprofile logged off during the visit, return the original subprofile that was logged on before logging off
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
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 '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