Entur Developer
Products
Products

preassigned-products

Server
Download schema

Retrieves a preassignedFareProduct by organisation id

GET
https://api.entur.io/products
/preassigned-products

Retrieves a preassignedFareProduct by organisation id › 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 idetify 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.

statusFilter
​string[] · style: form · explode: true

Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.

validOnDate
​string · style: form · explode: true

Return the PreassignedFareProducts valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED PreassignedFareProducts are returned. And in the staging environment, PROPOSED PreassignedFareProducts are preferred to VERSIONED ones. Mutually exclusive with statusFilter.

language
​string · style: form · explode: true

the unique id for the language

Retrieves a preassignedFareProduct by organisation 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 a preassignedFareProduct by organisation id › Responses

Returns the info

A PREASSIGNED FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT.
PreassignedFareProduct
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: PreassignedFareProduct
status
​string · enum · required

Status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

vatGroupRegister
​string · enum · required

VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.

Enum values:
EXCEPTION_FROM_VAT
GENERAL_VAT
FOOD_VAT
TRANSPORT_AND_TICKETS_VAT
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
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

CompatibleWithVersionRef.

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

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: POINT_TO_POINT_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices.

privateCode
​string

PrivateCode.

productType
​string · enum

The type of fare product.

Enum values:
SINGLE_TRIP
TIME_LIMITED_SINGLE_TRIP
PERIOD_PASS
Example: SINGLE_TRIP
​TypeOfFareProduct

A classification of FARE PRODUCTs.

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

Version.

Example: NSB:Version:V1

Create a PreassignedFareProduct

POST
https://api.entur.io/products
/preassigned-products

Create a PreassignedFareProduct › 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 a PreassignedFareProduct › Request Body

PreassignedFareProductInsert
​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:PreassignedFareProduct:RuterSingleTicket
​TextInLanguage[] · required

Name.

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

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string · required

Organisation.

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

Version.

Example: NSB:Version:V1
​VersionOfObjectRef[]

AccessRightParameterAssignments.

​AccessRightInProductInsert[]

AccessRightsInProduct.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
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

Compatible with version.

​ConditionSummaryInsert

ConditionSummary.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

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.

​FarePriceInsert[]

Fare prices.

privateCode
​string

PrivateCode.

productType
​string · enum

The type of fare product.

Enum values:
SINGLE_TRIP
Example: SINGLE_TRIP
​VersionOfObjectRef

Fare frame ref.

vatGroupRegister
​string · enum

VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT

Enum values:
EXCEPTION_FROM_VAT
GENERAL_VAT
FOOD_VAT
TRANSPORT_AND_TICKETS_VAT

Create a PreassignedFareProduct › Responses

Entity created successfully

No data returned

Retrieves the number of preassignedFareProducts. Limiting selection by fareFrameId and orgId parameter is supported

GET
https://api.entur.io/products
/preassigned-products/count

Retrieves the number of preassignedFareProducts. Limiting selection by fareFrameId and orgId parameter is supported › 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 idetify data owned by organisation

statusFilter
​string[] · style: form · explode: true

Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.

validOnDate
​string · style: form · explode: true

Count PreassignedFareProducts valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED PreassignedFareProducts are counted. And in the staging environment, PROPOSED PreassignedFareProducts are preferred to VERSIONED ones. Mutually exclusive with statusFilter.

Retrieves the number of preassignedFareProducts. Limiting selection by fareFrameId and orgId parameter is supported › 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 number of preassignedFareProducts. Limiting selection by fareFrameId and orgId parameter is supported › Responses

Returns the info

Count
Count
numberOfElements
​integer · int32 · required

number of elements

Example: 369

Retrieves preassignedFareProducts for a given page. Limiting selection by fareFrameId and orgId parameter is supported

GET
https://api.entur.io/products
/preassigned-products/pages

Retrieves preassignedFareProducts for a given page. Limiting selection by fareFrameId and orgId parameter is supported › 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 idetify 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.

pageSize
​integer · int32 · style: form · explode: true

Number of elements listed in requested page

pageNumber
​integer · int32 · style: form · explode: true

The given page one want in return

statusFilter
​string[] · style: form · explode: true

Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.

validOnDate
​string · style: form · explode: true

Return the PreassignedFareProducts valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED PreassignedFareProducts are returned. And in the staging environment, PROPOSED PreassignedFareProducts are preferred to VERSIONED ones. Mutually exclusive with statusFilter.

