Retrieves all entitlement given
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
minimizeDataLoadHeaders
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 entitlement given › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId
The name of the entitlement given represented in different languages. Language codes are ISO-639
Prices for the entitlement given.
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
entitlementTypeEntitlement type
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.
Fare frame ref.
minimumQualificationPeriodMinimum qualification period
Create a EntitlementGiven
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 EntitlementGiven › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId
The name of the entitlement given represented in different languages. Language codes are ISO-639
Prices for the entitlement given.
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
entitlementTypeEntitlement type
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.
Fare frame ref.
minimumQualificationPeriodMinimum qualification period
Create a EntitlementGiven › Responses
Entity created successfully
Retrieves entitlement given for id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a EntitlementGiven
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the EntitlementGiven
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 entitlement given for id and version › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId
The name of the entitlement given represented in different languages. Language codes are ISO-639
Prices for the entitlement given.
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
entitlementTypeEntitlement type
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.
Fare frame ref.
minimumQualificationPeriodMinimum qualification period
Updates an existing EntitlementGiven
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a EntitlementGiven
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the EntitlementGiven
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 EntitlementGiven › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId
The name of the entitlement given represented in different languages. Language codes are ISO-639
Prices for the entitlement given.
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
entitlementTypeEntitlement type
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.
Fare frame ref.
minimumQualificationPeriodMinimum qualification period
Updates an existing EntitlementGiven › Responses
Entity updated successfully
Deletes an entitlement given by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify an entitlement given
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the entitlement given
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 entitlement given by id and version › Responses
The resource was deleted