SOAP API method WebSession_profile

Back to API references

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

Parameters
Parameter 'id' : string
Unique identifier (id) of the object WebSession. The method only applies to the websession with this id.
Parameter 'preserved' : boolean
If profile logged off during the visit, return the original profile that was logged on before loggin off
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'profile' : Structure of type 'profile'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'profile'
This structure profile was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the profile.
Property 'code' : string
The code of the profile.
Property 'extra' : string
The extra data of the profile.
Property 'created' : timestamp
The timestamp when the profile was created.
Property 'modified' : timestamp
The timestamp when the profile was last modified.
Property 'lastexport' : timestamp
The last timestamp when the profile was exported.
Property 'fields' : Map
Map of all fields of the profile, this property is only returned when the parameter 'allproperties' is set to true
Property 'interests' : Map
Map of all interests of the profile, this property is only returned when the parameter 'allproperties' is set to true