Retrieves all sale discount rights
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
minimizeDataLoadPossibility of opting out of including child elements
gpaDataSetType of gpa dataset
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.
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 sale discount rights › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
Prices for the sdr.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation who own the product.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Description represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
privateCodePrivateCode.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
Fare frame ref.
derivedFromVersionRefDerived from version.
validationRequirementsA set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatibleWithVersionRef
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 SaleDiscountRight
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 SaleDiscountRight › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Prices for the sdr.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation who own the product.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Description represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
privateCodePrivateCode.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
Fare frame ref.
derivedFromVersionRefDerived from version.
validationRequirementsA set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatibleWithVersionRef
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 SaleDiscountRight › Responses
Entity created successfully
Retrieves newest sale discount right for id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a SaleDiscountRight
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
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 newest sale discount right for id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
Prices for the sdr.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation who own the product.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Description represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
privateCodePrivateCode.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
Fare frame ref.
derivedFromVersionRefDerived from version.
validationRequirementsA set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatibleWithVersionRef
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 the number of sale discount rights
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.
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 number of sale discount rights › Responses
Retrieve sale discount rights for a given page. Limiting selection by fareFrameId and orgId parameter is supported
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
minimizeDataLoadPossibility of opting out of including child elements
gpaDataSetType of gpa dataset
pageSizeSize of page
pageNumberPage number
statusFilterFilter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.
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.
Retrieve sale discount rights for a given page. Limiting selection by fareFrameId and orgId parameter is supported › Responses
Returns the info
SaleDiscountRights for the given page
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
requestedPageNumberNumber of the requested page. In case state is lost
Retrieves sale discount right for id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a SaleDiscountRight
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the SaleDiscountRight
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
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 sale discount right for id and version › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
Prices for the sdr.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation who own the product.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Description represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
privateCodePrivateCode.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
Fare frame ref.
derivedFromVersionRefDerived from version.
validationRequirementsA set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatibleWithVersionRef
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.
Updates an existing SaleDiscountRight
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a SaleDiscountRight
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the SaleDiscountRight
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 SaleDiscountRight › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Prices for the sdr.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation who own the product.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Description represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
privateCodePrivateCode.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
Fare frame ref.
derivedFromVersionRefDerived from version.
validationRequirementsA set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatibleWithVersionRef
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.
Updates an existing SaleDiscountRight › Responses
Entity updated successfully
Deletes a SaleDiscountRight by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a SaleDiscountRight
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the SaleDiscountRight
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 a SaleDiscountRight by id and version › Responses
The resource was deleted
Retrieves sale discount rights by id of the entitlement given they are connected to
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify an EntitlementGiven
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
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 sale discount rights by id of the entitlement given they are connected to › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
Prices for the sdr.
statusStatus
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassName of class.
Fare frame ref.
modificationModification status.
organisationOrganisation who own the product.
ValidityCondition.
AccessRightsInProduct.
AccessRightParameterAssignments.
Name represented in different languages. Language codes are ISO-639.
Description represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
privateCodePrivateCode.
FareTableRef.
organisationIdOrganisation related to the userProfile
Fare frame ref.
A summary of a condition.
fareStructureTypeFareStructureType.
A classification of FARE PRODUCTs.
chargingMomentTypeChargingMomentType.
Fare frame ref.
derivedFromVersionRefDerived from version.
validationRequirementsA set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
compatibleWithVersionRefCompatibleWithVersionRef
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.