Retrieves validable elements by id and latest version
path Parameters
idThe unique id to identify a validable element
query Parameters
startDateendDatestatusThe version status of the validable element
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
fromDateThe from date of the validable elements version
toDateThe to date of the validable 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
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 validable elements by id and latest version › Responses
Returns the info
The references to access right parameter assignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare table.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredValidable element version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Requirements for area validity.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
The fare structure elements in sequence
The reference to the fare divided into a sequence.
Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices.
pricingRuleRefPricing rule reference.
Gives a sequence of conditions for validity.
Retrieves validable elements by organisation id or fareframe
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to identify a fare frame
languageCodeThe language code from ISO-639-3
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Mutually exclusive with validOnDate.
validOnDateReturn the ValidableElements valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED ValidableElements are returned. And in the staging environment, PROPOSED ValidableElements 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 validable elements by organisation id or fareframe › Responses
Returns the resources
The references to access right parameter assignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare table.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredValidable element version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Requirements for area validity.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
The fare structure elements in sequence
The reference to the fare divided into a sequence.
Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices.
pricingRuleRefPricing rule reference.
Gives a sequence of conditions for validity.
Create a validable-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 validable-element › Request Body
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
ValidableElement Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredValidableElement version.
The references to access right parameter assignments.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Requirements for area validity.
Fare structure elements in sequence
The reference to the fare divided into a sequence.
References to fare tables that provide prices or discounts for the user profile.
Fare prices.
Create a validable-element › Responses
Entity created successfully
Retrieves the number of validable elements. Limit selection by setting the orgId or fareFrameId parameters
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to identify a fare frame
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.
validOnDateCount ValidableElements valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED ValidableElements are counted. And in the staging environment, PROPOSED ValidableElements 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 number of validable elements. Limit selection by setting the orgId or fareFrameId parameters › Responses
Returns the info
Retrieves validable elements by organisation id or fareframe
query Parameters
pageSizeThe number of elements to return
pageNumberThe offset to start from
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to identify a fare frame
languageCodeThe language code from ISO-639-3
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Mutually exclusive with validOnDate.
validOnDateReturn the ValidableElements valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED ValidableElements are returned. And in the staging environment, PROPOSED ValidableElements 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 validable elements by organisation id or fareframe › Responses
Returns the resources
Validable 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.
Retrieves validable elements by id and latest version
path Parameters
idThe unique id to identify a validable element
query Parameters
versionThe id of the version of the given validable element
languageCodeThe language code from ISO-639-3
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
validOnDateReturn the version valid on the given date (ISO-8601). Overrides 'version'. In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.
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 validable elements by id and latest version › Responses
Returns the resource
The references to access right parameter assignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare table.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredValidable element version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Requirements for area validity.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
The fare structure elements in sequence
The reference to the fare divided into a sequence.
Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices.
pricingRuleRefPricing rule reference.
Gives a sequence of conditions for validity.
Retrieves validable elements by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a validable element
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id of the version of the given validable element
query Parameters
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 validable elements by id and version › Responses
Returns the resource
The references to access right parameter assignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare table.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredValidable element version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Requirements for area validity.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
The fare structure elements in sequence
The reference to the fare divided into a sequence.
Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices.
pricingRuleRefPricing rule reference.
Gives a sequence of conditions for validity.
Update a validable element
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a validable element
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id of the version of the given validable 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 validable element › Request Body
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
ValidableElement Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredValidableElement version.
The references to access right parameter assignments.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Requirements for area validity.
Fare structure elements in sequence
The reference to the fare divided into a sequence.
References to fare tables that provide prices or discounts for the user profile.
Fare prices.
Update a validable element › Responses
Entity updated successfully