Entur Developer
Products
Products

pricing-parameter-set

Server
Download schema

Retrieves a pricing-parameter-set. Limiting selection by fareFrameId parameter is supported

GET
https://api.entur.io/products
/pricing-parameter-set

Retrieves a pricing-parameter-set. Limiting selection by fareFrameId parameter is supported › query Parameters

orgId
​string · style: form · explode: true
fareFrameId
​string · style: form · explode: true

The unique id to identify data owned by organisation

languageCode
​string · style: form · explode: true

The language code from ISO-639-3

Retrieves a pricing-parameter-set. Limiting selection by fareFrameId 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 a pricing-parameter-set. Limiting selection by fareFrameId parameter is supported › Responses

Returns the info

PricingParameterSet
changed
​string · date-time · required

Changed datetime.

compatibleWithVersionRef
​string · required

Compatible with version.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: NSB:PricingParameterSet:123abc
modification
​string · enum · required

Modification status.

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

Name of class.

Example: TypeOfUsageParameter
status
​string · enum · required

Status

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

Version.

Example: NSB:Version:V1
derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

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

​TextInLanguage[]

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

​PricingRuleEntity[]

Different rules that is common for the operator

preassigned-productsproduct-tree-explanations
Did you find what you were looking for?