Entur Developer
Products
Products

entitlements-required

Server
Download schema

Retrieves all entitlements required

GET
https://api.entur.io/products
/entitlements-required

Retrieves all entitlements required › query Parameters

orgId
​string · style: form · explode: true

The unique id to identify an organisation

fareFrameId
​string · style: form · explode: true

The unique id to identify a dataset to an organisation

Retrieves all entitlements required › 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 all entitlements required › Responses

Returns the info

Entitlement Required.
EntitlementRequired
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: ENT:EntitlementRequired:SingleTicket
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the entitlement required represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: EntitlementRequired
status
​string · enum · readOnly · required

Status

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

Version

Example: ENT:Version:ER-SingleTicket-1
​EntitlementConstraint · readOnly

Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.

minimumQualificationPeriod
​string

Minimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601

Example: PT1H
organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices for the entitlement required.

serviceAccessRightNetexId
​string

Reference to the serviceAccessRight required.

Example: ENT:PreassignedFareProduct:SingleTicket
typeOfUsageParameter
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating
​ValidityCondition[]

Pricing rule reference.

Create an EntitlementRequired

POST
https://api.entur.io/products
/entitlements-required

Create an EntitlementRequired › 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 EntitlementRequired › Request Body

Entitlement Required.
EntitlementRequired
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: ENT:EntitlementRequired:SingleTicket
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the entitlement required represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: EntitlementRequired
status
​string · enum · readOnly · required

Status

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

Version

Example: ENT:Version:ER-SingleTicket-1
​EntitlementConstraint · readOnly

Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.

minimumQualificationPeriod
​string

Minimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601

Example: PT1H
organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices for the entitlement required.

serviceAccessRightNetexId
​string

Reference to the serviceAccessRight required.

Example: ENT:PreassignedFareProduct:SingleTicket
typeOfUsageParameter
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating
​ValidityCondition[]

Pricing rule reference.

Create an EntitlementRequired › Responses

Entity created successfully

No data returned

Retrieves EntitlementRequired for id and version

GET
https://api.entur.io/products
/entitlements-required/{id}/{version}

Retrieves EntitlementRequired for id and version › path Parameters

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

The id to identify a EntitlementRequired

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

The id for the version of the EntitlementRequired

Retrieves EntitlementRequired for 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

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 EntitlementRequired for id and version › Responses

Returns the info

Entitlement Required.
EntitlementRequired
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: ENT:EntitlementRequired:SingleTicket
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the entitlement required represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: EntitlementRequired
status
​string · enum · readOnly · required

Status

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

Version

Example: ENT:Version:ER-SingleTicket-1
​EntitlementConstraint · readOnly

Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.

minimumQualificationPeriod
​string

Minimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601

Example: PT1H
organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices for the entitlement required.

serviceAccessRightNetexId
​string

Reference to the serviceAccessRight required.

Example: ENT:PreassignedFareProduct:SingleTicket
typeOfUsageParameter
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating
​ValidityCondition[]

Pricing rule reference.

Updates an existing EntitlementRequired

PUT
https://api.entur.io/products
/entitlements-required/{id}/{version}

Updates an existing EntitlementRequired › path Parameters

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

The id to identify a EntitlementRequired

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

The id for the version of the EntitlementRequired

Updates an existing EntitlementRequired › 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

Updates an existing EntitlementRequired › Request Body

Entitlement Required.
EntitlementRequired
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: ENT:EntitlementRequired:SingleTicket
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the entitlement required represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: EntitlementRequired
status
​string · enum · readOnly · required

Status

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

Version

Example: ENT:Version:ER-SingleTicket-1
​EntitlementConstraint · readOnly

Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.

minimumQualificationPeriod
​string

Minimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601

Example: PT1H
organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices for the entitlement required.

serviceAccessRightNetexId
​string

Reference to the serviceAccessRight required.

Example: ENT:PreassignedFareProduct:SingleTicket
typeOfUsageParameter
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating
​ValidityCondition[]

Pricing rule reference.

Updates an existing EntitlementRequired › Responses

Entity updated successfully

No data returned

Deletes an EntitlementRequired by id and version

DELETE
https://api.entur.io/products
/entitlements-required/{id}/{version}

Deletes an EntitlementRequired by id and version › path Parameters

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

The id to identify an EntitlementRequired

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

The id for the version of the EntitlementRequired

Deletes an EntitlementRequired 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

Deletes an EntitlementRequired by id and version › Responses

The resource was deleted

BoxedUnit
entitlement-productsexchanging
Did you find what you were looking for?