Retrieves all entitlements required
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
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 all entitlements required › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId
The name of the entitlement required represented in different languages. Language codes are ISO-639
statusStatus
changedChanged datetime
createdCreated datetime
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Description represented in different languages. Language codes are ISO-639
nameOfClassName of class
Fare frame ref.
modificationModification status
Fare prices for the entitlement required.
organisationIdOrganisation related to the userProfile
Pricing rule reference.
typeOfUsageParametertypeOfUsageParameter.
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.
serviceAccessRightNetexIdReference to the serviceAccessRight required.
minimumQualificationPeriodMinimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601
Create an EntitlementRequired
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 an EntitlementRequired › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId
The name of the entitlement required represented in different languages. Language codes are ISO-639
statusStatus
changedChanged datetime
createdCreated datetime
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Description represented in different languages. Language codes are ISO-639
nameOfClassName of class
Fare frame ref.
modificationModification status
Fare prices for the entitlement required.
organisationIdOrganisation related to the userProfile
Pricing rule reference.
typeOfUsageParametertypeOfUsageParameter.
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.
serviceAccessRightNetexIdReference to the serviceAccessRight required.
minimumQualificationPeriodMinimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601
Create an EntitlementRequired › Responses
Entity created successfully
Retrieves EntitlementRequired for id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a EntitlementRequired
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the EntitlementRequired
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 EntitlementRequired for id and version › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId
The name of the entitlement required represented in different languages. Language codes are ISO-639
statusStatus
changedChanged datetime
createdCreated datetime
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Description represented in different languages. Language codes are ISO-639
nameOfClassName of class
Fare frame ref.
modificationModification status
Fare prices for the entitlement required.
organisationIdOrganisation related to the userProfile
Pricing rule reference.
typeOfUsageParametertypeOfUsageParameter.
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.
serviceAccessRightNetexIdReference to the serviceAccessRight required.
minimumQualificationPeriodMinimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601
Updates an existing EntitlementRequired
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a EntitlementRequired
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the EntitlementRequired
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
Updates an existing EntitlementRequired › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId
The name of the entitlement required represented in different languages. Language codes are ISO-639
statusStatus
changedChanged datetime
createdCreated datetime
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Description represented in different languages. Language codes are ISO-639
nameOfClassName of class
Fare frame ref.
modificationModification status
Fare prices for the entitlement required.
organisationIdOrganisation related to the userProfile
Pricing rule reference.
typeOfUsageParametertypeOfUsageParameter.
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.
serviceAccessRightNetexIdReference to the serviceAccessRight required.
minimumQualificationPeriodMinimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601
Updates an existing EntitlementRequired › Responses
Entity updated successfully
Deletes an EntitlementRequired by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify an EntitlementRequired
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the EntitlementRequired
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
Deletes an EntitlementRequired by id and version › Responses
The resource was deleted