GivenConsentRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/entur/main/json-schema/entur-given-consent-request-schema.json",
  "title": "GivenConsentRequest",
  "description": "Create a given consent for a customer",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/entur-consents-openapi.yml#/components/schemas/GivenConsentRequest",
  "required": [
    "consentChoice",
    "consentId",
    "customerNumber",
    "expirationDate"
  ],
  "type": "object",
  "properties": {
    "consentChoice": {
      "type": "boolean",
      "description": "Whether this consent has been approved or rejected."
    },
    "consentId": {
      "type": "integer",
      "description": "The id of the consent defining what and to whom the customer has consented.",
      "format": "int64"
    },
    "countryCode": {
      "type": "string",
      "description": "The telephone number country code provided with the consent"
    },
    "customerNumber": {
      "type": "integer",
      "description": "Customer number. ",
      "format": "int64"
    },
    "customerRef": {
      "type": "string",
      "description": "Customer reference. Note: If you do not provide a customer reference, the customer number will used as reference."
    },
    "email": {
      "type": "string",
      "description": "The contact email provided with the consent."
    },
    "expirationDate": {
      "type": "string",
      "description": "When the consent expires. ISO 8601 date format",
      "format": "date-time"
    },
    "fromStopPlace": {
      "type": "string",
      "description": "The stop place where the customer’s journey started, in NeTEx format."
    },
    "lineRef": {
      "type": "string",
      "description": "Reference to the customers journey line, in NeTEx format"
    },
    "originalDatedServiceJourneyId": {
      "type": "string",
      "description": "Unique Id for a specific Service Journey, in NeTEx format with ENT as operator"
    },
    "telephoneNumber": {
      "type": "string",
      "description": "The telephone number provided with the consent"
    },
    "toStopPlace": {
      "type": "string",
      "description": "The stop place where the customer’s journey ended, in NeTEx format."
    }
  }
}