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> for companies, and <personal name>-<application> for individuals.
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
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusReserving status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare tables.
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reserving rule.
feeBasisFee basis.
Description represented in different languages. Language codes are ISO-639.
A LimitingRule
Fare frame ref.
typeOfUsageParameterType of usage parameter for the reservation.
derivedFromVersionRefDerived from version.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
compatibleWithVersionRefCompatible with version.
mustReserveWholeCompartmentMust reserve whole compartment
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a reserving rule › Request Body
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.
Fare frame ref.
Prices for the reserving.
feeBasisFee basis.
Description represented in different languages. Language codes are ISO-639.
typeOfUsageParameterType of usage parameter for the reservation.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
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> for companies, and <personal name>-<application> for individuals.
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.
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusReserving status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare tables.
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reserving rule.
feeBasisFee basis.
Description represented in different languages. Language codes are ISO-639.
A LimitingRule
Fare frame ref.
typeOfUsageParameterType of usage parameter for the reservation.
derivedFromVersionRefDerived from version.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
compatibleWithVersionRefCompatible with version.
mustReserveWholeCompartmentMust reserve whole compartment
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> for companies, and <personal name>-<application> for individuals.
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.
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusReserving status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare tables.
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reserving rule.
feeBasisFee basis.
Description represented in different languages. Language codes are ISO-639.
A LimitingRule
Fare frame ref.
typeOfUsageParameterType of usage parameter for the reservation.
derivedFromVersionRefDerived from version.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
compatibleWithVersionRefCompatible with version.
mustReserveWholeCompartmentMust reserve whole compartment
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> for companies, and <personal name>-<application> for individuals.
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.
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusReserving status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare tables.
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reserving rule.
feeBasisFee basis.
Description represented in different languages. Language codes are ISO-639.
A LimitingRule
Fare frame ref.
typeOfUsageParameterType of usage parameter for the reservation.
derivedFromVersionRefDerived from version.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
compatibleWithVersionRefCompatible with version.
mustReserveWholeCompartmentMust reserve whole compartment
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update a reserving rule › Request Body
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.
Fare frame ref.
Prices for the reserving.
feeBasisFee basis.
Description represented in different languages. Language codes are ISO-639.
typeOfUsageParameterType of usage parameter for the reservation.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
Update a reserving rule › Responses
Entity updated successfully