Contract Revisions

Get Contract Revision

Retrieves a specific contract revision by its ID. Accessible by the consumer or provider that owns the associated datarequest.

get/api/agreement/v1/contract-revisions/{id}

Path parameters

idstring uuid required

Query parameters

actingRole'CONSUMER' | 'PROVIDER' | 'ADMIN'

Selects the role in which the authenticated user acts for this request. Optional: if the authenticated user holds exactly one of the allowed roles, the value is auto-resolved. Returns 400 if the value is unknown, not allowed for this endpoint, or omitted while the user holds multiple matching roles. Returns 403 if the user does not hold the role specified in the parameter.

Response

OK

idstring uuid required
dataRequestIdstring uuid required
dataConsumerNamestring required

LegalName of the data consumer taken from the uid register

dataConsumerCitystring required

City of the data consumer

dataProviderNamestring required

Name of the data provider

dataProviderCitystring required

City of the data provider

consumerSignatureType'INDIVIDUAL_SIGNATURE' | 'COLLECTIVE_SIGNATURE'
providerSignatureType'INDIVIDUAL_SIGNATURE' | 'COLLECTIVE_SIGNATURE'
sealState'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED'

Example response

{
  "dataConsumerName": "Bio Suisse, Vereinigung Schweizer Biolandbau-Organisationen",
  "dataConsumerCity": "Basel",
  "dataProviderName": "BLW",
  "dataProviderCity": "Bern",
  "dataRequestContext": {
    "dataConsumerLogoBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  },
  "consumerSignatures": [
    {
      "name": "John Doe",
      "timestamp": "2022-03-10T12:15:50"
    }
  ],
  "providerSignatures": [
    {
      "name": "John Doe",
      "timestamp": "2022-03-10T12:15:50"
    }
  ]
}

Changes

Changed in 10 of the 56 revisions of this API.1212

    • added the optional property sealState to the response with the 200 status

      response-optional-property-added

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

    • removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 404

      response-property-enum-value-removed

    • removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 500

      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

  • 7cee7b14bf6f21See the full diff
    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new optional query request parameter actingRole

      new-optional-request-parameter

    • added the new OTP_EXPIRED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_EXPIRED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_INVALID enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_INVALID enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_LOCKED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_LOCKED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 500

      response-property-enum-value-added

    • the security scope agridata.ch.Agridata_Admin was added to the endpoint's security scheme SecurityScheme

      api-security-scope-added

    • added the optional property consumerSignatureType to the response with the 200 status

      response-optional-property-added

    • added the optional property providerSignatureType to the response with the 200 status

      response-optional-property-added

    • the security scope agridata.ch.Agridata_Datenanbieter was added to the endpoint's security scheme SecurityScheme

      api-security-scope-added

    • added the optional property providerSignatures to the response with the 200 status

      response-optional-property-added

    • added the required property dataProviderCity to the response with the 200 status

      response-required-property-added

    • added the optional property consumerSignatures to the response with the 200 status

      response-optional-property-added

    • endpoint added

      endpoint-added