Entur Developer
Products
Products

amount-of-price-unit-products

Server
Download schema

Retrieves an amount of price unit products, filtered by given parameter(s)

GET
https://api.entur.io/products
/amount-of-price-unit-products

Retrieves an amount of price unit products, filtered by given parameter(s) › query Parameters

orgId
​string · style: form · explode: true

The unique id to identify a organisation

fareFrameId
​string · style: form · explode: true

The unique id to identify data owned by organisation

languageCode
​string · style: form · explode: true
gpaDataSet
​string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

language
​string · style: form · explode: true

The unique id for the language

Retrieves an amount of price unit products, filtered by given parameter(s) › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

If-None-Match
​string · style: simple

Used 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

An Amount Of Price Unit Product response
AmountOfPriceUnitProduct
amount
​integer · int32 · min: 1 · required

Amount. Must be greater than 0.

Example: 10
​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:AmountOfPriceUnitProduct:RuterCarnetTicket
modification
​string · enum · readOnly · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
productType
​string · enum · required

AmountOfPriceUnitProductType.

Enum values:
TRIP_CARNET
PASS_CARNET
UNIT_COUPON
STORED_VALUE
OTHER
Example: TRIP_CARNET
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​VersionOfObjectRef[] · writeOnly

AccessRightParameterAssignmentRefs.

​GenericParameterAssignment[] · readOnly

AccessRightParameterAssignments.

​AccessRightInProduct[]

AccessRightsInProduct.

activeComparisonOperatorVariant
​string

Deprecated: this parameter is ignored.

Example: E
changed
​string · readOnly

Changed datetime.

chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

created
​string · readOnly

Created datetime.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

nameOfClass
​string · readOnly

Name of class.

Example: AmountOfPriceUnitProduct
operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​ValidityCondition[] · readOnly

ValidityCondition.

version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

Create an AmountOfPriceUnitProduct

POST
https://api.entur.io/products
/amount-of-price-unit-products

Create an AmountOfPriceUnitProduct › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

Create an AmountOfPriceUnitProduct › Request Body

An Amount Of Price Unit Product response
AmountOfPriceUnitProduct
amount
​integer · int32 · min: 1 · required

Amount. Must be greater than 0.

Example: 10
​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:AmountOfPriceUnitProduct:RuterCarnetTicket
modification
​string · enum · readOnly · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
productType
​string · enum · required

AmountOfPriceUnitProductType.

Enum values:
TRIP_CARNET
PASS_CARNET
UNIT_COUPON
STORED_VALUE
OTHER
Example: TRIP_CARNET
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​VersionOfObjectRef[] · writeOnly

AccessRightParameterAssignmentRefs.

​GenericParameterAssignment[] · readOnly

AccessRightParameterAssignments.

​AccessRightInProduct[]

AccessRightsInProduct.

activeComparisonOperatorVariant
​string

Deprecated: this parameter is ignored.

Example: E
changed
​string · readOnly

Changed datetime.

chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

created
​string · readOnly

Created datetime.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

nameOfClass
​string · readOnly

Name of class.

Example: AmountOfPriceUnitProduct
operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​ValidityCondition[] · readOnly

ValidityCondition.

version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

Create an AmountOfPriceUnitProduct › Responses

Entity created successfully

No data returned

Retrieves the latest version of an AmountOfPriceUnitProduct by id

GET
https://api.entur.io/products
/amount-of-price-unit-products/{id}

Retrieves the latest version of an AmountOfPriceUnitProduct by id › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify the amount of price unit product

Retrieves the latest version of an AmountOfPriceUnitProduct by id › query Parameters

version
​string · style: form · explode: true

The id of the version of the amount of price unit product

languageCode
​string · style: form · explode: true

The language code from ISO-639-3

gpaDataSet
​string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

Retrieves the latest version of an AmountOfPriceUnitProduct by id › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

If-None-Match
​string · style: simple

Used 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

An Amount Of Price Unit Product response
AmountOfPriceUnitProduct
amount
​integer · int32 · min: 1 · required

Amount. Must be greater than 0.

Example: 10
​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:AmountOfPriceUnitProduct:RuterCarnetTicket
modification
​string · enum · readOnly · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
productType
​string · enum · required

AmountOfPriceUnitProductType.

