Data Requests

Get Consent Requests Of Data Request And Kt Id Pv 2

Changed on

Retrieves all consent requests associated with a specific data request and kt-id-p. Accessible to the consumer who owns the data request and for admin users.

get/api/agreement/v2/data-requests/{id}/kt-id-p/{kt-id-p}/consent-requests

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (http://localhost:6999/realms/agate/.well-known/openid-configuration, scopes: agridata.ch.Agridata_Datenbezueger, agridata.ch.Agridata_Admin)

Path parameters

idstring uuid required

The UUID of the data request

kt-id-pstring required

The kt-id-p identifier of the producer

Query parameters

actingRole'CONSUMER' | 'ADMIN'

Selects the role in which the authenticated user acts for this request. Optional: if the authenticated user holds exactly one of the allowed roles, the value is auto-resolved. Returns 400 if the value is unknown, not allowed for this endpoint, or omitted while the user holds multiple matching roles. Returns 403 if the user does not hold the role specified in the parameter.

Response

OK

idstring uuid required
dataProducerUidstring

UID of the data producer

namestring

Name of the uid

stateCode'GRANTED' | 'OPENED' | 'DECLINED' | 'LEGALLY_PERMITTED' | 'NOT_CREATED' | 'WITHDRAWN'

Possible states of a consent request:

  • GRANTED: Consent has been granted
  • OPENED: Consent request is open and awaiting response
  • DECLINED: Consent has been declined
  • NOT_CREATED: Placeholder to indicate that no consent request exists yet for a given UID.

Example response

[
  {
    "dataProducerUid": "CHE123456789",
    "name": "Testorganisation AG"
  }
]

Changes

  • 75957f6bdc66Revision changes
    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

  • ae5c7d8cdb15Revision changes
    • warning

      added the new WITHDRAWN enum value to the / response property for the response status