This API allows the user to view the preferences set in your account
API Response explanation
Field | Description | Data Type |
---|---|---|
preferenceId | Unique identifier representing the preference | Integer |
name | Name of the preference | String |
description | Description of the preference | String |
valueTypeId | Unique identifier representing the value type | Integer |
valueTypeConstraint | Values that are acceptable for this preference | String |
categoryId | Unique identifier representing the catagory | Integer |
parentId | For internal Azuga use | Integer |
value | The value of the preference based on preferenceId/preferenceName | String |
level | The level set for the preference. 0 - Global level(Across Azuga customers) | Integer |
objectId | This field populates data based on the level of the preference. For level = 20, ObjectId = CustomerId | String |
categoryName | For internal Azuga use | String |
displayKey | For internal Azuga use | String |
displayName | Name of the preference displayed in Azuga | String |
hidden | Boolean representing whether the preference is hidden from Azuga True = Hidden in Azuga web platform | Boolean |
error | Error description - If any | List<Error> |