Entur Developer
Products
Products

fare-structure-elements

Server
Download schema

Retrieves a preassignedFareProduct by organisation id

GET
https://api.entur.io/products
/fare-structure-elements

Retrieves a preassignedFareProduct by organisation id › query Parameters

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

The unique id to identify a dataset for an organization

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

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

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 element describing the response structure of the fare
FareStructureElement
changed
​string · date-time · required

Changed datetime.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

fare table reference

​VersionOfObjectRef[] · required

geographical interval sequence

​VersionOfObjectRef[] · required

geographical structure factor refs

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

Id.

Example: NSB:FareStructureElement:TENInterval
modification
​string · enum · required

Modification status.

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

Name of class.

Example: FareStructureElement
​GenericParameterAssignment[] · required

Access Right Parameter assignments.

​VersionOfObjectRef[] · required

quality structure factor refs

status
​string · enum · required

Status.

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

ValidityConditions sequence.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​TextInLanguage[]

Description.

​LimitingRule

A LimitingRule

​TextInLanguage[]

Name.

organisationId
​string · readOnly

Organisation related to the userProfile

​FarePrice[]

Fare prices.

tariffBasis
​string · enum

Tariff basis.

Enum values:
FLAT
DISTANCE
UNIT_SECTION
ZONE
ZONE_TO_ZONE
POINT_TO_POINT
ROUTE
TOUR
Example: DISTANCE
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

Create a Fare structure element

POST
https://api.entur.io/products
/fare-structure-elements

Create a Fare structure element › 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 Fare structure element › Request Body

FareStructureElementInsert
​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

fare table reference

​VersionOfObjectRef[] · required

geographical interval sequence

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

Id.

Example: NSB:FareStructureElement:TENInterval
​VersionOfObjectRef[] · required

Access Right Parameter assignments.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​TextInLanguage[]

Description.

geographicalStructureFactorId
​string

Geographical structure factor id

Example: NSB:GeographicalStructureFactor:TENPrices
​TextInLanguage[]

Name.

​FarePriceInsert[]

Fare prices.

tariffBasis
​string · enum

Tariff basis.

Enum values:
FLAT
DISTANCE
UNIT_SECTION
ZONE
ZONE_TO_ZONE
POINT_TO_POINT
ROUTE
TOUR
Example: DISTANCE
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

Create a Fare structure element › Responses

Entity created successfully

No data returned

Retrieves the total number of fare structure elements. Limiting selection by fareFrameId or orgId parameter is supported

GET
https://api.entur.io/products
/fare-structure-elements/count

Retrieves the total number of fare structure elements. Limiting selection by fareFrameId or 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 FareStructureElements valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED FareStructureElements are counted. And in the staging environment, PROPOSED FareStructureElements are preferred to VERSIONED ones. Mutually exclusive with statusFilter.

Retrieves the total number of fare structure elements. Limiting selection by fareFrameId or 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 total number of fare structure elements. Limiting selection by fareFrameId or orgId parameter is supported › Responses

Entity updated successfully

Count
Count
numberOfElements
​integer · int32 · required

number of elements

Example: 369

Retrieves fareStructureElements for a given page. Limiting selection by fareFrameId or orgId parameter is supported

GET
https://api.entur.io/products
/fare-structure-elements/pages

Retrieves fareStructureElements for a given page. Limiting selection by fareFrameId or orgId parameter is supported › query Parameters

orgId
​string · style: form · explode: true

The unique id to identify data owned by organisation

fareFrameId
​string · style: form · explode: true

The unique id to identify data owned by organisation

gpaDataSet
​string · style: form · explode: true

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

languageCode
​string · style: form · explode: true

The language code from ISO-639-3

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 FareStructureElements valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED FareStructureElements are returned. And in the staging environment, PROPOSED FareStructureElements are preferred to VERSIONED ones. Mutually exclusive with statusFilter.

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

Returns the info

FareTablePageWrapper
FareStructureElementPageWrapper
​FareStructureElement[] · readOnly · required

Fare structure elements for the given page

requestedPageNumber
​integer · int32 · required

Number of the requested page. In case state is lost

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

Retrives a fare structure element by netexId

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

Retrives a fare structure element by netexId › path Parameters

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

The unique id to identify a fare structure element

