Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add optional "data" property

...

Excerpt

Accept a permission for an entity


Endpoint ID:21062105
Method:

Status
colourGreen
titlePOST

URL:

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

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



entityID

dialogportal™ Rubiq master key ID 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 GUID string identifier of the acceptance source
Optional fields

termsIDThe GUID string identifier of the terms this permission is being accepted for. When a termsID is included, then this endpoint is only used to accept a permission for an existing terms acceptance.

dataCustom context data


Code Block
{
    "sourceID": "26f2da92-c9ca-4a82-90f0-8a8a43534239",
    "termsID": "8f87ade0-c5a2-4031-89b9-33c923c4588e",
    "data": {
        "resellerID": 123456,
        "resellerName": "Jane Doe"
    }
}



Span
stylewhite-space:nowrap

Response body:



Code Block
{
    "isActive": true,
    "isWithdrawn": false,
    "permissionID": 987"ff11961d-8ae7-4508-aed7-867220a89668",
    "acceptance": {
        "timestamp": "utc timestamp",
        "sourceID": "26f2da92-c9ca-4a82-90f0-8a8a43534239"
    }
}


Status codes:201The permission was accepted

303This permission has already been accepted by this entity

400

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

The following subcodes may be returned:

400.2Permission not active
400.3Source not active



404

The entity or permission were not found.

The following sub codes subcodes may be returned:

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



412

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

412.2The permission is not allowed
412.3The source is not allowed