Entur Developer
Products V3
Products V3

Entitlement Required

Server
Download schema

Manage EntitlementRequired instances. Defines what existing entitlement (e.g., a valid ticket) is required to purchase a product.

List entitlement required instances

GET
https://api.entur.io/products
/v3/parameters/limitations/entitlement-required

Returns a paginated list of all EntitlementRequired instances.

List entitlement required instances › query Parameters

page
​integer · min: 0 · style: form · explode: true

Zero-based page number. Defaults to 0.

Default: 0
size
​integer · min: 1 · max: 1000 · style: form · explode: true

Number of instances per page. Defaults to 100.

Default: 100

List entitlement required instances › 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

List entitlement required instances › Responses

Paginated list of EntitlementRequired instances

EntitlementRequiredListResponse
​EntitlementRequired[] · required
totalCount
​integer · required

Total number of EntitlementRequired instances.

Example: 4
page
​integer · required

Current zero-based page number.

Example: 0
size
​integer · required

Number of instances per page.

Example: 100

Create an entitlement required instance

POST
https://api.entur.io/products
/v3/parameters/limitations/entitlement-required

Create a new EntitlementRequired instance.

Create an entitlement required instance › 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 an entitlement required instance › Request Body

EntitlementRequiredRequest
​object[] · required
entitlementType
​string · enum · required

The type of entitlement that is required.

Enum values:
SINGLE_TRIP
PERIOD_PASS
DAY_PASS
CARNET
fareProductRef
​string · pattern: ^([A-Z]{3}):Preassig… · required

Reference to the fare product that satisfies this entitlement.

Example: ENT:PreassignedFareProduct:SingleTrip

Create an entitlement required instance › Responses

EntitlementRequired instance created successfully

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

The NeTEx ID of this EntitlementRequired.

Example: ENT:EntitlementRequired:SingleTicket
​object[] · required
entitlementType
​string · enum · required

The type of entitlement that is required.

Enum values:
SINGLE_TRIP
PERIOD_PASS
DAY_PASS
CARNET
fareProductRef
​string · pattern: ^([A-Z]{3}):Preassig… · required

Reference to the fare product that satisfies this entitlement.

Example: ENT:PreassignedFareProduct:SingleTrip

Get an entitlement required instance

GET
https://api.entur.io/products
/v3/parameters/limitations/entitlement-required/{id}

Retrieve the full detail of a single EntitlementRequired instance.

Get an entitlement required instance › path Parameters

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

The netex ID of the element to retrieve

Get an entitlement required instance › 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

Get an entitlement required instance › Responses

EntitlementRequired instance found

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

The NeTEx ID of this EntitlementRequired.

Example: ENT:EntitlementRequired:SingleTicket
​object[] · required
entitlementType
​string · enum · required

The type of entitlement that is required.

Enum values:
SINGLE_TRIP
PERIOD_PASS
DAY_PASS
CARNET
fareProductRef
​string · pattern: ^([A-Z]{3}):Preassig… · required

Reference to the fare product that satisfies this entitlement.

Example: ENT:PreassignedFareProduct:SingleTrip

Update an entitlement required instance

PUT
https://api.entur.io/products
/v3/parameters/limitations/entitlement-required/{id}

Update an existing EntitlementRequired instance.

Update an entitlement required instance › path Parameters

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

The netex ID of the element to retrieve

Update an entitlement required instance › 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 an entitlement required instance › Request Body

EntitlementRequiredRequest
​object[] · required
entitlementType
​string · enum · required

The type of entitlement that is required.

Enum values:
SINGLE_TRIP
PERIOD_PASS
DAY_PASS
CARNET
fareProductRef
​string · pattern: ^([A-Z]{3}):Preassig… · required

Reference to the fare product that satisfies this entitlement.

Example: ENT:PreassignedFareProduct:SingleTrip

Update an entitlement required instance › Responses

EntitlementRequired instance updated successfully

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

The NeTEx ID of this EntitlementRequired.

Example: ENT:EntitlementRequired:SingleTicket
​object[] · required
entitlementType
​string · enum · required

The type of entitlement that is required.

Enum values:
SINGLE_TRIP
PERIOD_PASS
DAY_PASS
CARNET
fareProductRef
​string · pattern: ^([A-Z]{3}):Preassig… · required

Reference to the fare product that satisfies this entitlement.

Example: ENT:PreassignedFareProduct:SingleTrip
Supplement product
Did you find what you were looking for?