2115: Get consents

2115: Get consents

Fetch consents

Endpoint ID:

2115

Method:

GET

URL:

/permissions/{consentID}

 

consentID

OPTIONAL: A GUID string identifier for the consent

Request body:

None

Response body:



JSON data describing the consents.

/permissions – Two Consents exist
{ "consents": [ { "id": "7a6776a3-9411-4d34-9866-99aa9ac7cc27", "name": "Contact me", "description": null, "tags": [] }, { "id": "1f788c79-7dde-407f-a976-6b08ffb4c75a", "name": "Tracking", "description": "Allow tracking via browser tools such as cookies", "tags": [ { "id": "e2fdf8e4-cb2c-4b1b-855a-dd88e93da5a9", "name": "Marketing", "path": "Touchpoint/CustomerService/Marketing" } ] } ] }
/permissions – No consents exist
{ "consents": [] }

When a consentID parameter is included in the request, an empty consents array will never be returned - either the requested consent object will be returned, or a 404 response.

/permissions/1f788c79-7dde-407f-a976-6b08ffb4c75a – Specific consent found
{ "consents": [ { "id": "1f788c79-7dde-407f-a976-6b08ffb4c75a", "name": "Tracking", "description": "Allow tracking via browser tools such as cookies", "tags": [ { "id": "e2fdf8e4-cb2c-4b1b-855a-dd88e93da5a9", "name": "Marketing", "path": "Touchpoint/CustomerService/Marketing" } ] } ] }

Status codes:

200

OK



404

Consent not found - only returned when a consentID parameter is included in the request