Retrives a fare structure element by netexId › 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.

Retrives a fare structure element by netexId › 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 fare structure element by netexId › Responses

Returns the resource

A element describing the response structure of the fare
FareStructureElement
changed
​string · date-time · required

Changed datetime.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

fare table reference

​VersionOfObjectRef[] · required

geographical interval sequence

​VersionOfObjectRef[] · required

geographical structure factor refs

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

Id.

Example: NSB:FareStructureElement:TENInterval
modification
​string · enum · required

Modification status.

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

Name of class.

Example: FareStructureElement
​GenericParameterAssignment[] · required

Access Right Parameter assignments.

​VersionOfObjectRef[] · required

quality structure factor refs

status
​string · enum · required

Status.

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

ValidityConditions sequence.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​TextInLanguage[]

Description.

​LimitingRule

A LimitingRule

​TextInLanguage[]

Name.

organisationId
​string · readOnly

Organisation related to the userProfile

​FarePrice[]

Fare prices.

tariffBasis
​string · enum

Tariff basis.

Enum values:
FLAT
DISTANCE
UNIT_SECTION
ZONE
ZONE_TO_ZONE
POINT_TO_POINT
ROUTE
TOUR
Example: DISTANCE
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

Retrives a fare structure element by id and version

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

Retrives a fare structure element by id and version › path Parameters

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

The unique id to identify a fare structure element

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

The id of the version of the fare structure element

Retrives a fare structure element by id and version › query Parameters

gpaDataSet
​string · style: form · explode: true

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

Retrives a fare structure element 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 fare structure element by id and version › Responses

Returns the resource

A element describing the response structure of the fare
FareStructureElement
changed
​string · date-time · required

Changed datetime.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

fare table reference

​VersionOfObjectRef[] · required

geographical interval sequence

​VersionOfObjectRef[] · required

geographical structure factor refs

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

Id.

Example: NSB:FareStructureElement:TENInterval
modification
​string · enum · required

Modification status.

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

Name of class.

Example: FareStructureElement
​GenericParameterAssignment[] · required

Access Right Parameter assignments.

​VersionOfObjectRef[] · required

quality structure factor refs

status
​string · enum · required

Status.

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

ValidityConditions sequence.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​TextInLanguage[]

Description.

​LimitingRule

A LimitingRule

​TextInLanguage[]

Name.

organisationId
​string · readOnly

Organisation related to the userProfile

​FarePrice[]

Fare prices.

tariffBasis
​string · enum

Tariff basis.

Enum values:
FLAT
DISTANCE
UNIT_SECTION
ZONE
ZONE_TO_ZONE
POINT_TO_POINT
ROUTE
TOUR
Example: DISTANCE
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

Update a fare structure element

PUT
https://api.entur.io/products
/fare-structure-elements/{id}/{version}

Update a fare structure element › path Parameters

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

The unique id to identify a fare structure element

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

The id of the version of the fare structure element

Update a fare structure element › 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 fare structure element › Request Body

FareStructureElementInsert
​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

fare table reference

​VersionOfObjectRef[] · required

geographical interval sequence

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

Id.

Example: NSB:FareStructureElement:TENInterval
​VersionOfObjectRef[] · required

Access Right Parameter assignments.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​TextInLanguage[]

Description.

geographicalStructureFactorId
​string

Geographical structure factor id

Example: NSB:GeographicalStructureFactor:TENPrices
​TextInLanguage[]

Name.

​FarePriceInsert[]

Fare prices.

tariffBasis
​string · enum

Tariff basis.

Enum values:
FLAT
DISTANCE
UNIT_SECTION
ZONE
ZONE_TO_ZONE
POINT_TO_POINT
ROUTE
TOUR
Example: DISTANCE
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

Update a fare structure element › Responses

Entity updated successfully

No data returned
deprecated

Retrieves the distance matrix elements of the fare structure element

GET
https://api.entur.io/products
/fare-structure-elements/{id}/{version}/distance-matrix-elements

No longer in use. DMEs are connected by geographicalStructureFactors

Retrieves the distance matrix elements of the fare structure element › path Parameters

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

The unique id to identify a fare structure element

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

The id of the version of the fare structure element

Retrieves the distance matrix elements of the fare structure element › query Parameters

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

The limited numbers of distance matrix elements returned in the set

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

