Retrieves a preassignedFareProduct by organisation id
query Parameters
orgIdfareFrameIdThe unique id to identify a dataset for an organization
languageCodegpaDataSetDeprecated: 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 preassignedFareProduct by organisation id › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fare table reference
geographical interval sequence
geographical structure factor refs
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
Access Right Parameter assignments.
quality structure factor refs
statusStatus.
ValidityConditions sequence.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description.
A LimitingRule
Name.
organisationIdOrganisation related to the userProfile
Fare prices.
tariffBasisTariff basis.
version^([A-Z]{3}):([A-Za-z…Version.
Field is deprecated. Distance matrix elements should be connected by a 'geographical structure factor'
Create a 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
Create a Fare structure element › Request Body
Fare frame ref.
fare table reference
geographical interval sequence
id^([A-Z]{3}):([A-Za-z… · requiredId.
Access Right Parameter assignments.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description.
geographicalStructureFactorIdGeographical structure factor id
Name.
Fare prices.
tariffBasisTariff basis.
version^([A-Z]{3}):([A-Za-z…Version.
Field is deprecated. Use 'geographical structure factor' instead to connect 'distance matrix elements' to 'fare structure element'
Create a Fare structure element › Responses
Entity created successfully
Retrieves the total number of fare structure elements. Limiting selection by fareFrameId or 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 FareStructureElements valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED FareStructureElements are counted. And in the staging environment, PROPOSED FareStructureElements 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 total number of fare structure elements. Limiting selection by fareFrameId or orgId parameter is supported › Responses
Entity updated successfully
numberOfElementsnumber of elements
Retrieves fareStructureElements for a given page. Limiting selection by fareFrameId or orgId parameter is supported
query Parameters
orgIdThe unique id to identify data owned by organisation
fareFrameIdThe unique id to identify data owned by organisation
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
languageCodeThe language code from ISO-639-3
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 FareStructureElements valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED FareStructureElements are returned. And in the staging environment, PROPOSED FareStructureElements 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 fareStructureElements for a given page. Limiting selection by fareFrameId or orgId parameter is supported › Responses
Returns the info
Fare structure elements for the given page
requestedPageNumberNumber of the requested page. In case state is lost
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
Retrives a fare structure element by netexId
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a fare structure element
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.
Retrives a fare structure element by netexId › Responses
Returns the resource
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fare table reference
geographical interval sequence
geographical structure factor refs
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
Access Right Parameter assignments.
quality structure factor refs
statusStatus.
ValidityConditions sequence.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description.
A LimitingRule
Name.
organisationIdOrganisation related to the userProfile
Fare prices.
tariffBasisTariff basis.
version^([A-Z]{3}):([A-Za-z…Version.
Field is deprecated. Distance matrix elements should be connected by a 'geographical structure factor'
Retrives a fare structure element by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a fare structure element
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
LanguagecodeAccept-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.
Retrives a fare structure element by id and version › Responses
Returns the resource
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fare table reference
geographical interval sequence
geographical structure factor refs
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
Access Right Parameter assignments.
quality structure factor refs
statusStatus.
ValidityConditions sequence.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description.
A LimitingRule
Name.
organisationIdOrganisation related to the userProfile
Fare prices.
tariffBasisTariff basis.
version^([A-Z]{3}):([A-Za-z…Version.
Field is deprecated. Distance matrix elements should be connected by a 'geographical structure factor'
Update a fare structure element
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a fare structure element
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 fare structure element › Request Body
Fare frame ref.
fare table reference
geographical interval sequence
id^([A-Z]{3}):([A-Za-z… · requiredId.
Access Right Parameter assignments.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description.
geographicalStructureFactorIdGeographical structure factor id
Name.
Fare prices.
tariffBasisTariff basis.
version^([A-Z]{3}):([A-Za-z…Version.
Field is deprecated. Use 'geographical structure factor' instead to connect 'distance matrix elements' to 'fare structure element'
Update a fare structure element › Responses
Entity updated successfully
Retrieves the distance matrix elements of the fare structure element
No longer in use. DMEs are connected by geographicalStructureFactors
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a fare structure element
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id of the version of the fare structure element
query Parameters
limitThe limited numbers of distance matrix elements returned in the set
offsetThe offset of distance matrix elements returned in the set
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 distance matrix elements of the fare structure element › Responses
Returns the resource
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
nameOfClassName of class.
version^([A-Z]{3}):([A-Za-z… · requiredDistanceMatrixElement version.
Description represented in different languages. Language codes are ISO-639.
distanceDistance.
endFareZoneRefEnd fare zone reference.
endScheduledStopPointIdEnd scheduled stop point netexId.
References to fare tables that provide prices or discounts for the user profile.
groupIdGroup id.
Fare frame ref.
inverseAllowedInverse is allowed.
isDirectIs a direct route.
Fare frame ref.
DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.
Fare prices for the user profile.
relativeRankingRelative ranking.
startFareZoneRefStart fare zone reference.
startScheduledStopPointIdStart scheduled stop point netexId.
tariffIdTariff id.
Fare frame ref.
Validity conditions for the user profile.
endTariffZoneIdEnd tariff zone reference. This field is deprecated, please use the field endFareZoneRef.
startTariffZoneIdStart tariff zone reference. This field is deprecated, please use the field startFareZoneRef.
Retrieves the geographical intervals of the fare structure element
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a fare structure element
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id of the version of the fare structure element
query Parameters
limitThe limited numbers of geographical intervals returned in the set
offsetThe offset of geographical intervals returned in the set
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 geographical intervals of the fare structure element › Responses
Returns the resource
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
endGeographicalValueendGeographicalValue.
Reference to fare table.
intervalTypeintervalType.
A LimitingRule
modificationModification status.
nameOfClassName of class.
numberOfUnitsnumberOfUnits.
Prices for the fare.
startGeographicalValuestartGeographicalValue.
validityConditions.
Retrieves a fare structure element by netexId
path Parameters
idThe unique id to identify a fare structure element
query Parameters
startDateendDatestatusThe version status of the fare structure element
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
fromDateThe from date of the fare structure elements version
toDateThe to date of the fare structure elements 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
LanguagecodeAccept-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 fare structure element by netexId › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fare table reference
geographical interval sequence
geographical structure factor refs
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
Access Right Parameter assignments.
quality structure factor refs
statusStatus.
ValidityConditions sequence.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description.
A LimitingRule
Name.
organisationIdOrganisation related to the userProfile
Fare prices.
tariffBasisTariff basis.
version^([A-Z]{3}):([A-Za-z…Version.
Field is deprecated. Distance matrix elements should be connected by a 'geographical structure factor'