Preferences admin
Api for creating, fetching, modifying and deleting preferences a customer can have
List all preferences
Get the list of all supported preferences. This list will include inactive preferences.
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
List all preferences › Responses
OK
Add preference
Add a preference to the database.
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
Add preference › Request Body
isActiveWhether the preference is active.
preferenceCodeThe preference code.
preferenceTypeType of preference.
preferenceDescriptionA description of the preference.
Add preference › Responses
OK
idPreference id.
isActiveWhether the preference is active.
changedAtWhen the preference was last changed. ISO 8601 date format
createdAtWhen the preference was created. ISO 8601 date format
preferenceCodeThe preference code.
preferenceTypeType of preference.
preferenceDescriptionA description of the preference.
Find Preference by id
Get a specific preference by Id.
path Parameters
preferenceIdHeaders
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 Preference by id › Responses
OK
idPreference id.
isActiveWhether the preference is active.
changedAtWhen the preference was last changed. ISO 8601 date format
createdAtWhen the preference was created. ISO 8601 date format
preferenceCodeThe preference code.
preferenceTypeType of preference.
preferenceDescriptionA description of the preference.
Update preference
Update the fields of an existing preference. All values are stored and overrides current values.
path Parameters
preferenceIdHeaders
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
Update preference › Request Body
isActiveWhether the preference is active.
preferenceCodeThe preference code.
preferenceTypeType of preference.
preferenceDescriptionA description of the preference.
Update preference › Responses
OK
idPreference id.
isActiveWhether the preference is active.
changedAtWhen the preference was last changed. ISO 8601 date format
createdAtWhen the preference was created. ISO 8601 date format
preferenceCodeThe preference code.
preferenceTypeType of preference.
preferenceDescriptionA description of the preference.