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
languageCodegpaDataSetType of gpa dataset
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL
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> 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 a capped discount right, filtered by given parameter(s) › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class.
Fare frame ref.
modificationModification status.
vatGroupRegisterVatGroupRegister.
ValidityCondition.
Name represented in different languages. Language codes are ISO-639.
Prices.
Description represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
privateCodePrivateCode.
Capping rules.
organisationOrganisation who own the product.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
validationRequirementsAn optional set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatibleWithVersionRef
AccessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a capped discount right › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
operatorRefOperatorRef.
Fare frame ref.
organisation^([A-Z]{3}):([A-Za-z… · requiredOrganisation.
Fare frame ref.
Prices.
Description.
privateCodePrivateCode.
Capping rules.
FareTableRef.
ConditionSummary.
vatGroupRegisterVatGroupRegister.
fareStructureTypeFareStructureType.
chargingMomentTypeChargingMomentType.
Fare frame ref.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
validationRequirementsA set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatible with version.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignments.
Create a capped discount right › Responses
Entity created successfully
Retrieves the latest version of a capped discount right by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe 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
gpaDataSetType of gpa dataset
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
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 the latest version of a capped discount right by id › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class.
Fare frame ref.
modificationModification status.
vatGroupRegisterVatGroupRegister.
ValidityCondition.
Name represented in different languages. Language codes are ISO-639.
Prices.
Description represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
privateCodePrivateCode.
Capping rules.
organisationOrganisation who own the product.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
validationRequirementsAn optional set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatibleWithVersionRef
AccessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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
gpaDataSetType of gpa dataset
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
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
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class.
Fare frame ref.
modificationModification status.
vatGroupRegisterVatGroupRegister.
ValidityCondition.
Name represented in different languages. Language codes are ISO-639.
Prices.
Description represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
privateCodePrivateCode.
Capping rules.
organisationOrganisation who own the product.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
validationRequirementsAn optional set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatibleWithVersionRef
AccessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update a capped discount right › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
operatorRefOperatorRef.
Fare frame ref.
organisation^([A-Z]{3}):([A-Za-z… · requiredOrganisation.
Fare frame ref.
Prices.
Description.
privateCodePrivateCode.
Capping rules.
FareTableRef.
ConditionSummary.
vatGroupRegisterVatGroupRegister.
fareStructureTypeFareStructureType.
chargingMomentTypeChargingMomentType.
Fare frame ref.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
validationRequirementsA set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatible with version.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignments.
Update a capped discount right › Responses
Entity updated successfully