Retrieves all exchanging rules
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify dataset to an organization
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-LanguageLanguagecodeThe language code for the name and description fields.
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 exchanging rules › 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.
Create an exchanging 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 an exchanging 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… · requiredUsageValidityPeriod version.
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.
exchangeableFromDurationExchangeable from duration.
exchangeableToType of exchange allowed.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
hasFeeHas fee.
numberOfExchangesAllowedNumber of times a ticket may be exchanged.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Fare prices.
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.
Create an exchanging rule › Responses
Entity created successfully
Retrieves an exchanging rule by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify an exchanging
query Parameters
versionThe id for the version of the purchase window
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 an exchanging rule by id › Responses
Returns the info
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 an exchanging rule by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify an exchanging
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the exchanging
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 an exchanging rule by id and version › Responses
Returns the info
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.
Update exchanging rule
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify an exchanging
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the exchanging
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 exchanging 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… · requiredUsageValidityPeriod version.
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.
exchangeableFromDurationExchangeable from duration.
exchangeableToType of exchange allowed.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
hasFeeHas fee.
numberOfExchangesAllowedNumber of times a ticket may be exchanged.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Fare prices.
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.
Update exchanging rule › Responses
Entity updated successfully
Retrieves a exchanging rule by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a exchanging
query Parameters
startDateendDatestatusThe version status of the exchanging rule
fromDateThe from date of the exchanging rules version
toDateThe to date of the exchanging rules 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 exchanging rule by id › Responses
Returns the info
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.