Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Fetch entity preference subscription details for all preferences

Endpoint ID:2210
Method:

GET

URL:

/preferences/entity/id/{entityID}/preference

/preferences/entity/ext-key/{ext-key}/{ext-type}/preference


entityIDRubiq master ID that uniquely identifies the entity

ext-keyRubiq master ID that uniquely identifies the entity

ext-typeType of external key
Request body:None

Response body:

JSON data containing an array of preferences that the entity has opted in to.

The entity has opted in to a single preference
{
    "preferences": [
        {
            "id": "7a6776a3-9411-4d34-9866-99aa9ac7cc27",
            "name": "Preference 1",
            "description": "This explains everything",
            "isActive": true,
            "labels": [
                {
                    "language": "da",
                    "label": "Tekst",
                    "isDefault": true
                },
                {
                    "language": "en",
                    "label": "Text",
                    "isDefault": false
                }
            ]
        }
    ]
}
The entity has not opted into any preferences
{
    "preferences": []
}
Status codes:200OK

404Preference not found - only returned when a preferenceID parameter is included in the request
  • No labels