Versions Compared

Old Version 3

changes.mady.by.user Nick Jensen

Saved on

compared with

New Version Current

changes.mady.by.user Nick Jensen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add "groups" array to preferences in response


Excerpt

Fetch preference details

...

Endpoint ID:2300
Method:

Status
colourGreen
titleGET

URL:

/preferences/preference/{preferenceID}


preferenceIDOPTIONAL: A GUID string identifier for the preference
Request body:None


Span
stylewhite-space: nowrap
Response body:


JSON data containing an array of preferences. When a preferenceID has been given, this array will only contain a single element.

Code Block
title/preferences/preference/7a6776a3-9411-4d34-9866-99aa9ac7cc27
{
    "preferences": [
        {
            "id": "7a6776a3-9411-4d34-9866-99aa9ac7cc27",
            "name": "Preference 1",
            "description": "This explains everything",
            "isActive": true,
            "labels": [
                {
                    "language": "da",
                    "label": "Tekst",
                    "isDefault": true
                },
                {
                    "language": "en",
                    "label": "Text",
                    "isDefault": false
                }
            ],
            "groups": [
                "0ade0850-0abb-4d3a-b69f-c4307473d1f0",
                "38ed187d-456d-4617-9bbd-045d3ebf15e0"
            ]
        }
    ]
}


Code Block
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:200OK

404Preference not found - only returned when a preferenceID parameter is included in the request

...