post https://api.personetics.com/pserver/execute
Call retrieves full list of user preferences, to present in the UI. This includes: list of available insights, insight categories, and the user opt status of each. Each preference “asset” is located in a dedicated array holding all values for that asset. For example, “categories” asset will hold all available insight categories set in array object.
Categories Object
| Parameter | Type | Description |
|---|---|---|
| id | String | The ID of the category in the system |
| description | String | The description of the category purpose to display to the user “these are insights meant to…” |
| displayname | String | The name of the category to display in client |
| categoryGroupId | String | The category group ID this insight category is associated with |
| optStatus | Boolean | The user opt status of the category (if the user chose to activate the insights in this category in their solution) |
| optInPush | Boolean | The user push notification opt status of the category (if the user chose to activate the insights in this category in their solution) |
| insights | array | List of insights belonging to the specified category |
| image | String | In case project supports images or icons per category – this will hold image name (as saved in client) or URL of the image in server |
Insights Object
| Parameter | Type | Description |
|---|---|---|
| id | String | he ID of the insight in the system |
| description | String | The description of the insight purpose to display to the user “this insight shows the…” |
| displayname | String | The name of the insight to display in client |
| optStatus | Boolean | The user opt status of the insight (if the user chose to activate the insight in this category in their solution) |
| optInPush | Boolean | The user push notifications opt status of the insight (if the user chose to activate the insight in this category in their solution) |
| categories | Object | List of categories this insight is mapped to. Could also be empty in case insight is not mapped to a category. |
| image | String | In case project supports images or icons per insight – this will hold image name (as saved in client) or URL of the image in server |