Sign in
Consent Request Aggregations

Get Consent Request Aggregations

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

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

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

lastStateChangeDatestring date-time

Example response

[
  {
    "requestDate": "2022-03-10",
    "showStateAsMigrated": true,
    "lastStateChangeDate": "2022-03-10T12:15:50",
    "dataRequest": {
      "dataConsumerDisplayName": "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

Changed in 15 of the 56 revisions of this API.105120

  • 5760204210ed2See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • a0609096db65427See the full diff
    • ▲

      the // response property's maxLength was unset from 120 for the response status

      response-property-max-length-unset

    • ▲

      the // response property's maxLength was unset from 255 for the response status

      response-property-max-length-unset

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 52c1637abca01See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • a3a5891898922See the full diff
    • ○

      added the required property //// to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • d1729646b7662See the full diff
    • ●

      added the new DATA_PROVIDER_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new DATA_PROVIDER_ERROR enum value to the response property for the response status

      response-property-enum-value-added

  • a598446f80932See the full diff
    • ○

      removed the DATA_PROVIDER_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the DATA_PROVIDER_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7cee7b14bf6f2See the full diff
    • ●

      added the new DATA_PROVIDER_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new DATA_PROVIDER_ERROR enum value to the response property for the response status

      response-property-enum-value-added

  • 5b038eea902d8See the full diff
    • ●

      added the new OTP_EXPIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OTP_EXPIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OTP_INVALID enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OTP_INVALID enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OTP_LOCKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OTP_LOCKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OTP_RESEND_COOLDOWN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OTP_RESEND_COOLDOWN enum value to the response property for the response status

      response-property-enum-value-added

  • b2698fe1c30a4See the full diff
    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 36609d47a3a742See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added