Retrieves a preassignedFareProduct by organisation id
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to idetify data owned by organisation
languageCodegpaDataSetType of gpa dataset
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.
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> 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 preassignedFareProduct by organisation id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
operatorRefOperatorRef.
privateCodePrivateCode.
productTypeThe type of fare product.
organisationOrganisation who own the product.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a PreassignedFareProduct › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
operatorRef^([A-Z]{3}):([A-Za-z… · requiredOperatorRef.
Fare frame ref.
organisationOrganisation.
Fare frame ref.
Fare prices.
Description.
privateCodePrivateCode.
productTypeThe type of fare product.
FareTableRef.
ConditionSummary.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
fareStructureTypeFareStructureType.
chargingMomentTypeChargingMomentType.
Fare frame ref.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignments.
Create a PreassignedFareProduct › Responses
Entity created successfully
Retrieve the latest version of preassignedFareProduct by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe 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
gpaDataSetType of gpa dataset
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.
Retrieve the latest version of preassignedFareProduct by id › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
operatorRefOperatorRef.
privateCodePrivateCode.
productTypeThe type of fare product.
organisationOrganisation who own the product.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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.
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.
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 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
languageCodegpaDataSetType of gpa dataset
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.
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> 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 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
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
requestedPageNumberRequested page number.
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
gpaDataSetType of gpa dataset
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> 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 the latest version of preassignedFareProduct by id › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
operatorRefOperatorRef.
privateCodePrivateCode.
productTypeThe type of fare product.
organisationOrganisation who own the product.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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> 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.
Retrives refunding rules by fare product 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.
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
gpaDataSetType of gpa dataset
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 the latest version of preassignedFareProduct by id and version › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
operatorRefOperatorRef.
privateCodePrivateCode.
productTypeThe type of fare product.
organisationOrganisation who own the product.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update a preassigned fare product parameter. › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
operatorRef^([A-Z]{3}):([A-Za-z… · requiredOperatorRef.
Fare frame ref.
organisationOrganisation.
Fare frame ref.
Fare prices.
Description.
privateCodePrivateCode.
productTypeThe type of fare product.
FareTableRef.
ConditionSummary.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
fareStructureTypeFareStructureType.
chargingMomentTypeChargingMomentType.
Fare frame ref.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignments.
Update a preassigned fare product parameter. › Responses
Entity updated successfully