Page Comparison

Excerpt
Fetch entity preference subscription details for a single preferenceall preferences

OPTIONAL: A GUID string identifier for the preference

Endpoint ID: 22112310

Method:

Status

colour	Green
title	GET

URL:

/preferences/entity/id/{entityID}

/preferences/preferenceentity/ext-key/{ext-key}/{preferenceID}

preferenceID

ext-type}

entityID Rubiq master ID that uniquely identifies the entity

ext-key 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. When a preferenceID has been given, this array will only contain a single elementall preferences, with the preferenceID and a boolean optedIn property indicating the entity's preference subscription status.

code

Code Block

title	/preferences/preference/7a6776a3-9411-4d34-9866-99aa9ac7cc27The entity has opted in to a single preference

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

Status codes:

title	/preferences/preference – No preferences exist

{
    "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:200OK404Preference not found - only returned when a preferenceID parameter is included in the request200OK
404

The entity 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 1

New Version Current

Key