Data Requests

Get Consent Requests Of Data Request And Uid

Changed on

Retrieves the UID- and BUR-based consent requests of a specific data request for a single producer UID. Accessible to the consumer who owns the data request.

get/api/agreement/v1/data-requests/{id}/uids/{uid}/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)

Path parameters

idstring uuid required

The UUID of the data request

uidstring required

The UID of the data producer

Response

OK

idstring uuid required
dataRequestIdstring uuid required
dataProducerUidstring

UID of the data producer

dataProducerBurstring

BUR of the data producer

grantedDataPeriodFromstring date
grantedDataPeriodTostring date
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.
lastModifiedDateTimestring datetime

Date and time of the most recent modification to the consent request

Example response

[
  {
    "dataProducerUid": "CHE123456789",
    "dataProducerBur": "A123456",
    "grantedDataPeriodFrom": "2022-03-10",
    "grantedDataPeriodTo": "2022-03-10",
    "lastModifiedDateTime": "2025-06-16T11:04:51.823889"
  }
]

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