Retrieves a capped discount right, filtered by given parameter(s)
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to identify data owned by organisation
languageCodegpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Mutually exclusive with validOnDate.
validOnDateReturn the CappedDiscountRights valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED CappedDiscountRights are returned. And in the staging environment, PROPOSED CappedDiscountRights are preferred to VERSIONED ones. Mutually exclusive with statusFilter.
languageThe unique id for the language
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>.
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 a capped discount right, filtered by given parameter(s) › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
ValidityCondition.
vatGroupRegisterVatGroupRegister.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
Capping rules.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
Prices.
privateCodePrivateCode.
A classification of FARE PRODUCTs.
validationRequirementsAn optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
Create a capped discount right
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>.
X-Correlation-IdCorrelation id
Create a capped discount right › Request Body
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
operatorRefOperatorRef.
organisation^([A-Z]{3}):([A-Za-z… · requiredOrganisation.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
Capping rules.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
ConditionSummary.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Prices.
privateCodePrivateCode.
Fare frame ref.
validationRequirementsAn optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
vatGroupRegisterVatGroupRegister.
Create a capped discount right › Responses
Entity created successfully
Retrieves the latest version of a capped discount right by id
path Parameters
idThe unique id to identify the capped discount right
query Parameters
versionThe id of the version of the capped discount right
languageCodeThe language code from ISO-639-3
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
findActiveInEnvironmentToggles whether you want to find latest version or latest active version for specific environment, so in staging that would be a proposed version, while in production it will only be a versioned version
validOnDateReturn the version valid on the given date (ISO-8601). Overrides 'version' and 'findActiveInEnvironment'. In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.
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>.
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 the latest version of a capped discount right by id › Responses
Returns the resource
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
ValidityCondition.
vatGroupRegisterVatGroupRegister.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
Capping rules.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
Prices.
privateCodePrivateCode.
A classification of FARE PRODUCTs.
validationRequirementsAn optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
Retrieves a capped discount right by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify the capped discount right
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id of the version of the capped discount right
query Parameters
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
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>.
X-Correlation-IdCorrelation id
Accept-LanguageThe language code from ISO-639-3
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 a capped discount right by id and version › Responses
Returns the resource
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
ValidityCondition.
vatGroupRegisterVatGroupRegister.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
Capping rules.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
Prices.
privateCodePrivateCode.
A classification of FARE PRODUCTs.
validationRequirementsAn optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
Update a capped discount right
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify the capped discount right
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id of the version of the capped discount right
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>.
X-Correlation-IdCorrelation id
Update a capped discount right › Request Body
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
operatorRefOperatorRef.
organisation^([A-Z]{3}):([A-Za-z… · requiredOrganisation.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
Capping rules.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
ConditionSummary.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Prices.
privateCodePrivateCode.
Fare frame ref.
validationRequirementsAn optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
vatGroupRegisterVatGroupRegister.
Update a capped discount right › Responses
Entity updated successfully