language
​string · style: form · explode: true

the unique id for the language

Retrieves preassignedFareProducts for a given page. Limiting selection by fareFrameId and orgId parameter is supported › 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 preassignedFareProducts for a given page. Limiting selection by fareFrameId and orgId parameter is supported › Responses

Returns the info

PreassignedFareProductWrapper
PreassignedFareProductPageWrapper
​PreassignedFareProduct[] · readOnly · required

Preassigned fare products for the given page

requestedPageNumber
​integer · int32 · required

Requested page number.

Example: 1
totalNumberOfItems
​integer · int32 · required

Total number of items.

Example: 369
totalNumberOfPages
​integer · int32 · readOnly · required

Number of pages needed to traverse all items.

Example: 15

Retrieve the latest version of preassignedFareProduct by id

GET
https://api.entur.io/products
/preassigned-products/{id}

Retrieve the latest version of preassignedFareProduct by id › path Parameters

id
​string · required · style: simple

The unique id to identify a product

Retrieve the latest version of preassignedFareProduct by id › query Parameters

version
​string · style: form · explode: true

The id of the version of the fare structure element

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.

validOnDate
​string · date-time · style: form · explode: true

Return the version valid on the given date (ISO-8601). Overrides 'version'. In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.

Retrieve the latest version of preassignedFareProduct 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.

Retrieve the latest version of preassignedFareProduct by id › Responses

Returns the resource

A PREASSIGNED FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT.
PreassignedFareProduct
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: PreassignedFareProduct
status
​string · enum · required

Status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

vatGroupRegister
​string · enum · required

VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.

Enum values:
EXCEPTION_FROM_VAT
GENERAL_VAT
FOOD_VAT
TRANSPORT_AND_TICKETS_VAT
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
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

CompatibleWithVersionRef.

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

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: POINT_TO_POINT_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices.

privateCode
​string

PrivateCode.

productType
​string · enum

The type of fare product.

Enum values:
SINGLE_TRIP
TIME_LIMITED_SINGLE_TRIP
PERIOD_PASS
Example: SINGLE_TRIP
​TypeOfFareProduct

A classification of FARE PRODUCTs.

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

Version.

Example: NSB:Version:V1

Retrives refunding rules by fare product id and version

GET
https://api.entur.io/products
/preassigned-products/{id}/refunding

Retrives refunding rules by fare product id and version › path Parameters

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

The unique id to identify a fareProduct

Retrives refunding rules by fare product id and version › query Parameters

version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: form · explode: true
languageCode
​string · style: form · explode: true

the unique id for the language

productVersionId
​string · style: form · explode: true

The version of the fareProduct

Retrives refunding rules by fare product 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

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.

Retrives refunding rules by fare product id and version › Responses

Returns the info

Refunding
Refunding
allowed
​string · enum · required

Allowed.

Enum values:
NONE
PARTIAL
FULL
Example: FULL
changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare tables.

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

Id.

Example: NSB:Refunding:FullRefundUntilLimit
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: Refunding
status
​string · enum · required

Refunding status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Refunding version.

Example: NSB:Version:V1
canChangeClass
​boolean

Whether user can change class.

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

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

exchangeableFromAnyTime
​boolean

Can be exchanged or refunded from any point after purchase.

exchangeableFromDuration
​string

Exchangeable from duration.

Example: PT24H
exchangeableUntilAnyTime
​boolean

Can be exchanged or refunded until any point after purchase.

exchangeableUntilDuration
​string

Exchangeable until duration.

hasFee
​boolean

Has fee.

limitingRule
​string

Pricing rule.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

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

onlyAtCertainDistributionPoints
​boolean

Whether distribution is restricted to certain points.

​FarePrice[]

Prices in different currencies for the refunding rule.

refundBasis
​string · enum

Basis on which refund is made. See allowed values below.

Enum values:
PER_OFFER
PER_PERSON
Example: PER_OFFER
refundType
​string · enum

Refund type.

Enum values:
UNUSED
DELAY
CANCELLATION
PARTIAL_JOURNEY
OTHER
Example: UNUSED
resellWhen
​string · enum

Event marking when the refundable status of the ticket changes.

