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 ext-key description


Excerpt

Fetch entity preference subscription details for a single preference

...

Endpoint ID:2311
Method:

Status
colourGreen
titleGET

URL:

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

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


entityIDRubiq master ID that uniquely identifies the entity

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

ext-typeType of external key

preferenceIDA GUID string identifier for the preference
Request body:None


Span
stylewhite-space: nowrap
Response body:


Boolean value, where true indicates that the entity has opted in to this preference, and false indicates the entity has either opted in and subsequently opted out again, or has never opted in.

Status codes:200OK

404

The entity or preference were not found.

The following sub codes may be returned:

404.1 Entity not found

404.2 External entity reference not found

404.4 Preference not found




...