End an agreement (provider)

POST

/dsp/agreements/{id}/termination

curl --request POST \
  --url https://example.com/dsp/agreements/example/termination \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Not part of DSP (decisions #76): the consumer ends an agreement with an AgreementTerminationMessage. Running transfers under it end. The same message again gets the same answer.

Authorizations

• dcp

Parameters

Path Parameters

id

required

string

The id of the agreement.

Request Body^required

An AgreementTerminationMessage for this agreement.

Media typeapplication/json

object

Example ^generated

{}

Responses

200

Ended.

Media typeapplication/json

object

Example ^generated

{}

400

The request is not valid.

Media typeapplication/json

A DSP error (dspace:…Error): code and reason, as JSON-LD.

object

@context

required

object

@type

required

E.g. ContractNegotiationError.

string

code

required

string

reason

required

Array<string>

Example ^generated

{
  "@context": {},
  "@type": "example",
  "code": "example",
  "reason": [
    "example"
  ]
}

401

Not authenticated.

Media typeapplication/json

A DSP error (dspace:…Error): code and reason, as JSON-LD.

object

@context

required

object

@type

required

E.g. ContractNegotiationError.

string

code

required

string

reason

required

Array<string>

Example ^generated

{
  "@context": {},
  "@type": "example",
  "code": "example",
  "reason": [
    "example"
  ]
}

404

Unknown agreement.

Media typeapplication/json

A DSP error (dspace:…Error): code and reason, as JSON-LD.

object

@context

required

object

@type

required

E.g. ContractNegotiationError.

string

code

required

string

reason

required

Array<string>

Example ^generated

{
  "@context": {},
  "@type": "example",
  "code": "example",
  "reason": [
    "example"
  ]
}