Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add 412 response

...

Endpoint ID:2106
Method:

Status
colourGreen
titlePOST

URL:

/permissions/entity/id/{entityID}/permission/{permissionID}

/permissions/entity/ext-key/{ext-key}/{ext-type}/permission/{permissionID}


entityID

dialogportal™ master key that uniquely identifies the entity

ext-keyExternal key that uniquely identifies the entity

ext-typeType of external key

permissionIDA GUID string identifier for the permission
Request body:

JSON data containing the permission acceptance

Required fields
 sourceIDThe ID of the acceptance source


Code Block
{
    "sourceID": 234
}



Span
stylewhite-space:nowrap

Response body:



Code Block
{
    "isActive": true,
    "isWithdrawn": false,
    "permissionID": 987,
    "acceptance": {
        "timestamp": "utc timestamp",
        "sourceID": 123
    }
}


Status codes:201The permission was accepted

303This permission has already been accepted by this entity

400The permission could not be accepted, because it is inactive, or due to an invalid sourceID

404

The entity or permission were not found.

The following sub codes may be returned:

404.1Entity not found
404.2External entity reference could not be found
404.5Permission not found



412The contract does not allow access to this permission, or allow this acceptance source