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
gpaDataSetType of gpa dataset
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL
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 validable elements by organisation id or fareframe › Responses
Returns the resources
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredValidable element version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare table.
The references to access right parameter assignments.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
Requirements for area validity.
organisationIdOrganisation related to the userProfile
pricingRuleRefPricing rule reference.
Gives a sequence of conditions for validity.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
The reference to the fare divided into a sequence.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
The fare structure elements in sequence
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a validable-element › Request Body
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.
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
Fare prices.
Requirements for area validity.
References to fare tables that provide prices or discounts for the user profile.
The reference to the fare divided into a sequence.
The references to access right parameter assignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Fare structure elements in sequence
Create a validable-element › Responses
Entity created successfully
Retrieves validable elements by id and latest version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe 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
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.
Retrieves validable elements by id and latest version › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredValidable element version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare table.
The references to access right parameter assignments.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
Requirements for area validity.
organisationIdOrganisation related to the userProfile
pricingRuleRefPricing rule reference.
Gives a sequence of conditions for validity.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
The reference to the fare divided into a sequence.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
The fare structure elements in sequence
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.
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 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
gpaDataSetType of gpa dataset
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL
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 validable elements by organisation id or fareframe › Responses
Returns the resources
Validable 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 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
gpaDataSetType of gpa dataset
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> 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 validable elements by id and latest version › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredValidable element version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare table.
The references to access right parameter assignments.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
Requirements for area validity.
organisationIdOrganisation related to the userProfile
pricingRuleRefPricing rule reference.
Gives a sequence of conditions for validity.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
The reference to the fare divided into a sequence.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
The fare structure elements in sequence
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
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.
Retrieves validable elements by id and version › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredValidable element version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References for associated fare table.
The references to access right parameter assignments.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
Requirements for area validity.
organisationIdOrganisation related to the userProfile
pricingRuleRefPricing rule reference.
Gives a sequence of conditions for validity.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
The reference to the fare divided into a sequence.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
The fare structure elements in sequence
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update a validable element › Request Body
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.
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
Fare prices.
Requirements for area validity.
References to fare tables that provide prices or discounts for the user profile.
The reference to the fare divided into a sequence.
The references to access right parameter assignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Fare structure elements in sequence
Update a validable element › Responses
Entity updated successfully