Versions Compared

Version Old Version 3 New Version Current
Changes made by

Nick Jensen

Nick Jensen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update endpoint structure after developer feedback


Excerpt

Fetch entity preference subscription details for all preferences in a group

...

Endpoint ID:2312
Method:

Status
colourGreen
titleGET

URL:

/preferences/entity/id/{entityID}/group/{groupID}

/preferences/entity/ext-key/{ext-key}/{ext-type}/group/{groupID}


entityIDRubiq master ID that uniquely identifies the entity

ext-keyExternal key that uniquely identifies the entity

ext-typeType of external key

groupIDA GUID string identifier for the group
Request body:None


Span (Deprecated)
stylewhite-space: nowrap
Response body:


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

Code Block
titleThe entity has opted in to a single preference in this group
{
    "preferencesentityPreferences": [
        {
            "idpreferenceID": "7a6776a3-9411-4d34-9866-99aa9ac7cc27",
            "nameoptedIn": "Preference 1",false
            "description": "This explains everything",
   },
        "isActive": true,
            "labels": [
                {
   
                "languagepreferenceID": "dadd9eaf78-18ff-44ea-9717-25b103060643",
      
             "label": "Tekst",
                    "isDefault": true
      "optedIn": true
         },
               
{                     "language": "en",
                    "label": "Text",
                    "isDefault": false
                }
            ]
        }
    ]
}
Code Block
titleThe entity has not opted into any preferences in this group
{
    "preferences": []
}



Status codes:200OK

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

404.5 Group not found

...