Page Comparison

Excerpt
Fetch entity preference subscription details for all preferences

has not opted into any preferences

Endpoint ID: 22102310

Method:

Status

colour	Green
title	GET

URL:

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

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

entityID Rubiq master ID that uniquely identifies the entity

ext-key Rubiq master ID External key that uniquely identifies the entity

ext-type Type of external key

Request body: None

Span

style	white-space: nowrap

Response body:

JSON data containing an array of preferences that the entity has opted in toall preferences, with the preferenceID and a boolean optedIn property indicating the entity's preference subscription status.

title

Code Block

title	The entity has opted in to a single preference

{
    "preferencesentityPreferences": [
        {
            "idpreferenceID": "7a6776a3-9411-4d34-9866-99aa9ac7cc27",
            "nameoptedIn": "Preference 1",false
            "description": "This explains everything",
            "isActive": true,
            "labels": [
       },
        {
                    "language"preferenceID": "dadd9eaf78-18ff-44ea-9717-25b103060643",
      
             "labeloptedIn": "Tekst",
                    "isDefault": true
                },
                {
                    "language": "en",
                    "label": "Text",
                    "isDefault": false
                }
           
]         }
    ]
}

Code Block

Status codes: 200 OK

404

The entity

{
    "preferences": []
}

Status codes: 200 OK

404

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

was not found

The following sub codes may be returned:

404.1 Entity not found

404.2 External entity reference not found

Versions Compared

Old Version 2

New Version Current

Key