Schemas
ConsentBaseRequest
consentCodeConsent code, identifying the consent base. Must be unique within the system, prefixing it with the organisation's code space is advisable tp avoid conflict. Has a maximum length of 20 characters.
Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown
consentOwnerOrgIdThe organisation that owns the consent. If not set all organisations can use the consent base. |If you're a partner, this will be filled out from your authentication token.
Internal description, describing the use cases for the consent base
orgNameSubstitutionPatternThe pattern on which to perform substitution within terms. Facilitates reusable consent bases across organisations.
validFromIf set, the date the consent base is valid from. It is not possible to change the terms after this date without creating a new version. If not set, the consent base is in draft mode.
validToIf set, the date the consent base is valid to. Set the date to deactivate the consent. If not set the consent is active from validFrom and onwards.
ConsentBaseResponse
changedAtWhen the consent base was last changed. ISO 8601 date format
consentCodeConsent code used to identify the consent base
createdAtWhen the consent base was created. ISO 8601 date format
Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown
versionThe consent base version
consentOwnerOrgIdThe organisation that owns the consent base. If not set, the consent base can be used by all organisations.
Internal description, describing the use cases for the consent base
orgNameSubstitutionPatternThe pattern on which to perform substitution within terms. Facilitates reusable consent basess across organisations
validFromIf set, the date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set, the consent base is in draft mode.
validToIf set, the date the consent base is valid to. If this date is in the past, the consent base is deactivated. If not set, the consent is active from validFrom and onwards.
ConsentBaseVersionPatchRequest
The internal description. Is only exposed for admin endpoints
Terms to add. Only new languages can be added to existing terms. Updating terms for an existing language will result in an exception.
validToIf set, the date the consent base is valid to. Set the date to deactivate the consent base. If not set, the consent base is active from validFrom and onwards
ConsentBaseVersionRequest
Consent description and terms in multiple languages. Supports MarkDown
Internal description, describing what the usecases are for the consent
orgNameSubstitutionPatternThe pattern on which to perform substitution within consentDescription and consentTerms. Facilitates reusable consents across organisations.
validFromThe date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set the consent is in draft mode.
validToIf set, the date the consent base id valid to. Set the date to deactivate the consent. If not set the consent is active from validFrom and forever after
ConsentCrmResponse
consentBaseVersionThe consent base version associated with the consent
consentCodeThe consent code of the base consent associated with the consent
consentIdThe id of the Consent that has been consented
consentOrganisationIdThe organisation that owns the Consent. Typically an 'Operatør'
createdByOrgIdThe organisation through which the consent was given
customerNumberCustomer number, a unique identifier for the customer.
customerRefCustomer ref, a unique identifier for the customer within an organisation
givenConsentIdGiven consent id.
countryCodeThe telephone number country code
emailThe customer's email
fromStopPlaceThe stop place where the customer’s journey started, in NeTEx format.
lineRefReference to the customers journey line, in NeTEx format
originalDatedServiceJourneyIdUnique Id for a specific Service Journey, in NeTEx format with ENT as operator
telephoneNumberThe customer's telephone number
toStopPlaceThe stop place where the customer’s journey ended, in NeTEx format.
ConsentPatchRequest
validToIf set, the date the consent is valid to. Set the date to deactivate the consent. If not set the consent is active from validFrom and forever after
ConsentRequest
consentCodeConsent code. Use the consent code + consent base version to identify the consent base
isEmailSupportedWhether the organisation supports email as a contact method
isSmsSupportedWhether the organisation supports SMS as a contact method
organisationIdThe organisation the consent is valid for.
consentBaseVersionConsent base version for adding a consent to a specific version. If not provided, the latest version is used.
validFromIf set, the date the consent is valid from. Can only be set to a date after consent base validFrom. If not set, the consent base is in draft mode.
validToIf set, the date the consent is valid to. Set the date to deactivate the consent. Can only be set to a date before the consent base validTo. If not set the consent is active from validFrom and forever after.
ConsentResponse
changedAtWhen the consent was last changed. ISO 8601 date format
Consent base
consentCodeCode of the consent base
createdAtWhen the consent was created. ISO 8601 date format
idConsent ID.
isEmailSupportedWhether the organisation supports email as a contact method
isSmsSupportedWhether the organisation supports SMS as a contact method
organisationIdThe organisation the consent is valid for.
validFromIf set, the date the consent is valid from. Can only be set to a date after consent base validFrom. If not set, the consent base is in draft mode.
validToIf set, the date the consent is valid to. Set the date to deactivate the consent. Can only be set to a date before the consent base validTo. If not set the consent is active from validFrom and forever after.
ConsentTermsRequest
fullDescriptionText describing the terms in detail. The text can contain MarkDown
languageCodeISO-639-3 languageCode.
shortDescriptionShort text explaining the terms. The text can contain MarkDown
ConsentTermsResponse
fullDescriptionText describing the terms in detail. The text can contain MarkDown
languageCodeISO-639-3 language code. 3 characters
shortDescriptionShort text explaining the terms. The text can contain MarkDown
ErrorMessage
errorCodeThe error code.
longEnglishLong error message (English).
longNorwegianLong error message (Norwegian).
shortEnglishShort error message (English).
shortNorwegianShort error message (Norwegian).
GivenConsentBulkGetRequest
customerNumbersCustomer numbers to look up.
customerRefsCustomer references to look up.
GivenConsentBulkUpdateRequest
consentChoiceWhether this consent has been approved or rejected.
consentIdThe id of the consent defining what and to whom the customer has consented.
customerNumberThe customer number
expirationDateWhen the consent expires. ISO 8601 date format
countryCodeThe telephone number country code provided with the consent
customerRefCustomer reference. Note: If you do not provide a customer ref, the customer number will used as reference.
emailThe contact email provided with the consent.
fromStopPlaceThe stop place where the customer’s journey started, in NeTEx format.
lineRefReference to the customers journey line, in NeTEx format
originalDatedServiceJourneyIdUnique Id for a specific Service Journey, in NeTEx format with ENT as operator
telephoneNumberThe telephone number provided with the consent
toStopPlaceThe stop place where the customer’s journey ended, in NeTEx format.
GivenConsentPutRequest
consentChoiceWhether this consent has been approved or rejected.
expirationDateWhen the consent expires. ISO 8601 date format
countryCodeThe telephone number country code provided with the consent
emailThe contact email provided with the consent.
fromStopPlaceThe stop place where the customer’s journey started, in NeTEx format.
lineRefReference to the customers journey line, in NeTEx format
originalDatedServiceJourneyIdUnique Id for a specific Service Journey, in NeTEx format with ENT as operator
telephoneNumberThe telephone number provided with the consent
toStopPlaceThe stop place where the customer’s journey ended, in NeTEx format.
GivenConsentRequest
consentChoiceWhether this consent has been approved or rejected.
consentIdThe id of the consent defining what and to whom the customer has consented.
customerNumberCustomer number.
expirationDateWhen the consent expires. ISO 8601 date format
countryCodeThe telephone number country code provided with the consent
customerRefCustomer reference. Note: If you do not provide a customer reference, the customer number will used as reference.
emailThe contact email provided with the consent.
fromStopPlaceThe stop place where the customer’s journey started, in NeTEx format.
lineRefReference to the customers journey line, in NeTEx format
originalDatedServiceJourneyIdUnique Id for a specific Service Journey, in NeTEx format with ENT as operator
telephoneNumberThe telephone number provided with the consent
toStopPlaceThe stop place where the customer’s journey ended, in NeTEx format.
GivenConsentResponse
changedAtWhen the consent was last changed. ISO 8601 date format
Consent response, includes the consent base
consentChoiceWhether this consent has been approved or rejected.
consentIdThe id of the consent defining what the customer has consented.
createdAtWhen the consent was given. ISO 8601 date format
createdByOrgIdThe organisation through which the consent was given
customerNumberCustomer number. Entur number unique across organisations
distributionChannelDistribution channel through which the consent was given.
expirationDateWhen the consent expires. ISO 8601 date format
idUnique id for the given consent.
countryCodeThe telephone number country code provided with the consent
customerRefCustomer reference. External reference, unique within an organisation
emailThe contact email provided with the consent.
fromStopPlaceThe stop place where the customer’s journey started, in NeTEx format.
lineRefReference to the customers journey line, in NeTEx format
originalDatedServiceJourneyIdUnique Id for a specific Service Journey, in NeTEx format
telephoneNumberThe telephone number provided with the consent
toStopPlaceThe stop place where the customer’s journey ended, in NeTEx format.
InternalDescriptionRequest
languageCodeISO-639-3 languageCode. 3 characters
descriptionA description for the partner administrating consents. If the request is an update and this is set to null, the description for the language will be deleted