Entur Developer
Products
Products

group-tickets

Server
Download schema

Retrieves all group tickets accessible by user rights

GET
https://api.entur.io/products
/group-tickets

Retrieves all group tickets accessible by user rights › query Parameters

orgId
​string · style: form · explode: true
fareFrameId
​string · style: form · explode: true

Retrieves all group tickets accessible by user rights › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

Accept-Language
​string · style: simple

The language code from ISO-639-3

If-None-Match
​string · style: simple

Used 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

A GroupTicket
GroupTicket
changed
​string · date-time · required

Changed datetime.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupTicket:FamilyDiscount
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: GroupTicket
status
​string · enum · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the group ticket.

Example: NSB:Version:V1
​CompanionProfile[]

Companion Profiles in Group Ticket

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the group ticket.

groupDiscountBasis
​string · enum

groupDiscountBasis

Enum values:
FREE
DISCOUNT_FOR_ALL
DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP
STEP_DISCOUNT
DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS
jointCheckIn
​string · enum

jointCheckIn

Enum values:
NONE
ALLOWED
REQUIRED
​VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons
​integer · int32

maximumNumberOfPersons

minimumNumberOfPersons
​integer · int32

minimumNumberOfPersons

​TextInLanguage[]

The name of the group ticket represented in different languages. Language codes are ISO-639.

​FarePrice[]

Fare prices for the group ticket.

pricingBasis
​string · enum

Price basis

Enum values:
PER_OFFER
PER_PERSON
Example: PER_OFFER
ticketing
​string · enum

The type of way that tickets are issued to the group.

Enum values:
ALL_ON_ONE_TICKET
SEPARATE_TICKETS
TICKET_WITH_COUPONS
OTHER
Example: SEPARATE_TICKETS
typeOfUsageParameter
​string

typeOfUsageParameter.

​ValidityCondition[]

Validity conditions for the group ticket.

Create a group ticket

POST
https://api.entur.io/products
/group-tickets

Create a group ticket › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

Create a group ticket › Request Body

A group ticket create request
GroupTicketInsert
​VersionOfObjectRef · required

Fare frame ref.

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupTicket:FamilyDiscount
version
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the group ticket.

Example: NSB:Version:V1
​CompanionProfile[]

Companion Profiles in Group Ticket

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

groupDiscountBasis
​string · enum

groupDiscountBasis

Enum values:
FREE
DISCOUNT_FOR_ALL
DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP
STEP_DISCOUNT
DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS
jointCheckIn
​string · enum

jointCheckIn

Enum values:
NONE
ALLOWED
REQUIRED
maximumNumberOfPersons
​integer · int32

maximumNumberOfPersons

minimumNumberOfPersons
​integer · int32

minimumNumberOfPersons

​TextInLanguage[]

The name of the group ticket represented in different languages. Language codes are ISO-639.

​FarePrice[]

Fare prices for the group ticket.

pricingBasis
​string · enum

Price basis

Enum values:
PER_OFFER
PER_PERSON
ticketing
​string · enum

The type of way that tickets are issued to the group.

Enum values:
ALL_ON_ONE_TICKET
SEPARATE_TICKETS
TICKET_WITH_COUPONS
OTHER
Example: SEPARATE_TICKETS
typeOfUsageParameter
​string

typeOfUsageParameter.

Create a group ticket › Responses

Entity created successfully

BoxedUnit

Retrieves a group ticket by id

GET
https://api.entur.io/products
/group-tickets/{id}

Retrieves a group ticket by id › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a group ticket

Retrieves a group ticket by id › query Parameters

version
​string · style: form · explode: true

The id for the version of the group ticket

languageCode
​string · style: form · explode: true

The language code from ISO-639-3

Retrieves a group ticket by id › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

If-None-Match
​string · style: simple

Used 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

A GroupTicket
GroupTicket
changed
​string · date-time · required

Changed datetime.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupTicket:FamilyDiscount
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: GroupTicket
status
​string · enum · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the group ticket.

Example: NSB:Version:V1
​CompanionProfile[]

Companion Profiles in Group Ticket

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the group ticket.

groupDiscountBasis
​string · enum

groupDiscountBasis

Enum values:
FREE
DISCOUNT_FOR_ALL
DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP
STEP_DISCOUNT
DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS
jointCheckIn
​string · enum

jointCheckIn

Enum values:
NONE
ALLOWED
REQUIRED
​VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons
​integer · int32

maximumNumberOfPersons

minimumNumberOfPersons
​integer · int32

minimumNumberOfPersons

​TextInLanguage[]

The name of the group ticket represented in different languages. Language codes are ISO-639.

​FarePrice[]

Fare prices for the group ticket.

pricingBasis
​string · enum

Price basis

Enum values:
PER_OFFER
PER_PERSON
Example: PER_OFFER
ticketing
​string · enum

The type of way that tickets are issued to the group.

Enum values:
ALL_ON_ONE_TICKET
SEPARATE_TICKETS
TICKET_WITH_COUPONS
OTHER
Example: SEPARATE_TICKETS
typeOfUsageParameter
​string

typeOfUsageParameter.

​ValidityCondition[]

Validity conditions for the group ticket.

Retrieves a group ticket by id and version

GET
https://api.entur.io/products
/group-tickets/{id}/{version}

Retrieves a group ticket by id and version › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a group ticket

version
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id for the version of the group ticket

