SOAP API methode WebSession_profile
Beschrijving
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
Naam | Type | Beschrijving |
---|---|---|
id * | string | Unique identifier (id) of the object WebSession. The method only applies to the websession with this id. |
preserved | boolean | If profile logged off during the visit, return the original profile that was logged on before loggin off |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* verplichte parameters |
Resultaat
Naam | Type | Beschrijving |
---|---|---|
profile | Structure of type 'profile' |
Structuur 'login'
Naam | Type | Beschrijving |
---|---|---|
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 |
Structuur 'profile'
Naam | Type | Beschrijving |
---|---|---|
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 |