Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add "consents"


Excerpt

Fetch details for a set of specific terms version


Endpoint ID:2101
Method:

Status
colourGreen
titleGET

URL:

/permissions/terms/{termsID}/{version}



termsIDA GUID string identifier for the terms

version

A terms version string formatted as "major.minor", i.e. "1.0" or "4.7".

Alternatively, the string "active" indicates the active version of these terms. This will result in an error if the terms have no active version defined.

Request body:None


Span
stylewhite-space:nowrap

Response body:



Code Block
title
Example 1 – Request for terms with ID
/permissions/terms/7a6776a3-9411-4d34-9866-99aa9ac7cc27/active
{
    "version": "4.3",
    "state": "Active",
    "consents": [
        {
            "id": "
7a6776a3
584254a8-
9411
a401-
4d34
4f84-
9866
8068-
99aa9ac7cc27
92f173dce72e",
            "name": "
Some terms",
E-mail"
        },
        {
            "id": "7a0e1921-ce0e-4c97-86b9-650a93fad2dd",
            "
description
name": 
"This explains everything"
"SMS"
        }
    ],
    "text": [
        {
            "isDefault": true,
            "isDynamic": true,
            "
versions
key":
[
 "detailed"
        },
        {
            "isDefault": false,
            "isDynamic": true,
            "key": "overview"
        }
    ],
    "
version
files": 
"1.0"
[
        {
            "isDefault": true,
            "
state
key": "
draft
fineprint",
            "
text
fileName": 
"Please accept our terms and conditions
"fine-print.pdf",
            "mimeType": "application/pdf"
        }
    ]
}


Status codes:200OK

400

Invalid request.

The following subcodes may be returned:


400.1These terms have no active version



404

Terms version not found.

The following subcodes may be returned:


404.4Terms not found
412The contract does not allow access to these terms
404.7Terms version not found