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
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 sales packages by organisation id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References to fare tables.
Distribution assignments.
Access Right Parameter assignments.
SalesPackage Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version
Description.
A LimitingRule
Fare frame ref.
vatGroupRegisterVatGroupRegister is optional. No default value
Sales package elements.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active for this SP.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a salespackage › Request Body
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.
Fare frame ref.
Distribution assignments.
AccessRightParameterAssignments.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
References to fare tables.
vatGroupRegisterVatGroupRegister is optional. No default
Sales package elements.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Create a salespackage › Responses
Entity created successfully
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
gpaDataSetType of gpa dataset
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 sales packages › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId
statusStatus
changedChanged datetime
createdCreated datetime
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class
Fare frame ref.
modificationModification status
Distribution assignments.
Validity Parameter assignments.
Name
Fare prices.
Description
A LimitingRule
organisationIdOrganisation related to the userProfile
Fare frame ref.
vatGroupRegisterVatGroupRegister is optional. No default value
Sales package elements.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active for this SP.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a sales package › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId
statusStatus
changedChanged datetime
createdCreated datetime
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class
Fare frame ref.
modificationModification status
Distribution assignments.
Validity Parameter assignments.
Name
Fare prices.
Description
A LimitingRule
organisationIdOrganisation related to the userProfile
Fare frame ref.
vatGroupRegisterVatGroupRegister is optional. No default value
Sales package elements.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active for this SP.
Create a sales package › 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
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 a sales package by id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References to fare tables.
Distribution assignments.
Access Right Parameter assignments.
SalesPackage Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version
Description.
A LimitingRule
Fare frame ref.
vatGroupRegisterVatGroupRegister is optional. No default value
Sales package elements.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active for this SP.
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
gpaDataSetType of gpa dataset
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> 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 sales package by id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References to fare tables.
Distribution assignments.
Access Right Parameter assignments.
SalesPackage Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version
Description.
A LimitingRule
Fare frame ref.
vatGroupRegisterVatGroupRegister is optional. No default value
Sales package elements.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active for this SP.
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.
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 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
gpaDataSetType of gpa dataset
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 pages of sales packages › Responses
Returns the number of pages of sales packages
SalesPackages 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 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
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
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
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References to fare tables.
Distribution assignments.
Access Right Parameter assignments.
SalesPackage Name.
Fare prices.
version^([A-Z]{3}):([A-Za-z…Version
Description.
A LimitingRule
Fare frame ref.
vatGroupRegisterVatGroupRegister is optional. No default value
Sales package elements.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active for this SP.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update a sales-package › Request Body
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.
Fare frame ref.
Distribution assignments.
AccessRightParameterAssignments.
Fare prices.
Description represented in different languages. Language codes are ISO-639.
References to fare tables.
vatGroupRegisterVatGroupRegister is optional. No default
Sales package elements.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
Update a sales-package › Responses
Entity updated successfully
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
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 sales package given id and 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… · requiredVersion
nameOfClassName of class
Fare frame ref.
modificationModification status
Distribution assignments.
Validity Parameter assignments.
Name
Fare prices.
Description
A LimitingRule
organisationIdOrganisation related to the userProfile
Fare frame ref.
vatGroupRegisterVatGroupRegister is optional. No default value
Sales package elements.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active for this SP.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Updates an existing sales package › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId
statusStatus
changedChanged datetime
createdCreated datetime
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class
Fare frame ref.
modificationModification status
Distribution assignments.
Validity Parameter assignments.
Name
Fare prices.
Description
A LimitingRule
organisationIdOrganisation related to the userProfile
Fare frame ref.
vatGroupRegisterVatGroupRegister is optional. No default value
Sales package elements.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active for this SP.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Delete a sales package given id and version › Responses
Entity deleted successfully