Retrieves a preassignedFareProduct by organisation id
query Parameters
orgIdfareFrameIdThe unique id to identify a dataset for an organization
languageCodegpaDataSetType 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 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.
fare table reference
ValidityConditions sequence.
Access Right Parameter assignments.
geographical interval sequence
quality structure factor refs
geographical structure factor refs
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
tariffBasisTariff basis.
A LimitingRule
organisationIdOrganisation related to the userProfile
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a Fare structure element › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Fare frame ref.
fare table reference
Access Right Parameter assignments.
geographical interval sequence
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
tariffBasisTariff basis.
geographicalStructureFactorIdGeographical structure factor id
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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
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
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.
Retrives a fare structure element by netexId › 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.
fare table reference
ValidityConditions sequence.
Access Right Parameter assignments.
geographical interval sequence
quality structure factor refs
geographical structure factor refs
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
tariffBasisTariff basis.
A LimitingRule
organisationIdOrganisation related to the userProfile
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Field is deprecated. Distance matrix elements should be connected by a 'geographical structure factor'
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
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 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
gpaDataSetType of gpa dataset
languageCodeThe language code from ISO-639-3
pageSizeNumber of elements listed in requested page
pageNumberThe given page one want in return
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 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
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
requestedPageNumberNumber of the requested page. In case state is lost
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
gpaDataSetType of gpa dataset
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> for companies, and <personal name>-<application> for individuals.
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
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
fare table reference
ValidityConditions sequence.
Access Right Parameter assignments.
geographical interval sequence
quality structure factor refs
geographical structure factor refs
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
tariffBasisTariff basis.
A LimitingRule
organisationIdOrganisation related to the userProfile
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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
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
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
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
fare table reference
ValidityConditions sequence.
Access Right Parameter assignments.
geographical interval sequence
quality structure factor refs
geographical structure factor refs
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
tariffBasisTariff basis.
A LimitingRule
organisationIdOrganisation related to the userProfile
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update a fare structure element › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Fare frame ref.
fare table reference
Access Right Parameter assignments.
geographical interval sequence
Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version.
Description.
tariffBasisTariff basis.
geographicalStructureFactorIdGeographical structure factor id
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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 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> 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 geographical intervals of the fare structure element › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
Fare frame ref.
Prices for the fare.
nameOfClassName of class.
intervalTypeintervalType.
A LimitingRule
modificationModification status.
Reference to fare table.
numberOfUnitsnumberOfUnits.
validityConditions.
endGeographicalValueendGeographicalValue.
derivedFromVersionRefDerived from version.
startGeographicalValuestartGeographicalValue.
compatibleWithVersionRefCompatible with version.
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> 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 distance matrix elements of the fare structure element › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredDistanceMatrixElement version.
nameOfClassName of class.
Fare frame ref.
DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.
Fare prices for the user profile.
groupIdGroup id.
distanceDistance.
Fare frame ref.
isDirectIs a direct route.
tariffIdTariff id.
Fare frame ref.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the user profile.
endFareZoneRefEnd fare zone reference.
inverseAllowedInverse is allowed.
Fare frame ref.
relativeRankingRelative ranking.
startFareZoneRefStart fare zone reference.
Validity conditions for the user profile.
endScheduledStopPointIdEnd scheduled stop point netexId.
startScheduledStopPointIdStart scheduled stop point netexId.
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.