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
languageCodegpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
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 supplement products by organisation id › Responses
Returns the info
accessRightParameterAssignments.
accessRightParameterAssignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fareProductRef.
Reference to information about the fare.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
organisationOrganisation.
Fare frame ref.
statusSupplement product status.
validityConditions.
vatGroupThe VAT group for the SupplementProduct.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Name represented in different languages. Language codes are ISO-639.
operatorRefThe reference to the operator.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
A classification of FARE PRODUCTs.
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>.
X-Correlation-IdCorrelation id
Create a SupplementProduct › 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.
supplementProductTypeSupplementProductType.
Fare frame ref.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
Create a SupplementProduct › Responses
Entity created successfully
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
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
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
accessRightParameterAssignments.
accessRightParameterAssignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fareProductRef.
Reference to information about the fare.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
organisationOrganisation.
Fare frame ref.
statusSupplement product status.
validityConditions.
vatGroupThe VAT group for the SupplementProduct.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Name represented in different languages. Language codes are ISO-639.
operatorRefThe reference to the operator.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
A classification of FARE PRODUCTs.
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>.
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 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
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 supplement product by id and version › Responses
Returns the resource
accessRightParameterAssignments.
accessRightParameterAssignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fareProductRef.
Reference to information about the fare.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
organisationOrganisation.
Fare frame ref.
statusSupplement product status.
validityConditions.
vatGroupThe VAT group for the SupplementProduct.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Name represented in different languages. Language codes are ISO-639.
operatorRefThe reference to the operator.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
A classification of FARE PRODUCTs.
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>.
X-Correlation-IdCorrelation id
Update a supplement 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.
supplementProductTypeSupplementProductType.
Fare frame ref.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
Update a supplement product parameter. › Responses
Entity updated successfully
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
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 supplement product by id › Responses
Returns the resource
accessRightParameterAssignments.
accessRightParameterAssignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fareProductRef.
Reference to information about the fare.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
organisationOrganisation.
Fare frame ref.
statusSupplement product status.
validityConditions.
vatGroupThe VAT group for the SupplementProduct.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Name represented in different languages. Language codes are ISO-639.
operatorRefThe reference to the operator.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
A classification of FARE PRODUCTs.
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 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
gpaDataSetDeprecated: 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 SupplementProducts valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED SupplementProducts are returned. And in the staging environment, PROPOSED SupplementProducts 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 all supplement products › Responses
Returns the info
changedChanged datetime.
Fare frame ref.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
operatorRefThe reference to the operator.
organisationRefThe reference to the organisation.
statusSupplement product status.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
accessRightParameterAssignments.
accessRightParameterAssignments.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
A summary of a condition.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Reference to information about the fare.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
Fare frame ref.
validityConditions.
vatGroupRegisterThe VAT group for the SupplementProduct.
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>.
X-Correlation-IdCorrelation id
Creates a new supplement product › Request Body
changedChanged datetime.
Fare frame ref.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
operatorRefThe reference to the operator.
organisationRefThe reference to the organisation.
statusSupplement product status.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
accessRightParameterAssignments.
accessRightParameterAssignments.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
A summary of a condition.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Reference to information about the fare.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
Fare frame ref.
validityConditions.
vatGroupRegisterThe VAT group for the SupplementProduct.
Creates a new supplement product › Responses
Returns the created supplement product
changedChanged datetime.
Fare frame ref.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
operatorRefThe reference to the operator.
organisationRefThe reference to the organisation.
statusSupplement product status.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
accessRightParameterAssignments.
accessRightParameterAssignments.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
A summary of a condition.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Reference to information about the fare.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
Fare frame ref.
validityConditions.
vatGroupRegisterThe VAT group for the SupplementProduct.
Retrieves the supplement product valid on a given date
Requires validOnDate query parameter. In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.
path Parameters
idThe id to identify a supplement product
query Parameters
validOnDateReturn the version valid on the given date (ISO-8601).
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
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 supplement product valid on a given date › Responses
Returns the supplement product
changedChanged datetime.
Fare frame ref.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
operatorRefThe reference to the operator.
organisationRefThe reference to the organisation.
statusSupplement product status.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
accessRightParameterAssignments.
accessRightParameterAssignments.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
A summary of a condition.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Reference to information about the fare.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
Fare frame ref.
validityConditions.
vatGroupRegisterThe VAT group for the SupplementProduct.
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>.
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
changedChanged datetime.
Fare frame ref.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
operatorRefThe reference to the operator.
organisationRefThe reference to the organisation.
statusSupplement product status.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
accessRightParameterAssignments.
accessRightParameterAssignments.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
A summary of a condition.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Reference to information about the fare.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
Fare frame ref.
validityConditions.
vatGroupRegisterThe VAT group for the SupplementProduct.
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
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
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
changedChanged datetime.
Fare frame ref.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
operatorRefThe reference to the operator.
organisationRefThe reference to the organisation.
statusSupplement product status.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
accessRightParameterAssignments.
accessRightParameterAssignments.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
A summary of a condition.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Reference to information about the fare.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
Fare frame ref.
validityConditions.
vatGroupRegisterThe VAT group for the SupplementProduct.
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>.
X-Correlation-IdCorrelation id
Updates an existing supplement product › Request Body
changedChanged datetime.
Fare frame ref.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
operatorRefThe reference to the operator.
organisationRefThe reference to the organisation.
statusSupplement product status.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
accessRightParameterAssignments.
accessRightParameterAssignments.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
A summary of a condition.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Reference to information about the fare.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
Fare frame ref.
validityConditions.
vatGroupRegisterThe VAT group for the SupplementProduct.
Updates an existing supplement product › Responses
Entity updated successfully