Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-306170167.5 KB
Consent Requests

Get Consent Request

Retrieves consent request with {id} if the authenticated data producer is assigned to it.

get/api/agreement/v1/consent-requests/{id}

Path parameters

idstring uuid required

Response

OK

idstring uuid required
dataProducerUidstring

UID of the data producer

stateCode'GRANTED' | 'OPENED' | 'DECLINED' | 'NOT_CREATED'

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.
showStateAsMigratedboolean

If the state should be shown as migrated

lastStateChangeDatestring date

Date and time when the state was changed last

requestDatestring date

Example response

{
  "dataProducerUid": "CHE123456789",
  "showStateAsMigrated": true,
  "lastStateChangeDate": "2025-06-16T11:04:51.823889",
  "requestDate": "2022-03-10",
  "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"
    },
    "dataConsumerLegalName": "Bio Suisse, Vereinigung Schweizer Biolandbau-Organisationen",
    "dataConsumerDisplayName": "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"
      }
    ]
  }
}