Enum values:
NEVER
BEFORE_START_OF_VALIDITY_PERIOD
AFTER_START_OF_VALIDITY_PERIOD
AFTER_END_OF_VALIDITY_PERIOD
BEFORE_FIRST_USE
AFTER_FIRST_USE
BEFORE_VALIDATION
AFTER_VALIDATION
Example: NEVER
unusedTicketsOnly
​boolean

Unused tickets only.

Retrieves the latest version of preassignedFareProduct by id and version

GET
https://api.entur.io/products
/preassigned-products/{id}/{version}

Retrieves the latest version of preassignedFareProduct by id and version › 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 fare structure element

Retrieves the latest version of preassignedFareProduct by id and version › query Parameters

gpaDataSet
​string · style: form · explode: true

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

Retrieves the latest version of preassignedFareProduct 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 the latest version of preassignedFareProduct by id and version › Responses

Returns the resource

A PREASSIGNED FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT.
PreassignedFareProduct
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: PreassignedFareProduct
status
​string · enum · required

Status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

vatGroupRegister
​string · enum · required

VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.

Enum values:
EXCEPTION_FROM_VAT
GENERAL_VAT
FOOD_VAT
TRANSPORT_AND_TICKETS_VAT
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
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

CompatibleWithVersionRef.

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

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: POINT_TO_POINT_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices.

privateCode
​string

PrivateCode.

productType
​string · enum

The type of fare product.

Enum values:
SINGLE_TRIP
TIME_LIMITED_SINGLE_TRIP
PERIOD_PASS
Example: SINGLE_TRIP
​TypeOfFareProduct

A classification of FARE PRODUCTs.

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

Version.

Example: NSB:Version:V1

Update a preassigned fare product parameter.

PUT
https://api.entur.io/products
/preassigned-products/{id}/{version}

Update a preassigned fare product 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 fare structure element

Update a preassigned fare product 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 a preassigned fare product parameter. › Request Body

PreassignedFareProductInsert
​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:PreassignedFareProduct:RuterSingleTicket
​TextInLanguage[] · required

Name.

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

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string · required

Organisation.

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

Version.

Example: NSB:Version:V1
​VersionOfObjectRef[]

AccessRightParameterAssignments.

​AccessRightInProductInsert[]

AccessRightsInProduct.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
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

Compatible with version.

​ConditionSummaryInsert

ConditionSummary.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

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.

​FarePriceInsert[]

Fare prices.

privateCode
​string

PrivateCode.

productType
​string · enum

The type of fare product.

Enum values:
SINGLE_TRIP
Example: SINGLE_TRIP
​VersionOfObjectRef

Fare frame ref.

vatGroupRegister
​string · enum

VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT

Enum values:
EXCEPTION_FROM_VAT
GENERAL_VAT
FOOD_VAT
TRANSPORT_AND_TICKETS_VAT

Update a preassigned fare product parameter. › Responses

Entity updated successfully

No data returned

Retrieves the latest version of preassignedFareProduct by id

GET
https://api.entur.io/products
/v1/preassigned-products/{id}

Retrieves the latest version of preassignedFareProduct by id › path Parameters

id
​string · required · style: simple

The unique id to identify a product

Retrieves the latest version of preassignedFareProduct by id › query Parameters

startDate
​string · style: form · explode: true
endDate
​string · style: form · explode: true
status
​string · style: form · explode: true

The version status of the product

gpaDataSet
​string · style: form · explode: true

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

fromDate
​string · style: form · explode: true

The from date of the products version

toDate
​string · style: form · explode: true

The to date of the products version

Retrieves the latest version of preassignedFareProduct 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

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 the latest version of preassignedFareProduct by id › Responses

Returns the resource

A PREASSIGNED FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT.
PreassignedFareProduct
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: PreassignedFareProduct
status
​string · enum · required

Status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

vatGroupRegister
​string · enum · required

VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.

Enum values:
EXCEPTION_FROM_VAT
GENERAL_VAT
FOOD_VAT
TRANSPORT_AND_TICKETS_VAT
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
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

CompatibleWithVersionRef.

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

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: POINT_TO_POINT_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices.

privateCode
​string

PrivateCode.

productType
​string · enum

The type of fare product.

Enum values:
SINGLE_TRIP
TIME_LIMITED_SINGLE_TRIP
PERIOD_PASS
Example: SINGLE_TRIP
​TypeOfFareProduct

A classification of FARE PRODUCTs.

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

Version.

Example: NSB:Version:V1
period-ticketspricing-parameter-set
Did you find what you were looking for?