2312: Get preference group opt-in status
Fetch entity preference subscription details for all preferences in a group
Endpoint ID: | 2312 | |
Method: | GET | |
URL: | /preferences/entity/id/{entityID}/group/{groupID} /preferences/entity/ext-key/{ext-key}/{ext-type}/group/{groupID} | |
| entityID | Rubiq master ID that uniquely identifies the entity |
| ext-key | External key that uniquely identifies the entity |
| ext-type | Type of external key |
| groupID | A GUID string identifier for the group |
Request body: | None | |
JSON data containing an array of all preferences in the group, with the The entity has opted in to a single preference in this group{
"entityPreferences": [
{
"preferenceID": "7a6776a3-9411-4d34-9866-99aa9ac7cc27",
"optedIn": false
},
{
"preferenceID": "dd9eaf78-18ff-44ea-9717-25b103060643",
"optedIn": true
}
]
} | ||
Status codes: | 200 | OK |
| 404 | The entity was not found The following sub codes may be returned:
|