Retrieves all group tickets accessible by user rights
query Parameters
orgIdfareFrameIdHeaders
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 all group tickets accessible by user rights › Responses
Returns all group tickets
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the group ticket.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the group ticket.
groupDiscountBasisgroupDiscountBasis
jointCheckInjointCheckIn
Fare frame ref.
maximumNumberOfPersonsmaximumNumberOfPersons
minimumNumberOfPersonsminimumNumberOfPersons
The name of the group ticket represented in different languages. Language codes are ISO-639.
Fare prices for the group ticket.
pricingBasisPrice basis
ticketingThe type of way that tickets are issued to the group.
typeOfUsageParametertypeOfUsageParameter.
Validity conditions for the group ticket.
Create a group ticket
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 group ticket › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the group ticket.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
groupDiscountBasisgroupDiscountBasis
jointCheckInjointCheckIn
maximumNumberOfPersonsmaximumNumberOfPersons
minimumNumberOfPersonsminimumNumberOfPersons
The name of the group ticket represented in different languages. Language codes are ISO-639.
Fare prices for the group ticket.
pricingBasisPrice basis
ticketingThe type of way that tickets are issued to the group.
typeOfUsageParametertypeOfUsageParameter.
Create a group ticket › Responses
Entity created successfully
Retrieves a group ticket by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a group ticket
query Parameters
versionThe id for the version of the group ticket
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>.
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 group ticket by id › Responses
Returns the group ticket
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the group ticket.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the group ticket.
groupDiscountBasisgroupDiscountBasis
jointCheckInjointCheckIn
Fare frame ref.
maximumNumberOfPersonsmaximumNumberOfPersons
minimumNumberOfPersonsminimumNumberOfPersons
The name of the group ticket represented in different languages. Language codes are ISO-639.
Fare prices for the group ticket.
pricingBasisPrice basis
ticketingThe type of way that tickets are issued to the group.
typeOfUsageParametertypeOfUsageParameter.
Validity conditions for the group ticket.
Retrieves a group ticket by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a group ticket
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the group ticket
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 group ticket by id and version › Responses
Returns the group ticket
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the group ticket.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the group ticket.
groupDiscountBasisgroupDiscountBasis
jointCheckInjointCheckIn
Fare frame ref.
maximumNumberOfPersonsmaximumNumberOfPersons
minimumNumberOfPersonsminimumNumberOfPersons
The name of the group ticket represented in different languages. Language codes are ISO-639.
Fare prices for the group ticket.
pricingBasisPrice basis
ticketingThe type of way that tickets are issued to the group.
typeOfUsageParametertypeOfUsageParameter.
Validity conditions for the group ticket.
Update a group ticket
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a group ticket
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the group ticket
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 group ticket › Request Body
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the group ticket.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the group ticket.
groupDiscountBasisgroupDiscountBasis
jointCheckInjointCheckIn
Fare frame ref.
maximumNumberOfPersonsmaximumNumberOfPersons
minimumNumberOfPersonsminimumNumberOfPersons
The name of the group ticket represented in different languages. Language codes are ISO-639.
Fare prices for the group ticket.
pricingBasisPrice basis
ticketingThe type of way that tickets are issued to the group.
typeOfUsageParametertypeOfUsageParameter.
Validity conditions for the group ticket.
Update a group ticket › Responses
Entity updated successfully
Retrieves a group ticket by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a group ticket
query Parameters
startDateendDatestatusThe version status of the group ticket
fromDateThe from date of the group tickets version
toDateThe to date of the group tickets 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 group ticket by id › Responses
Returns the group ticket
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the group ticket.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the group ticket.
groupDiscountBasisgroupDiscountBasis
jointCheckInjointCheckIn
Fare frame ref.
maximumNumberOfPersonsmaximumNumberOfPersons
minimumNumberOfPersonsminimumNumberOfPersons
The name of the group ticket represented in different languages. Language codes are ISO-639.
Fare prices for the group ticket.
pricingBasisPrice basis
ticketingThe type of way that tickets are issued to the group.
typeOfUsageParametertypeOfUsageParameter.
Validity conditions for the group ticket.