Consents DWH
API for displaying all consent info (Data warehouse API)
Find all given consents
Find all given consents. This endpoint is intended for data warehouse use and returns all consents with related contact information. |The response can be filtered by consent IDs, and you can choose to include email and telephone numbers. |If no filters are provided, all given consents for your organisation are returned.
query Parameters
consentIdsFilter consents by its id (comma separated). Returns all consents if not provided.
includeEmailWhether or not to include email in the response. Defaults to false
includeTelephoneNumberWhether or not to include telephone number in the response. Defaults to false
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find all given consents › Responses
OK
consentIdThe id of the Consent that has been consented
consentCodeThe consent code of the base consent associated with the consent
customerRefCustomer ref, a unique identifier for the customer within an organisation
createdByOrgIdThe organisation through which the consent was given
customerNumberCustomer number, a unique identifier for the customer.
givenConsentIdGiven consent id.
consentBaseVersionThe consent base version associated with the consent
consentOrganisationIdThe organisation that owns the Consent. Typically an 'Operatør'
emailThe customer's email
lineRefReference to the customers journey line, in NeTEx format
countryCodeThe telephone number country code
toStopPlaceThe stop place where the customer’s journey ended, in NeTEx format.
fromStopPlaceThe stop place where the customer’s journey started, in NeTEx format.
telephoneNumberThe customer's telephone number
originalDatedServiceJourneyIdUnique Id for a specific Service Journey, in NeTEx format with ENT as operator