Ga naar inhoud

The state of a delegation, for the counterparty

GET
/delegation/v1/{id}
curl --request GET \
--url https://example.com/delegation/v1/example \
--header 'Authorization: Bearer <token>'
id
required
string

The id of the delegation (urn:uuid:…).

OK.

Media typeapplication/json

What the other connector gets back: the state of the delegation.

object
@context
required

https://w3id.org/buildinglinks/v1/delegation.

string
@type
required

Delegation.

string
@id
required
string
state
required
string

Example generated

{
"@context": "example",
"@type": "example",
"@id": "example",
"state": "example"
}

No valid DCP token.

Unknown, or not a delegation with the caller.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example

{
"error": {
"code": "not_found",
"message": "unknown negotiation"
}
}