Retrieves an amount of price unit products, 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
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 an amount of price unit products, filtered by given parameter(s) › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
amountAmount. Must be greater than 0.
statusStatus
productTypeAmountOfPriceUnitProductType.
Fare frame ref.
modificationModification status.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z…Version
Description represented in different languages. Language codes are ISO-639.
nameOfClassName of class.
operatorRefOperatorRef.
privateCodePrivateCode.
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.
ValidityCondition.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef
AccessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignmentRefs.
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 an AmountOfPriceUnitProduct
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 AmountOfPriceUnitProduct › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
amountAmount. Must be greater than 0.
statusStatus
productTypeAmountOfPriceUnitProductType.
Fare frame ref.
modificationModification status.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z…Version
Description represented in different languages. Language codes are ISO-639.
nameOfClassName of class.
operatorRefOperatorRef.
privateCodePrivateCode.
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.
ValidityCondition.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef
AccessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignmentRefs.
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 an AmountOfPriceUnitProduct › Responses
Entity created successfully
Retrieves the latest version of an AmountOfPriceUnitProduct by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify the amount of price unit product
query Parameters
versionThe id of the version of the amount of price unit product
languageCodeThe language code from ISO-639-3
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 the latest version of an AmountOfPriceUnitProduct by id › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
amountAmount. Must be greater than 0.
statusStatus
productTypeAmountOfPriceUnitProductType.
Fare frame ref.
modificationModification status.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z…Version
Description represented in different languages. Language codes are ISO-639.
nameOfClassName of class.
operatorRefOperatorRef.
privateCodePrivateCode.
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.
ValidityCondition.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef
AccessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignmentRefs.
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 an AmountOfPriceUnitProduct by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify the an amount of price unit product
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id of the version of the amount of price unit product
query Parameters
languageCodegpaDataSetType 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 an AmountOfPriceUnitProduct by id and version › Responses
Returns the resource
id^([A-Z]{3}):([A-Za-z… · requiredId.
amountAmount. Must be greater than 0.
statusStatus
productTypeAmountOfPriceUnitProductType.
Fare frame ref.
modificationModification status.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z…Version
Description represented in different languages. Language codes are ISO-639.
nameOfClassName of class.
operatorRefOperatorRef.
privateCodePrivateCode.
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.
ValidityCondition.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef
AccessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignmentRefs.
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 an AmountOfPriceUnitProduct parameter.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a product
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id of the version of the amount of price unit product
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 an AmountOfPriceUnitProduct parameter. › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
amountAmount. Must be greater than 0.
statusStatus
productTypeAmountOfPriceUnitProductType.
Fare frame ref.
modificationModification status.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z…Version
Description represented in different languages. Language codes are ISO-639.
nameOfClassName of class.
operatorRefOperatorRef.
privateCodePrivateCode.
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.
ValidityCondition.
AccessRightsInProduct.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatibleWithVersionRef
AccessRightParameterAssignments.
activeComparisonOperatorVariantIndicates whether A or E gpa implementation is active.
AccessRightParameterAssignmentRefs.
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 an AmountOfPriceUnitProduct parameter. › Responses
Entity updated successfully