Enum values:
TRIP_CARNET
PASS_CARNET
UNIT_COUPON
STORED_VALUE
OTHER
Example: TRIP_CARNET
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​VersionOfObjectRef[] · writeOnly

AccessRightParameterAssignmentRefs.

​GenericParameterAssignment[] · readOnly

AccessRightParameterAssignments.

​AccessRightInProduct[]

AccessRightsInProduct.

activeComparisonOperatorVariant
​string

Deprecated: this parameter is ignored.

Example: E
changed
​string · readOnly

Changed datetime.

chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

created
​string · readOnly

Created datetime.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

nameOfClass
​string · readOnly

Name of class.

Example: AmountOfPriceUnitProduct
operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​ValidityCondition[] · readOnly

ValidityCondition.

version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

Retrieves an AmountOfPriceUnitProduct by id and version

GET
https://api.entur.io/products
/amount-of-price-unit-products/{id}/{version}

Retrieves an AmountOfPriceUnitProduct by id and version › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify the an amount of price unit product

version
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id of the version of the amount of price unit product

Retrieves an AmountOfPriceUnitProduct by id and version › query Parameters

languageCode
​string · style: form · explode: true
gpaDataSet
​string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

Retrieves an AmountOfPriceUnitProduct by id and version › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

Accept-Language
​string · style: simple

The language code from ISO-639-3

If-None-Match
​string · style: simple

Used 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

An Amount Of Price Unit Product response
AmountOfPriceUnitProduct
amount
​integer · int32 · min: 1 · required

Amount. Must be greater than 0.

Example: 10
​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:AmountOfPriceUnitProduct:RuterCarnetTicket
modification
​string · enum · readOnly · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
productType
​string · enum · required

AmountOfPriceUnitProductType.

Enum values:
TRIP_CARNET
PASS_CARNET
UNIT_COUPON
STORED_VALUE
OTHER
Example: TRIP_CARNET
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​VersionOfObjectRef[] · writeOnly

AccessRightParameterAssignmentRefs.

​GenericParameterAssignment[] · readOnly

AccessRightParameterAssignments.

​AccessRightInProduct[]

AccessRightsInProduct.

activeComparisonOperatorVariant
​string

Deprecated: this parameter is ignored.

Example: E
changed
​string · readOnly

Changed datetime.

chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

created
​string · readOnly

Created datetime.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

nameOfClass
​string · readOnly

Name of class.

Example: AmountOfPriceUnitProduct
operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​ValidityCondition[] · readOnly

ValidityCondition.

version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

Update an AmountOfPriceUnitProduct parameter.

PUT
https://api.entur.io/products
/amount-of-price-unit-products/{id}/{version}

Update an AmountOfPriceUnitProduct parameter. › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a product

version
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id of the version of the amount of price unit product

Update an AmountOfPriceUnitProduct parameter. › Headers

ET-Client-Name
​string · style: simple

Entur 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-Id
​string · style: simple

Correlation id

Update an AmountOfPriceUnitProduct parameter. › Request Body

An Amount Of Price Unit Product response
AmountOfPriceUnitProduct
amount
​integer · int32 · min: 1 · required

Amount. Must be greater than 0.

Example: 10
​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:AmountOfPriceUnitProduct:RuterCarnetTicket
modification
​string · enum · readOnly · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
productType
​string · enum · required

AmountOfPriceUnitProductType.

Enum values:
TRIP_CARNET
PASS_CARNET
UNIT_COUPON
STORED_VALUE
OTHER
Example: TRIP_CARNET
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​VersionOfObjectRef[] · writeOnly

AccessRightParameterAssignmentRefs.

​GenericParameterAssignment[] · readOnly

AccessRightParameterAssignments.

​AccessRightInProduct[]

AccessRightsInProduct.

activeComparisonOperatorVariant
​string

Deprecated: this parameter is ignored.

Example: E
changed
​string · readOnly

Changed datetime.

chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

created
​string · readOnly

Created datetime.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

nameOfClass
​string · readOnly

Name of class.

Example: AmountOfPriceUnitProduct
operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​ValidityCondition[] · readOnly

ValidityCondition.

version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

Update an AmountOfPriceUnitProduct parameter. › Responses

Entity updated successfully

No data returned
admin/cacheavailability-conditions
Did you find what you were looking for?