Versions Compared

Old Version 1

changes.mady.by.user Nick Jensen

Saved on

compared with

New Version 2

changes.mady.by.user Nick Jensen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Excerpt

Fetch entity preference subscription details for a single preferenceall preferences


OPTIONAL: A GUID string identifier for the preference
Endpoint ID:22112210
Method:

Status
colourGreen
titleGET

URL:

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

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

preferenceID

/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


Span
stylewhite-space: nowrap
Response body:


JSON data containing an array of preferences. When a preferenceID has been given, this array will only contain a single element that the entity has opted in to.

Code Block
title/preferences/preference/7a6776a3-9411-4d34-9866-99aa9ac7cc27The 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
                }
            ]
        }
    ]
}


Code Block
title/preferences/preference – No preferences existThe entity has not opted into any preferences
{
    "preferences": []
}
Note
When a preferenceID parameter is included in the request, an empty preferences array will never be returned - either the requested preference object will be returned, or a 404 response.

Status codes:200OK

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