Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Accept a set of terms for an entity

Endpoint ID:2102
Method:

POST

URL:

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

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


entityID

dialogportalâ„¢ master key that uniquely identifies the entity

ext-keyExternal key that uniquely identifies the entity

ext-typeType of external key

termsIDA guid string identifier for the terms

sourceIDThe ID of the acceptance source

termsVersionOptional: The version of the terms which is being accepted, in major.minor format.
Request body:
{
   "sourceID": 234,
   "termsVersion": "1.3"
}
Response body:
{
   "isActive": true,
   "isWithdrawn": false,
   "terms": {
      "id": "1f788c79-7dde-407f-a976-6b08ffb4c75a",
      "version": "1.3",
      "isMostRecentVersion": true
   },
   "acceptance": {
      "timestamp": "utc timestamp",
      "sourceID": 123
   }
}
Status codes:201Terms were accepted

303These terms have already been accepted by this entity

400Terms could not be accepted, due to an invalid version or sourceID

404

The entity or terms were 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
  • No labels