Consent Request Aggregations

Get Consent Request Aggregations

Changed on

Retrieves summary aggregated consent requests for the current data producer, grouped by data request.

get/api/agreement/v1/consent-request-aggregations

Request

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

Query parameters

dataProducerUidstring required

Filter to retrieve consent requests for a specific producer UID.

Response

OK

idstring uuid required
stateCode'GRANTED' | 'OPENED' | 'DECLINED' | 'LEGALLY_PERMITTED' | 'PARTIALLY_GRANTED' | 'PARTIALLY_OPENED'
requestDatestring date
showStateAsMigratedboolean

Indicates whether the aggregated state originates from migrated consent requests. Only considers MAF migrations. Deprecated: use showStateAsMigratedFromMaf instead.

showStateAsMigratedFromMafboolean

Indicates whether the aggregated state originates from consent requests migrated from MAF

showStateAsMigratedFromTvdboolean

Indicates whether the aggregated state originates from consent requests migrated from Identitas (TVD)

lastStateChangeDatestring date-time

Example response

[
  {
    "requestDate": "2022-03-10",
    "showStateAsMigrated": true,
    "showStateAsMigratedFromMaf": true,
    "showStateAsMigratedFromTvd": true,
    "lastStateChangeDate": "2022-03-10T12:15:50",
    "dataRequest": {
      "dataConsumerDisplayName": {
        "de": "Bio Suisse",
        "fr": "Bio Suisse",
        "it": "Bio Suisse"
      },
      "dataConsumerLogoBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
      "dataConsumerCity": "Basel",
      "title": {
        "de": "Anfrage zu Bodentypen und Bodenqualitätsdaten",
        "fr": "Demande sur les types de sols et les données de qualité du sol",
        "it": "Richiesta sui tipi di suolo e sui dati sulla qualità del suolo"
      }
    }
  }
]

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