The offset of distance matrix elements returned in the set

Retrieves the distance matrix elements of the fare structure element › 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 distance matrix elements of the fare structure element › Responses

Returns the resource

A DistanceMatrixElement
DistanceMatrixElement
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: NSB:DistanceMatrixElement:NSR167ToNSR359
nameOfClass
​string · readOnly · required

Name of class.

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

DistanceMatrixElement version.

Example: NSB:Version:V1
​TextInLanguage[]

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

distance
​number · double

Distance.

Example: 16.4
endFareZoneRef
​string

End fare zone reference.

endScheduledStopPointId
​string

End scheduled stop point netexId.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

groupId
​integer · int64

Group id.

Example: 4
​VersionOfObjectRef

Fare frame ref.

inverseAllowed
​boolean

Inverse is allowed.

Example: true
isDirect
​boolean

Is a direct route.

Example: true
​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

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

​FarePrice[]

Fare prices for the user profile.

relativeRanking
​integer · int32

Relative ranking.

Example: 2
startFareZoneRef
​string

Start fare zone reference.

startScheduledStopPointId
​string

Start scheduled stop point netexId.

tariffId
​integer · int64

Tariff id.

​VersionOfObjectRef

Fare frame ref.

​ValidityCondition[]

Validity conditions for the user profile.

Retrieves the geographical intervals of the fare structure element

GET
https://api.entur.io/products
/fare-structure-elements/{id}/{version}/geographical-intervals

Retrieves the geographical intervals of the fare structure element › path Parameters

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

The unique id to identify a fare structure element

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

The id of the version of the fare structure element

Retrieves the geographical intervals of the fare structure element › query Parameters

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

The limited numbers of geographical intervals returned in the set

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

The offset of geographical intervals returned in the set

Retrieves the geographical intervals of the fare structure element › 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 geographical intervals of the fare structure element › Responses

Returns the resource

GeographicalInterval
GeographicalInterval
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: NSB:GeographicalInterval:1364TEN
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

Version.

Example: NSB:Version:V1
compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

endGeographicalValue
​integer · int64

endGeographicalValue.

​VersionOfObjectRef[]

Reference to fare table.

intervalType
​string · enum

intervalType.

Enum values:
STOP
TARIFF_ZONE
DISTANCE
COUPON
OTHER
​LimitingRule

A LimitingRule

modification
​string · enum · readOnly

Modification status.

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

Name of class.

Example: GeographicalInterval
numberOfUnits
​number · double

numberOfUnits.

​FarePrice[]

Prices for the fare.

startGeographicalValue
​integer · int64

startGeographicalValue.

​ValidityCondition[]

validityConditions.

Retrieves a fare structure element by netexId

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

Retrieves a fare structure element by netexId › path Parameters

id
​string · required · style: simple

The unique id to identify a fare structure element

Retrieves a fare structure element by netexId › 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 structure element

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 fare structure elements version

toDate
​string · style: form · explode: true

The to date of the fare structure elements version

Retrieves a fare structure element by netexId › 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 structure element by netexId › Responses

Returns the info

A element describing the response structure of the fare
FareStructureElement
changed
​string · date-time · required

Changed datetime.

created
​string · date-time · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

fare table reference

​VersionOfObjectRef[] · required

geographical interval sequence

​VersionOfObjectRef[] · required

geographical structure factor refs

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

Id.

Example: NSB:FareStructureElement:TENInterval
modification
​string · enum · required

Modification status.

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

Name of class.

Example: FareStructureElement
​GenericParameterAssignment[] · required

Access Right Parameter assignments.

​VersionOfObjectRef[] · required

quality structure factor refs

status
​string · enum · required

Status.

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

ValidityConditions sequence.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​TextInLanguage[]

Description.

​LimitingRule

A LimitingRule

​TextInLanguage[]

Name.

organisationId
​string · readOnly

Organisation related to the userProfile

​FarePrice[]

Fare prices.

tariffBasis
​string · enum

Tariff basis.

Enum values:
FLAT
DISTANCE
UNIT_SECTION
ZONE
ZONE_TO_ZONE
POINT_TO_POINT
ROUTE
TOUR
Example: DISTANCE
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1
fare-structure-element-usagesfare-table-usages
Did you find what you were looking for?