Consent Request Aggregations

Get Consent Request Aggregation

Changed on

Retrieves the full details of a single consent request aggregation for the current data producer.

get/api/agreement/v1/consent-request-aggregations/{id}

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)

Path parameters

idstring uuid required

Query parameters

dataProducerUidstring required

Filter to retrieve the consent request aggregation 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": {
    "dataSourceSystem": {
      "code": "AGIS",
      "dataProvider": {
        "code": "BLW",
        "uid": "CHE123456789"
      }
    },
    "humanFriendlyId": "GL56",
    "submissionDate": "2025-06-16T11:04:51.823889",
    "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"
    },
    "description": {
      "de": "Ziel der Anfrage ist es, Informationen über Bodentypen und deren Qualität zu erhalten, um fundierte Entscheidungen zur Fruchtfolge, Düngung und nachhaltigen Bewirtschaftung treffen zu können.",
      "fr": "L'objectif de la demande est d'obtenir des informations sur les types de sols et leur qualité afin de prendre des décisions éclairées concernant la rotation des cultures, la fertilisation et la gestion durable.",
      "it": "L'obiettivo della richiesta è ottenere informazioni sui tipi di suolo e sulla loro qualità per prendere decisioni informate sulla rotazione delle colture, la fertilizzazione e la gestione sostenibile."
    },
    "purpose": {
      "de": "Bewertung der Bodenqualität",
      "fr": "Évaluation de la qualité du sol",
      "it": "Valutazione della qualità del suolo"
    },
    "terminationPeriodUntil": "2022-03-10",
    "dataConsumerLegalName": "Bio Suisse, Vereinigung Schweizer Biolandbau-Organisationen",
    "dataConsumerDisplayName": {
      "de": "Bio Suisse",
      "fr": "Bio Suisse",
      "it": "Bio Suisse"
    },
    "dataConsumerUid": "CHE101708094",
    "dataConsumerCity": "Basel",
    "dataConsumerZip": "4052",
    "dataConsumerStreet": "Peter Merian-Str. 34",
    "dataConsumerCountry": "CH",
    "contactPhoneNumber": "+41 79 123 45 67",
    "contactEmailAddress": "example@labelorganisation.ch",
    "dataConsumerLogoBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "validRedirectUriRegex": "^https:\\/\\/www\\.dummy-label-organisation\\/.*$",
    "advantages": [
      {
        "de": "Vermeiden von Mehreingaben",
        "fr": "Éviter les saisies multiples",
        "it": "Evitare inserimenti multipli"
      }
    ],
    "burPresent": true
  },
  "consentRequests": [
    {
      "dataProducerUid": "CHE123456789",
      "dataProducerBur": "A99910003",
      "showStateAsMigrated": true,
      "showStateAsMigratedFromMaf": true,
      "showStateAsMigratedFromTvd": true,
      "lastStateChangeDate": "2025-06-16T11:04:51.823889",
      "requestDate": "2022-03-10"
    }
  ]
}

Changes

  • 48ab7e1541c3Revision changes
    • warning

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

    • warning

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

    • info

      added the optional property / to the response with the status

  • 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