Retrieves a group ticket by id and version › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

Accept-Language
​string · style: simple

The language code from ISO-639-3

If-None-Match
​string · style: simple

Used 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

A GroupTicket
GroupTicket
changed
​string · date-time · required

Changed datetime.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupTicket:FamilyDiscount
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: GroupTicket
status
​string · enum · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the group ticket.

Example: NSB:Version:V1
​CompanionProfile[]

Companion Profiles in Group Ticket

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the group ticket.

groupDiscountBasis
​string · enum

groupDiscountBasis

Enum values:
FREE
DISCOUNT_FOR_ALL
DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP
STEP_DISCOUNT
DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS
jointCheckIn
​string · enum

jointCheckIn

Enum values:
NONE
ALLOWED
REQUIRED
​VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons
​integer · int32

maximumNumberOfPersons

minimumNumberOfPersons
​integer · int32

minimumNumberOfPersons

​TextInLanguage[]

The name of the group ticket represented in different languages. Language codes are ISO-639.

​FarePrice[]

Fare prices for the group ticket.

pricingBasis
​string · enum

Price basis

Enum values:
PER_OFFER
PER_PERSON
Example: PER_OFFER
ticketing
​string · enum

The type of way that tickets are issued to the group.

Enum values:
ALL_ON_ONE_TICKET
SEPARATE_TICKETS
TICKET_WITH_COUPONS
OTHER
Example: SEPARATE_TICKETS
typeOfUsageParameter
​string

typeOfUsageParameter.

​ValidityCondition[]

Validity conditions for the group ticket.

Update a group ticket

PUT
https://api.entur.io/products
/group-tickets/{id}/{version}

Update a group ticket › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a group ticket

version
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id for the version of the group ticket

Update a group ticket › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

Update a group ticket › Request Body

A GroupTicket
GroupTicket
changed
​string · date-time · required

Changed datetime.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupTicket:FamilyDiscount
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: GroupTicket
status
​string · enum · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the group ticket.

Example: NSB:Version:V1
​CompanionProfile[]

Companion Profiles in Group Ticket

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the group ticket.

groupDiscountBasis
​string · enum

groupDiscountBasis

Enum values:
FREE
DISCOUNT_FOR_ALL
DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP
STEP_DISCOUNT
DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS
jointCheckIn
​string · enum

jointCheckIn

Enum values:
NONE
ALLOWED
REQUIRED
​VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons
​integer · int32

maximumNumberOfPersons

minimumNumberOfPersons
​integer · int32

minimumNumberOfPersons

​TextInLanguage[]

The name of the group ticket represented in different languages. Language codes are ISO-639.

​FarePrice[]

Fare prices for the group ticket.

pricingBasis
​string · enum

Price basis

Enum values:
PER_OFFER
PER_PERSON
Example: PER_OFFER
ticketing
​string · enum

The type of way that tickets are issued to the group.

Enum values:
ALL_ON_ONE_TICKET
SEPARATE_TICKETS
TICKET_WITH_COUPONS
OTHER
Example: SEPARATE_TICKETS
typeOfUsageParameter
​string

typeOfUsageParameter.

​ValidityCondition[]

Validity conditions for the group ticket.

Update a group ticket › Responses

Entity updated successfully

No data returned

Retrieves a group ticket by id

GET
https://api.entur.io/products
/v1/group-tickets/{id}

Retrieves a group ticket by id › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a group ticket

Retrieves a group ticket by id › query Parameters

startDate
​string · style: form · explode: true
endDate
​string · style: form · explode: true
status
​string · style: form · explode: true

The version status of the group ticket

fromDate
​string · style: form · explode: true

The from date of the group tickets version

toDate
​string · style: form · explode: true

The to date of the group tickets version

Retrieves a group ticket by id › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

Accept-Language
​string · style: simple

The language code from ISO-639-3

If-None-Match
​string · style: simple

Used 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

A GroupTicket
GroupTicket
changed
​string · date-time · required

Changed datetime.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupTicket:FamilyDiscount
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: GroupTicket
status
​string · enum · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the group ticket.

Example: NSB:Version:V1
​CompanionProfile[]

Companion Profiles in Group Ticket

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the group ticket.

groupDiscountBasis
​string · enum

groupDiscountBasis

Enum values:
FREE
DISCOUNT_FOR_ALL
DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP
STEP_DISCOUNT
DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS
jointCheckIn
​string · enum

jointCheckIn

Enum values:
NONE
ALLOWED
REQUIRED
​VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons
​integer · int32

maximumNumberOfPersons

minimumNumberOfPersons
​integer · int32

minimumNumberOfPersons

​TextInLanguage[]

The name of the group ticket represented in different languages. Language codes are ISO-639.

​FarePrice[]

Fare prices for the group ticket.

pricingBasis
​string · enum

Price basis

Enum values:
PER_OFFER
PER_PERSON
Example: PER_OFFER
ticketing
​string · enum

The type of way that tickets are issued to the group.

Enum values:
ALL_ON_ONE_TICKET
SEPARATE_TICKETS
TICKET_WITH_COUPONS
OTHER
Example: SEPARATE_TICKETS
typeOfUsageParameter
​string

typeOfUsageParameter.

​ValidityCondition[]

Validity conditions for the group ticket.

group-of-distance-matrix-elementsinterchangings
Did you find what you were looking for?