Retrieves all faretables. Limiting selection by fareFrameId parameter is supported
query Parameters
orgIdfareFrameIdThe unique id to identify data owned by organisation
languageCodeThe language code from ISO-639-3
minimizeDataLoadif set to true fare table cells will be omitted
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 faretables. Limiting selection by fareFrameId parameter is supported › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
Cell
FarePrice.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
Name.
endDateEndDate.
startDateStartDate.
Description.
organisationIdOrganisation related to the fare table
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
Create a fare table
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 table › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
Fare frame ref.
Cell
FarePrice.
endDateEndDate.
startDateStartDate.
Fare frame ref.
Description.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
Create a fare table › Responses
Entity created successfully
Retrieves a fare table by id
Note! Only fare tables with active versions will be fetched
path Parameters
idThe unique id to identify a fare table
query Parameters
versionThe id for the version of the fare table
languageCodeThe language code from ISO-639-3
minimizeDataLoadif set to true fare table cells will be omitted
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 fare table by id › Responses
Returns the fare table
id^([A-Z]{3}):([A-Za-z… · requiredId.
Cell
FarePrice.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
Name.
endDateEndDate.
startDateStartDate.
Description.
organisationIdOrganisation related to the fare table
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
Retrieves the number of fareTables. 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 fareTables. Limiting selection by fareFrameId and orgId parameter is supported › Responses
Retrieves fareTables for a given page. Limiting selection by fareFrameId and orgId parameter is supported
query Parameters
pageSizeSize of page
pageNumberPage number
orgIdfareFrameIdThe unique id to identify data owned by organisation
languageCodeThe language code from ISO-639-3
minimizeDataLoadif set to true fare table cells will be omitted
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 fareTables for a given page. Limiting selection by fareFrameId and orgId parameter is supported › Responses
Returns the info
Fare Tables 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 table by id
path Parameters
idThe unique id to identify a fare table
query Parameters
startDateendDatestatusThe version status of the fare table
minimizeDataLoadif set to true fare table cells will be omitted
fromDateThe from date of the fare tables version
toDateThe to date of the fare tables 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 a fare table by id › Responses
Returns the fare table
id^([A-Z]{3}):([A-Za-z… · requiredId.
Cell
FarePrice.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
Name.
endDateEndDate.
startDateStartDate.
Description.
organisationIdOrganisation related to the fare table
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
Retrives a faretable by product id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a product
query Parameters
languageCodeThe language code from ISO-639-3
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 faretable by product id › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
Cell
FarePrice.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
Name.
endDateEndDate.
startDateStartDate.
Description.
organisationIdOrganisation related to the fare table
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
Retrieves a fare table by id and version
path Parameters
idThe unique id to identify a fare table
versionThe id for the version of the fare table
query Parameters
minimizeDataLoadif set to true fare table cells will be omitted
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 a fare table by id and version › Responses
Returns the fare table
id^([A-Z]{3}):([A-Za-z… · requiredId.
Cell
FarePrice.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
Name.
endDateEndDate.
startDateStartDate.
Description.
organisationIdOrganisation related to the fare table
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
Update a faretable
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a fare table
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the fare table
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 faretable › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
Fare frame ref.
Cell
FarePrice.
endDateEndDate.
startDateStartDate.
Fare frame ref.
Description.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
Update a faretable › Responses
Entity updated successfully
Updates a FarePrice for FareTable
path Parameters
ftId^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a fare table
cellId^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a cell
query Parameters
version^([A-Z]{3}):([A-Za-z… · required · style: form · explode: truefareTableVersionIdThe versjon of the fare table
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 a FarePrice for FareTable › Request Body
amountAmount in the currency selected at create operation
discountPercentageUsedDiscount in percentageUsed
Updates a FarePrice for FareTable › Responses
Entity updated successfully