This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard
Retrieves a supplement products by organisation id
This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to idetify data owned by organisation
languageCodegpaDataSetType of gpa dataset
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 supplement products by organisation id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
vatGroupThe VAT group for the SupplementProduct.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation.
Reference to information about the fare.
Fare frame ref.
fareProductRef.
validityConditions.
accessRightParameterAssignments.
accessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
operatorRefThe reference to the operator.
privateCodePrivat code.
organisationIdOrganisation related to the userProfile
A summary of a condition.
fareStructureTypeFareStructureType
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
derivedFromVersionRefDerived from version.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
compatibleWithVersionRefCompatible with version.
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 SupplementProduct
This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard
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 SupplementProduct › 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.
FareTableRef.
ConditionSummary.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
fareStructureTypeFareStructureType.
chargingMomentTypeChargingMomentType.
Fare frame ref.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
supplementProductTypeSupplementProductType.
compatibleWithVersionRefCompatible with version.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignments.
Create a SupplementProduct › Responses
Entity created successfully
Retrieves all supplement products
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
minimizeDataLoadPossibility of opting out of including child elements
gpaDataSetType of gpa dataset
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 all supplement products › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
nameOfClassName of class.
operatorRefThe reference to the operator.
Fare frame ref.
modificationModification status.
organisationRefThe reference to the organisation.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
privateCodePrivat code.
Reference to information about the fare.
A summary of a condition.
vatGroupRegisterThe VAT group for the SupplementProduct.
fareStructureTypeFareStructureType
chargingMomentTypeChargingMomentType.
validityConditions.
Fare frame ref.
accessRightParameterAssignments.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
accessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Creates a new supplement product
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
Creates a new supplement product › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
nameOfClassName of class.
operatorRefThe reference to the operator.
Fare frame ref.
modificationModification status.
organisationRefThe reference to the organisation.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
privateCodePrivat code.
Reference to information about the fare.
A summary of a condition.
vatGroupRegisterThe VAT group for the SupplementProduct.
fareStructureTypeFareStructureType
chargingMomentTypeChargingMomentType.
validityConditions.
Fare frame ref.
accessRightParameterAssignments.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
accessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Creates a new supplement product › Responses
Returns the created supplement product
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
nameOfClassName of class.
operatorRefThe reference to the operator.
Fare frame ref.
modificationModification status.
organisationRefThe reference to the organisation.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
privateCodePrivat code.
Reference to information about the fare.
A summary of a condition.
vatGroupRegisterThe VAT group for the SupplementProduct.
fareStructureTypeFareStructureType
chargingMomentTypeChargingMomentType.
validityConditions.
Fare frame ref.
accessRightParameterAssignments.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
accessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Retrieves the latest version of supplement products by id
This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard
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.
Retrieves the latest version of supplement products by id › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
vatGroupThe VAT group for the SupplementProduct.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation.
Reference to information about the fare.
Fare frame ref.
fareProductRef.
validityConditions.
accessRightParameterAssignments.
accessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
operatorRefThe reference to the operator.
privateCodePrivat code.
organisationIdOrganisation related to the userProfile
A summary of a condition.
fareStructureTypeFareStructureType
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
derivedFromVersionRefDerived from version.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
compatibleWithVersionRefCompatible with version.
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 latest version of supplement product by id
This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard
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 supplement product by id › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
vatGroupThe VAT group for the SupplementProduct.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation.
Reference to information about the fare.
Fare frame ref.
fareProductRef.
validityConditions.
accessRightParameterAssignments.
accessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
operatorRefThe reference to the operator.
privateCodePrivat code.
organisationIdOrganisation related to the userProfile
A summary of a condition.
fareStructureTypeFareStructureType
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
derivedFromVersionRefDerived from version.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
compatibleWithVersionRefCompatible with version.
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
This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a fareProduct
query Parameters
versionlanguageCodethe 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 supplement product by id and version
This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard
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 supplement product by id and version › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
vatGroupThe VAT group for the SupplementProduct.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation.
Reference to information about the fare.
Fare frame ref.
fareProductRef.
validityConditions.
accessRightParameterAssignments.
accessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
operatorRefThe reference to the operator.
privateCodePrivat code.
organisationIdOrganisation related to the userProfile
A summary of a condition.
fareStructureTypeFareStructureType
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
derivedFromVersionRefDerived from version.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
compatibleWithVersionRefCompatible with version.
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 supplement product parameter.
This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard
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 supplement 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.
FareTableRef.
ConditionSummary.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
fareStructureTypeFareStructureType.
chargingMomentTypeChargingMomentType.
Fare frame ref.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
supplementProductTypeSupplementProductType.
compatibleWithVersionRefCompatible with version.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignments.
Update a supplement product parameter. › Responses
Entity updated successfully
Retrieves all versions of a supplement product
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a supplement product
query Parameters
activeIf value is set to true only active versions will be returned, otherwise all versions will be 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> 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 versions of a supplement product › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
nameOfClassName of class.
operatorRefThe reference to the operator.
Fare frame ref.
modificationModification status.
organisationRefThe reference to the organisation.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
privateCodePrivat code.
Reference to information about the fare.
A summary of a condition.
vatGroupRegisterThe VAT group for the SupplementProduct.
fareStructureTypeFareStructureType
chargingMomentTypeChargingMomentType.
validityConditions.
Fare frame ref.
accessRightParameterAssignments.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
accessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Retrieves a supplement product by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a supplement product
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the supplement product
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
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 supplement product by id and version › Responses
Returns the supplement product
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
nameOfClassName of class.
operatorRefThe reference to the operator.
Fare frame ref.
modificationModification status.
organisationRefThe reference to the organisation.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
privateCodePrivat code.
Reference to information about the fare.
A summary of a condition.
vatGroupRegisterThe VAT group for the SupplementProduct.
fareStructureTypeFareStructureType
chargingMomentTypeChargingMomentType.
validityConditions.
Fare frame ref.
accessRightParameterAssignments.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
accessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Updates an existing supplement product
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a supplement product
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the supplement product
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
Updates an existing supplement product › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusSupplement product status.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
nameOfClassName of class.
operatorRefThe reference to the operator.
Fare frame ref.
modificationModification status.
organisationRefThe reference to the organisation.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
privateCodePrivat code.
Reference to information about the fare.
A summary of a condition.
vatGroupRegisterThe VAT group for the SupplementProduct.
fareStructureTypeFareStructureType
chargingMomentTypeChargingMomentType.
validityConditions.
Fare frame ref.
accessRightParameterAssignments.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
accessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Updates an existing supplement product › Responses
Entity updated successfully