v50

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

Data Requests

Create Data Request Draft

Creates a new data request in draft status. Only accessible to users with the consumer role. Disallows creating more than 10 draft requests per consumer.

post/api/agreement/v1/data-requests

Request body

dataConsumerDisplayNamestring

Shorter name of the data consumer defined by the data consumer used when displaying the request to the producer

dataConsumerCitystring

City of the data consumer

dataConsumerZipstring

Zip code of the data consumer

dataConsumerStreetstring

Street of the data consumer

dataConsumerCountrystring

2 letter country code of the data consumer

contactPhoneNumberstring

Contact phone number for the data request

contactEmailAddressstring

Contact email address for the data request

targetGroupstring

Target group of the data request

productsstring[]

List of data products requested

Example request

{
  "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"
  },
  "dataConsumerDisplayName": "Bio Suisse",
  "dataConsumerCity": "Basel",
  "dataConsumerZip": "4052",
  "dataConsumerStreet": "Peter Merian-Str. 34",
  "dataConsumerCountry": "CH",
  "contactPhoneNumber": "+41 79 123 45 67",
  "contactEmailAddress": "example@labelorganisation.ch",
  "targetGroup": "von allen Bio Suisse Mitgliedern",
  "products": [
    "c661ea48-106d-4d7a-a5d1-a9a6db48dd8c"
  ],
  "advantages": [
    {
      "de": "Vermeiden von Mehreingaben",
      "fr": "Éviter les saisies multiples",
      "it": "Evitare inserimenti multipli"
    }
  ]
}

Response

idstring uuid required

dataProviderIdstring uuid

dataSourceSystemIdstring uuid

humanFriendlyIdstring

Human friendly id of the data request

submissionDatestring date

Date and time when the data request was submitted

productsstring[]

List of data products requested

dataConsumerLegalNamestring

LegalName of the data consumer taken from the uid register

dataConsumerDisplayNamestring

Shorter name of the data consumer defined by the data consumer used when displaying the request to the producer

dataConsumerUidstring

Uid of the data consumer

dataConsumerCitystring

City of the data consumer

dataConsumerZipstring

Zip code of the data consumer

dataConsumerStreetstring

Street of the data consumer

dataConsumerCountrystring

2 letter country code of the data consumer

contactPhoneNumberstring

Contact phone number for the data request

contactEmailAddressstring

Contact email address for the data request

dataConsumerLogoBase64string

Base64-encoded logo of the data consumer

targetGroupstring

validRedirectUriRegexstring

Regex of valid redirect_uri. Must compile as regex successfully.

currentContractRevisionIdstring uuid

consumerSignatureType'INDIVIDUAL_SIGNATURE' | 'COLLECTIVE_SIGNATURE'

providerSignatureType'INDIVIDUAL_SIGNATURE' | 'COLLECTIVE_SIGNATURE'

Example response

{
  "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"
    }
  ]
}