Manage EntitlementRequired instances. Defines what existing entitlement (e.g., a valid ticket) is required to purchase a product.
List entitlement required instances
Returns a paginated list of all EntitlementRequired instances.
query Parameters
pageZero-based page number. Defaults to 0.
sizeNumber of instances per page. Defaults to 100.
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 entitlement required instances › Responses
Paginated list of EntitlementRequired instances
pageCurrent zero-based page number.
sizeNumber of instances per page.
totalCountTotal number of EntitlementRequired instances.
Create an entitlement required instance
Create a new EntitlementRequired instance.
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
Create an entitlement required instance › Request Body
fareProductRef^([A-Z]{3}):Preassig… · requiredReference to the fare product that satisfies this entitlement.
entitlementTypeThe type of entitlement that is required.
Create an entitlement required instance › Responses
EntitlementRequired instance created successfully
id^([A-Z]{3}):Entitlem… · requiredThe NeTEx ID of this EntitlementRequired.
fareProductRef^([A-Z]{3}):Preassig… · requiredReference to the fare product that satisfies this entitlement.
entitlementTypeThe type of entitlement that is required.
Get an entitlement required instance
Retrieve the full detail of a single EntitlementRequired instance.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe netex ID of the element to retrieve
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
Get an entitlement required instance › Responses
EntitlementRequired instance found
id^([A-Z]{3}):Entitlem… · requiredThe NeTEx ID of this EntitlementRequired.
fareProductRef^([A-Z]{3}):Preassig… · requiredReference to the fare product that satisfies this entitlement.
entitlementTypeThe type of entitlement that is required.
Update an entitlement required instance
Update an existing EntitlementRequired instance.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe netex ID of the element to retrieve
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
Update an entitlement required instance › Request Body
fareProductRef^([A-Z]{3}):Preassig… · requiredReference to the fare product that satisfies this entitlement.
entitlementTypeThe type of entitlement that is required.
Update an entitlement required instance › Responses
EntitlementRequired instance updated successfully
id^([A-Z]{3}):Entitlem… · requiredThe NeTEx ID of this EntitlementRequired.
fareProductRef^([A-Z]{3}):Preassig… · requiredReference to the fare product that satisfies this entitlement.
entitlementTypeThe type of entitlement that is required.