Versions Compared

Old Version 6

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 "contextData" to response "acceptance"

...

Excerpt

Fetch all sets of terms which the entity has accepted


Endpoint ID:2103
Method:

Status
colourGreen
titleGET

URL:

/permissions/entity/id/{entityID}/terms/{termsID}

/permissions/entity/ext-key/{ext-key}/{ext-type}/terms/{termsID}



entityIDRubiq master ID that uniquely identifies the entity to return terms acceptance status for.

ext-keyExternal key that uniquely identifies the entity to return terms acceptance status for.

ext-typeType of external key.

termsIDLimits the status data to a specific set of terms. If omitted, status data for all terms are returned.
Request body:None


Span
stylewhite-space:nowrap

Response body:



Code Block
{
    "accepted": [
        {
            "isActive": true,
            "isWithdrawn": false,
            "isExpired": false,
            "terms": {
                "id": "1f788c79-7dde-407f-a976-6b08ffb4c75a",
                "version": "1.3",
                "isMostRecentVersion": true
            },
            "acceptance": {
                "timestamp": "utc timestamp",
                "sourceID":
123
"26f2da92-c9ca-4a82-90f0-8a8a43534239",
                "contextData": {
                    "partner-id": "98765",
                    "partner-name": "John Smith"
                }
            }
        },
        {
            "isActive": true,
            "isWithdrawn": false,
            "isExpired": false,
            "terms": {
                "id": "1f788c79-7dde-407f-a976-6b58b39aa79d",
                "version": "1.2",
                "isMostRecentVersion": false
            },
            "acceptance": {
                "timestamp": "utc timestamp",
                "sourceID": "26f2da92-c9ca-4a82-90f0-8a8a43534239",
                "contextData": {}
            }
        }
    ],
    "withdrawn": [
		{
            "isActive": false,
            "isWithdrawn": true,
            "isExpired": false,
            "terms": {
                "id": "1f788c79-7dde-407f-a976-6b58b39aa79d",
                "version": "1.
2
0",
                "isMostRecentVersion": false
            },
            "acceptance": {
                "timestamp": "utc timestamp",
                "sourceID":
123
 "26f2da92-c9ca-4a82-90f0-8a8a43534239",
                "contextData": {}
            },
            "withdrawal": {
                "timestamp": "utc timestamp",
                "sourceID":
234
"26f2da92-c9ca-4a82-90f0-8a8a43534239",
                "reason": "plain text explanation for withdrawal if supplied by user upon time of withdrawal"
            }
        }
    ],
    "expired": [
"Abc
		{
            "isActive": false,
            "isWithdrawn": false,
            "isExpired": true,
            "terms": {
                "id": "1f788c79-7dde-407f-a976-6b58b39aa79d",
                "version": "1.1",
                "isMostRecentVersion": false
            },
            "acceptance": {
                "timestamp": "utc timestamp",
                "sourceID": "26f2da92-c9ca-4a82-90f0-8a8a43534239",
                "contextData": {
                    "agent-id": "98765"
                }
            },
            "expiry": {
                "timestamp": "utc timestamp"
            }
        }
    ]
}


Code Block
titleNo terms have been accepted nor withdrawn by the entity
{
    "accepted": [],
    "withdrawn": [],
    "expired": []
}



Status codes:200OK

404

The entity or the terms (if specified by termsID) was not found.

The following sub codes may be returned:


404.1Entity not found
404.2External entity reference could not be found
404.4Terms not found