Retrieves exchanging rules for given elements
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 for the name and description fields.
Entur-Distribution-ChannelThe id of the distribution channel.
Retrieves exchanging rules for given elements › Request Body
Fare structure elements the user wants to retrieve the parameter alternatives for.
Preassigned products the user wants to retrieve the parameter alternatives for.
Sales packages the user wants to retrieve the parameter alternatives for.
Validable elements the user wants to retrieve the parameter alternatives for.
Retrieves exchanging rules for given elements › Responses
Returns the resource.
Exchanging alternatives for this element.
Describes the ID and version of an element.
Retrieves exchanging rules for given elements
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a fare structure element.
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe version of the element.
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 for the name and description fields.
Entur-Distribution-ChannelThe id of the distribution channel.
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 exchanging rules for given elements › Responses
Returns the resource.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusExchanging status.
allowedAllowed.
canChangeClassWhether user can change class.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationDuration to start of period before (negative) or after (positive) the trigger point resellWhen (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) or that ticket may be exchanged or refunded.
exchangeableToType of exchange allowed.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationDuration to end of period before (negative) or after ( positive) the trigger point (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) that ticket may be exchanged or refunded.
References for associated fare tables.
hasFeeHas fee.
A LimitingRule
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
numberOfExchangesAllowedNumber of times a ticket may be exchanged.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Prices in different currencies for the exchanging rule.
refundBasisBasis on which refund is made. See allowed values below.
resellWhenEvent marking when the exchangeable status of the ticket changes.
specifiedProductsReference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'
toFareClassFare class to which can be exchanged.
unusedTicketsOnlyUnused tickets only.
version^([A-Z]{3}):([A-Za-z…Exchanging version.
Retrieves exchanging rules for given elements
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a product.
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe version of the element.
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 for the name and description fields.
Entur-Distribution-ChannelThe id of the distribution channel.
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 exchanging rules for given elements › Responses
Returns the resource.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusExchanging status.
allowedAllowed.
canChangeClassWhether user can change class.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationDuration to start of period before (negative) or after (positive) the trigger point resellWhen (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) or that ticket may be exchanged or refunded.
exchangeableToType of exchange allowed.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationDuration to end of period before (negative) or after ( positive) the trigger point (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) that ticket may be exchanged or refunded.
References for associated fare tables.
hasFeeHas fee.
A LimitingRule
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
numberOfExchangesAllowedNumber of times a ticket may be exchanged.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Prices in different currencies for the exchanging rule.
refundBasisBasis on which refund is made. See allowed values below.
resellWhenEvent marking when the exchangeable status of the ticket changes.
specifiedProductsReference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'
toFareClassFare class to which can be exchanged.
unusedTicketsOnlyUnused tickets only.
version^([A-Z]{3}):([A-Za-z…Exchanging version.
Retrieves exchanging rules for given elements
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a sales package.
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe version of the element.
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 for the name and description fields.
Entur-Distribution-ChannelThe id of the distribution channel.
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 exchanging rules for given elements › Responses
Returns the resource.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusExchanging status.
allowedAllowed.
canChangeClassWhether user can change class.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationDuration to start of period before (negative) or after (positive) the trigger point resellWhen (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) or that ticket may be exchanged or refunded.
exchangeableToType of exchange allowed.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationDuration to end of period before (negative) or after ( positive) the trigger point (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) that ticket may be exchanged or refunded.
References for associated fare tables.
hasFeeHas fee.
A LimitingRule
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
numberOfExchangesAllowedNumber of times a ticket may be exchanged.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Prices in different currencies for the exchanging rule.
refundBasisBasis on which refund is made. See allowed values below.
resellWhenEvent marking when the exchangeable status of the ticket changes.
specifiedProductsReference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'
toFareClassFare class to which can be exchanged.
unusedTicketsOnlyUnused tickets only.
version^([A-Z]{3}):([A-Za-z…Exchanging version.
Retrieves exchanging rules for given elements
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a validable element.
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe version of the element.
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 for the name and description fields.
Entur-Distribution-ChannelThe id of the distribution channel.
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 exchanging rules for given elements › Responses
Returns the resource.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusExchanging status.
allowedAllowed.
canChangeClassWhether user can change class.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationDuration to start of period before (negative) or after (positive) the trigger point resellWhen (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) or that ticket may be exchanged or refunded.
exchangeableToType of exchange allowed.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationDuration to end of period before (negative) or after ( positive) the trigger point (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) that ticket may be exchanged or refunded.
References for associated fare tables.
hasFeeHas fee.
A LimitingRule
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
numberOfExchangesAllowedNumber of times a ticket may be exchanged.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Prices in different currencies for the exchanging rule.
refundBasisBasis on which refund is made. See allowed values below.
resellWhenEvent marking when the exchangeable status of the ticket changes.
specifiedProductsReference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'
toFareClassFare class to which can be exchanged.
unusedTicketsOnlyUnused tickets only.
version^([A-Z]{3}):([A-Za-z…Exchanging version.