Retrieves a preassignedFareProduct by organisation id
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to idetify data owned by organisation
languageCodegpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.
validOnDateReturn the PreassignedFareProducts valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED PreassignedFareProducts are returned. And in the staging environment, PROPOSED PreassignedFareProducts are preferred to VERSIONED ones. Mutually exclusive with statusFilter.
languagethe unique id for the language
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 a preassignedFareProduct by organisation id › Responses
Returns the info
AccessRightParameterAssignments.
AccessRightsInProduct.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
ValidityCondition.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivateCode.
productTypeThe type of fare product.
A classification of FARE PRODUCTs.
version^([A-Z]{3}):([A-Za-z…Version.
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
Create a PreassignedFareProduct
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 a PreassignedFareProduct › Request Body
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
operatorRef^([A-Z]{3}):([A-Za-z… · requiredOperatorRef.
organisationOrganisation.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
ConditionSummary.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Fare prices.
privateCodePrivateCode.
productTypeThe type of fare product.
Fare frame ref.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
Create a PreassignedFareProduct › Responses
Entity created successfully
Retrieves the number of preassignedFareProducts. Limiting selection by fareFrameId and orgId parameter is supported
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to idetify data owned by organisation
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.
validOnDateCount PreassignedFareProducts valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED PreassignedFareProducts are counted. And in the staging environment, PROPOSED PreassignedFareProducts are preferred to VERSIONED ones. Mutually exclusive with statusFilter.
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 the number of preassignedFareProducts. Limiting selection by fareFrameId and orgId parameter is supported › Responses
Retrieves preassignedFareProducts for a given page. Limiting selection by fareFrameId and orgId parameter is supported
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to idetify data owned by organisation
languageCodegpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
pageSizeNumber of elements listed in requested page
pageNumberThe given page one want in return
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.
validOnDateReturn the PreassignedFareProducts valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED PreassignedFareProducts are returned. And in the staging environment, PROPOSED PreassignedFareProducts are preferred to VERSIONED ones. Mutually exclusive with statusFilter.
languagethe unique id for the language
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 preassignedFareProducts for a given page. Limiting selection by fareFrameId and orgId parameter is supported › Responses
Returns the info
Preassigned fare products for the given page
requestedPageNumberRequested page number.
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
Retrieve the latest version of preassignedFareProduct by id
path Parameters
idThe unique id to identify a product
query Parameters
versionThe id of the version of the fare structure element
languageCodeThe language code from ISO-639-3
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
validOnDateReturn the version valid on the given date (ISO-8601). Overrides 'version'. In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.
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.
Retrieve the latest version of preassignedFareProduct by id › Responses
Returns the resource
AccessRightParameterAssignments.
AccessRightsInProduct.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
ValidityCondition.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivateCode.
productTypeThe type of fare product.
A classification of FARE PRODUCTs.
version^([A-Z]{3}):([A-Za-z…Version.
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
Retrives refunding rules by fare product id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a fareProduct
query Parameters
version^([A-Z]{3}):([A-Za-z… · required · style: form · explode: truelanguageCodethe unique id for the language
productVersionIdThe version of the fareProduct
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.
Retrives refunding rules by fare product id and version › Responses
Returns the info
allowedAllowed.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusRefunding status.
version^([A-Z]{3}):([A-Za-z… · requiredRefunding version.
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.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
hasFeeHas fee.
limitingRulePricing rule.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Prices in different currencies for the refunding rule.
refundBasisBasis on which refund is made. See allowed values below.
refundTypeRefund type.
resellWhenEvent marking when the refundable status of the ticket changes.
unusedTicketsOnlyUnused tickets only.
Retrieves the latest version of preassignedFareProduct by id and version
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 id of the version of the fare structure element
query Parameters
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
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 the latest version of preassignedFareProduct by id and version › Responses
Returns the resource
AccessRightParameterAssignments.
AccessRightsInProduct.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
ValidityCondition.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivateCode.
productTypeThe type of fare product.
A classification of FARE PRODUCTs.
version^([A-Z]{3}):([A-Za-z…Version.
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
Update a preassigned fare product parameter.
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 id of the version of the fare structure 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
Update a preassigned fare product parameter. › Request Body
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
operatorRef^([A-Z]{3}):([A-Za-z… · requiredOperatorRef.
organisationOrganisation.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
ConditionSummary.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Fare prices.
privateCodePrivateCode.
productTypeThe type of fare product.
Fare frame ref.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
Update a preassigned fare product parameter. › Responses
Entity updated successfully
Retrieves the latest version of preassignedFareProduct by id
path Parameters
idThe unique id to identify a product
query Parameters
startDateendDatestatusThe version status of the product
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
fromDateThe from date of the products version
toDateThe to date of the products 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 the latest version of preassignedFareProduct by id › Responses
Returns the resource
AccessRightParameterAssignments.
AccessRightsInProduct.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
ValidityCondition.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivateCode.
productTypeThe type of fare product.
A classification of FARE PRODUCTs.
version^([A-Z]{3}):([A-Za-z…Version.
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.