Retrieves all reserving rules
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify dataset to an organization
languageCodeThe language code from ISO-639-3
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>.
X-Correlation-IdCorrelation id
If-None-MatchUsed to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
Retrieves all reserving rules › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusReserving status.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
feeBasisFee basis.
A LimitingRule
Fare frame ref.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reserving rule.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
typeOfUsageParameterType of usage parameter for the reservation.
Create a reserving rule
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>.
X-Correlation-IdCorrelation id
Create a reserving rule › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
Description represented in different languages. Language codes are ISO-639.
feeBasisFee basis.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
Prices for the reserving.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
typeOfUsageParameterType of usage parameter for the reservation.
Create a reserving rule › Responses
Entity created successfully
Retrieves a reserving rule by ID.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique ID to identify a reserving.
query Parameters
versionThe ID for the version of the reservation.
languageCodeThe language code from ISO-639-3.
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>.
X-Correlation-IdCorrelation id
If-None-MatchUsed to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
Retrieves a reserving rule by ID. › Responses
Returns the reserving.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusReserving status.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
feeBasisFee basis.
A LimitingRule
Fare frame ref.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reserving rule.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
typeOfUsageParameterType of usage parameter for the reservation.
Retrieves a reserving rule by id and version.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique ID to identify a reserving.
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe ID for the version of the reservation.
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>.
X-Correlation-IdCorrelation id
Accept-LanguageThe language code from ISO-639-3
If-None-MatchUsed to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
Retrieves a reserving rule by id and version. › Responses
Returns the reserving.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusReserving status.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
feeBasisFee basis.
A LimitingRule
Fare frame ref.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reserving rule.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
typeOfUsageParameterType of usage parameter for the reservation.
Update a reserving rule
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique ID to identify a reserving.
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe ID for the version of the reservation.
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>.
X-Correlation-IdCorrelation id
Update a reserving rule › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
Description represented in different languages. Language codes are ISO-639.
feeBasisFee basis.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
Prices for the reserving.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
typeOfUsageParameterType of usage parameter for the reservation.
Update a reserving rule › Responses
Entity updated successfully
Retrieves a reserving rule by ID
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique ID to identify a reserving.
query Parameters
startDateendDatestatusThe version status of the reserving rule.
fromDateThe from date of the reserving rule version.
toDateThe to date of the reserving rule version.
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>.
X-Correlation-IdCorrelation id
Accept-LanguageThe language code from ISO-639-3.
If-None-MatchUsed to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
Retrieves a reserving rule by ID › Responses
Returns the reserving rule.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusReserving status.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
feeBasisFee basis.
A LimitingRule
Fare frame ref.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reserving rule.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
typeOfUsageParameterType of usage parameter for the reservation.