Retrieves refunding 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Accept-LanguageThe language code for the name and description fields.
Entur-Distribution-ChannelThe id of the distribution channel.
Retrieves refunding rules for given elements › Request Body
Sales packages the user wants to retrieve the parameter alternatives for.
Validable elements the user wants to retrieve the parameter alternatives for.
Fare structure elements the user wants to retrieve the parameter alternatives for.
Preassigned products the user wants to retrieve the parameter alternatives for.
Retrieves refunding rules for given elements › Responses
Returns the resource.
Describes the ID and version of an element.
Refunding alternatives for this element.
Retrieves refunding rules for given elements
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique 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> for companies, and <personal name>-<application> for individuals.
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 refunding rules for given elements › Responses
Returns the resource.
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusRefunding status.
allowedAllowed.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredRefunding version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare tables.
Name represented in different languages. Language codes are ISO-639.
hasFeeHas fee.
Prices in different currencies for the refunding rule.
refundTypeRefund type.
resellWhenEvent marking when the refundable status of the ticket changes.
Description represented in different languages. Language codes are ISO-639.
refundBasisBasis on which refund is made. See allowed values below.
limitingRulePricing rule.
canChangeClassWhether user can change class.
Fare frame ref.
unusedTicketsOnlyUnused tickets only.
derivedFromVersionRefDerived from version.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
compatibleWithVersionRefCompatible with version.
exchangeableFromDurationExchangeable from duration.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Retrieves refunding rules for given elements
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique 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> for companies, and <personal name>-<application> for individuals.
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 refunding rules for given elements › Responses
Returns the resource.
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusRefunding status.
allowedAllowed.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredRefunding version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare tables.
Name represented in different languages. Language codes are ISO-639.
hasFeeHas fee.
Prices in different currencies for the refunding rule.
refundTypeRefund type.
resellWhenEvent marking when the refundable status of the ticket changes.
Description represented in different languages. Language codes are ISO-639.
refundBasisBasis on which refund is made. See allowed values below.
limitingRulePricing rule.
canChangeClassWhether user can change class.
Fare frame ref.
unusedTicketsOnlyUnused tickets only.
derivedFromVersionRefDerived from version.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
compatibleWithVersionRefCompatible with version.
exchangeableFromDurationExchangeable from duration.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Retrieves refunding rules for given elements
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique 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> for companies, and <personal name>-<application> for individuals.
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 refunding rules for given elements › Responses
Returns the resource.