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