Retrieves all refundings
query Parameters
orgIdThe unique id to identify a 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 refundings › Responses
Returns the info
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.
Create a refunding rules
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 refunding rules › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
allowedAllowed.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
Fare frame ref.
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.
canChangeClassWhether user can change class.
unusedTicketsOnlyUnused tickets only.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationExchangeable from duration.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Create a refunding rules › Responses
Entity created successfully
Retrieves a refunding rule by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a refunding
query Parameters
versionThe id for the version of the refunding
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 refunding rule by id › Responses
Returns the info
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 a refunding rule by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a refunding
query Parameters
startDateendDatestatusThe version status of the refunding rule
fromDateThe from date of the refunding rules version
toDateThe to date of the refunding 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> 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 refunding rule by id › Responses
Returns the info
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 a refunding rule by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a refunding
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the refunding
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 refunding rule by id and version › Responses
Returns the info
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.
Update a refunding rule
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a refunding
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the refunding
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 refunding rule › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
allowedAllowed.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
Fare frame ref.
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.
canChangeClassWhether user can change class.
unusedTicketsOnlyUnused tickets only.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationExchangeable from duration.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Update a refunding rule › Responses
Entity updated successfully