2310: Get preference opt-in status

Fetch entity preference subscription details for all preferences



Endpoint ID:

2310

Method:

GET

URL:

/preferences/entity/id/{entityID}

/preferences/entity/ext-key/{ext-key}/{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

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

The entity has opted in to a single preference
{ "entityPreferences": [ { "preferenceID": "7a6776a3-9411-4d34-9866-99aa9ac7cc27", "optedIn": false }, { "preferenceID": "dd9eaf78-18ff-44ea-9717-25b103060643", "optedIn": true } ] }

Status codes:

200

OK



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