Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

Withdraw an entities acceptance of a set of terms


Endpoint ID:
2105
2104
Method:

Status
colourGreen
titlePUT

URL:

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

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



entityID

Rubiq master ID 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
Request body:
Response body:

JSON data describing the terms withdrawal

Required fields
 sourceIDThe GUID string identifier of the withdrawal source

reasonA reason for the withdrawal


Code Block
{
   
"isActive":
 
false, "isWithdrawn
"sourceID":
true,
 
"terms": { "id": "1f788c79-7dde-407f-a976-6b58b39aa79d",
"26f2da92-c9ca-4a82-90f0-8a8a43534239",
    
"
version
reason": "
1.2", "isMostRecentVersion": false
Abc"
}
, "acceptance": { "timestamp": "utc timestamp", "sourceID": 123 }, "withdrawal": { "timestamp": "utc timestamp", "sourceID": 234, "reason": "Abc" } }



Span
stylewhite-space:nowrap

Response body:


None

Status codes:
200
204Entity permission was withdrawn

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
404.6Source not found



412

The contract does not allow access to these terms, or allow this withdrawal source

412.1The terms are not allowed
412.3The source is not allowed