Entur Developer
Products

fare-frames

Server

Retrieves fare frames by organisation id

GET
https://api.entur.io/products
/fare-frames

Retrieves fare frames by organisation id › query Parameters

orgId
​string · style: form · explode: true

The unique id to identify a organisation

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

The language code from ISO-639-3

Retrieves fare frames 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 fare frames by organisation id › Responses

Returns the info

​FareFrame[]
A FareFrame
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

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

Id.

Example: NSB:FareFrame:Child
modification
​string · enum · readOnly · required

Modification status.

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

Name of class.

Example: FareFrame
status
​string · enum · readOnly · required

Status

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

FareFrame version.

Example: NSB:Version:V1
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​FareProduct[]

FareProducts.

​FareStructureElement[]

FareStructureElements.

​TextInLanguage[]

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

​SalesPackage[]

SalesPackages.

transportOrganisationNameOfClass
​string

Transport organisation nameOfClass.

Example: 16
transportOrganisationNetexId
​string

Transport organisation netexId.

transportOrganisationRef
​string

Transport organisation ref.

Example: CHILD
transportOrganisationVersion
​string

Transport organisation version.

Example: 4
typeOfFareFrameNetexId
​string

Type of fareFrame netexId.

​VersionOfObjectRef

Fare frame ref.

typeOfFareFrameVersion
​string

Type of fareFrame version.

​ValidableElement[]

ValidableElements.

​ValidityCondition[]

Validity condition.

vehicleMode
​string · enum

Vehicle mode.

Enum values:
AIR
BUS
CABLE_WAY
WATER
FUNICULAR
LIFT
RAIL
METRO

Retrives a fareFrames by id

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

Retrives a fareFrames by id › path Parameters

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

The unique id to identify a fareFrames

Retrives a fareFrames by id › query Parameters

version
​string · style: form · explode: true

The id for the version of the fareFrames

languageCode
​string · style: form · explode: true

The language code from ISO-639-3

Retrives a fareFrames 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.

Retrives a fareFrames by id › Responses

Returns the info

A FareFrame
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

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

Id.

Example: NSB:FareFrame:Child
modification
​string · enum · readOnly · required

Modification status.

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

Name of class.

Example: FareFrame
status
​string · enum · readOnly · required

Status

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

FareFrame version.

Example: NSB:Version:V1
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​FareProduct[]

FareProducts.

​FareStructureElement[]

FareStructureElements.

​TextInLanguage[]

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

​SalesPackage[]

SalesPackages.

transportOrganisationNameOfClass
​string

Transport organisation nameOfClass.

Example: 16
transportOrganisationNetexId
​string

Transport organisation netexId.

transportOrganisationRef
​string

Transport organisation ref.

Example: CHILD
transportOrganisationVersion
​string

Transport organisation version.

Example: 4
typeOfFareFrameNetexId
​string

Type of fareFrame netexId.

​VersionOfObjectRef

Fare frame ref.

typeOfFareFrameVersion
​string

Type of fareFrame version.

​ValidableElement[]

ValidableElements.

​ValidityCondition[]

Validity condition.

vehicleMode
​string · enum

Vehicle mode.

Enum values:
AIR
BUS
CABLE_WAY
WATER
FUNICULAR
LIFT
RAIL
METRO

Retrives a fareFrames by id and version.

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

Retrives a fareFrames by id and version. › path Parameters

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

The unique id to identify a fareFrames

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

The id for the version of the fareFrames

Retrives a fareFrames 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

Languagecode
​string · style: simple
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.

Retrives a fareFrames by id and version. › Responses

Returns the info

A FareFrame
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

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

Id.

Example: NSB:FareFrame:Child
modification
​string · enum · readOnly · required

Modification status.

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

Name of class.

Example: FareFrame
status
​string · enum · readOnly · required

Status

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

FareFrame version.

Example: NSB:Version:V1
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​FareProduct[]

FareProducts.

​FareStructureElement[]

FareStructureElements.

​TextInLanguage[]

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

​SalesPackage[]

SalesPackages.

transportOrganisationNameOfClass
​string

Transport organisation nameOfClass.

Example: 16
transportOrganisationNetexId
​string

Transport organisation netexId.

transportOrganisationRef
​string

Transport organisation ref.

Example: CHILD
transportOrganisationVersion
​string

Transport organisation version.

Example: 4
typeOfFareFrameNetexId
​string

Type of fareFrame netexId.

​VersionOfObjectRef

Fare frame ref.

typeOfFareFrameVersion
​string

Type of fareFrame version.

​ValidableElement[]

ValidableElements.

​ValidityCondition[]

Validity condition.

vehicleMode
​string · enum

Vehicle mode.

Enum values:
AIR
BUS
CABLE_WAY
WATER
FUNICULAR
LIFT
RAIL
METRO

Retrieves a fare frames by id

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

Retrieves a fare frames by id › path Parameters

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

The unique id to identify a fare frames

Retrieves a fare frames 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 fare frame

fromDate
​string · style: form · explode: true

The from date of the fare frames version

toDate
​string · style: form · explode: true

The to date of the fare frames version

Retrieves a fare frames 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

Languagecode
​string · style: simple
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 a fare frames by id › Responses

Returns the info

​FareFrame[]
A FareFrame
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

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

Id.

Example: NSB:FareFrame:Child
modification
​string · enum · readOnly · required

Modification status.

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

Name of class.

Example: FareFrame
status
​string · enum · readOnly · required

Status

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

FareFrame version.

Example: NSB:Version:V1
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​FareProduct[]

FareProducts.

​FareStructureElement[]

FareStructureElements.

​TextInLanguage[]

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

​SalesPackage[]

SalesPackages.

transportOrganisationNameOfClass
​string

Transport organisation nameOfClass.

Example: 16
transportOrganisationNetexId
​string

Transport organisation netexId.

transportOrganisationRef
​string

Transport organisation ref.

Example: CHILD
transportOrganisationVersion
​string

Transport organisation version.

Example: 4
typeOfFareFrameNetexId
​string

Type of fareFrame netexId.

​VersionOfObjectRef

Fare frame ref.

typeOfFareFrameVersion
​string

Type of fareFrame version.

​ValidableElement[]

ValidableElements.

​ValidityCondition[]

Validity condition.

vehicleMode
​string · enum

Vehicle mode.

Enum values:
AIR
BUS
CABLE_WAY
WATER
FUNICULAR
LIFT
RAIL
METRO

Did you find what you were looking for?