Retrieves sales packages by organisation id
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.
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 sales packages by organisation id › Responses
Returns the info
Access Right Parameter assignments.
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
Distribution assignments.
Fare frame ref.
References to fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
compatibleWithVersionRefCompatibleWithVersionRef
derivedFromVersionRefDerived from version.
Description.
A LimitingRule
Fare frame ref.
SalesPackage Name.
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
version^([A-Z]{3}):([A-Za-z…Version
Create a salespackage
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 salespackage › Request Body
AccessRightParameterAssignments.
Distribution assignments.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
UserProfile Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredUserProfile version.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables.
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default
Create a salespackage › Responses
Entity created successfully
Retrieves a sales package by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a sales package
query Parameters
versionversion
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 a sales package by id › Responses
Returns the info
Access Right Parameter assignments.
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
Distribution assignments.
Fare frame ref.
References to fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
compatibleWithVersionRefCompatibleWithVersionRef
derivedFromVersionRefDerived from version.
Description.
A LimitingRule
Fare frame ref.
SalesPackage Name.
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
version^([A-Z]{3}):([A-Za-z…Version
Retrieves a sales package by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a sales package
version^([A-Z]{3}):([A-Za-z… · required · style: simpleversion
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
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 sales package by id › Responses
Returns the info
Access Right Parameter assignments.
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
Distribution assignments.
Fare frame ref.
References to fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
compatibleWithVersionRefCompatibleWithVersionRef
derivedFromVersionRefDerived from version.
Description.
A LimitingRule
Fare frame ref.
SalesPackage Name.
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
version^([A-Z]{3}):([A-Za-z…Version
Update a sales-package
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a sales package
version^([A-Z]{3}):([A-Za-z… · required · style: simpleversion
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 sales-package › Request Body
AccessRightParameterAssignments.
Distribution assignments.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
UserProfile Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredUserProfile version.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables.
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default
Update a sales-package › Responses
Entity updated successfully
Retrieves a sales package by id
path Parameters
idThe unique id to identify a sales package
query Parameters
startDateendDatestatusThe version status of the sales package
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
fromDateThe from date of the sales packages version
toDateThe to date of the sales packages 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 a sales package by id › Responses
Returns the info
Access Right Parameter assignments.
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
Distribution assignments.
Fare frame ref.
References to fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
compatibleWithVersionRefCompatibleWithVersionRef
derivedFromVersionRefDerived from version.
Description.
A LimitingRule
Fare frame ref.
SalesPackage Name.
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
version^([A-Z]{3}):([A-Za-z…Version
Retrieves all sales packages
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
minimizeDataLoadPossibility of opting out of including child elements
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.
validOnDateReturn the SalesPackages valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED SalesPackages are returned. And in the staging environment, PROPOSED SalesPackages 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 all sales packages › Responses
Returns the info
changedChanged datetime
createdCreated datetime
Distribution assignments.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
nameOfClassName of class
statusStatus
Validity Parameter assignments.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description
A LimitingRule
Fare frame ref.
Name
organisationIdOrganisation related to the userProfile
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
Create a sales package
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 sales package › Request Body
changedChanged datetime
createdCreated datetime
Distribution assignments.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
nameOfClassName of class
statusStatus
Validity Parameter assignments.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description
A LimitingRule
Fare frame ref.
Name
organisationIdOrganisation related to the userProfile
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
Create a sales package › Responses
Entity created successfully
Retrieves the number of sales packages
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.
validOnDateCount SalesPackages valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED SalesPackages are counted. And in the staging environment, PROPOSED SalesPackages 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 sales packages › Responses
Returns the number of sales packages
Retrieves the number of pages of sales packages
query Parameters
pageSizeThe number of sales packages per page
pageNumberThe page number
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
minimizeDataLoadPossibility of opting out of including child elements
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.
validOnDateReturn the SalesPackages valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED SalesPackages are returned. And in the staging environment, PROPOSED SalesPackages 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 pages of sales packages › Responses
Returns the number of pages of sales packages
SalesPackages 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 the sales package valid on a given date
Requires validOnDate query parameter. In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.
path Parameters
idThe unique id to identify a sales package
query Parameters
validOnDateReturn the version valid on the given date (ISO-8601).
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 the sales package valid on a given date › Responses
Returns the info
changedChanged datetime
createdCreated datetime
Distribution assignments.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
nameOfClassName of class
statusStatus
Validity Parameter assignments.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description
A LimitingRule
Fare frame ref.
Name
organisationIdOrganisation related to the userProfile
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
Retrieves sales package given id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a sales package
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe version of the sales package
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
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 sales package given id and version › Responses
Returns the info
changedChanged datetime
createdCreated datetime
Distribution assignments.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
nameOfClassName of class
statusStatus
Validity Parameter assignments.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description
A LimitingRule
Fare frame ref.
Name
organisationIdOrganisation related to the userProfile
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
Updates an existing sales package
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a sales package
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe version of the sales package
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
Updates an existing sales package › Request Body
changedChanged datetime
createdCreated datetime
Distribution assignments.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
nameOfClassName of class
statusStatus
Validity Parameter assignments.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description
A LimitingRule
Fare frame ref.
Name
organisationIdOrganisation related to the userProfile
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
Updates an existing sales package › Responses
Entity updated successfully
Delete a sales package given id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a sales package
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe version of the sales package
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
Delete a sales package given id and version › Responses
Entity deleted successfully