Entur Developer
Products
Products

validable-elements

Server
Download schema

Retrieves validable elements by id and latest version

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

Retrieves validable elements by id and latest version › path Parameters

id
​string · required · style: simple

The unique id to identify a validable element

Retrieves validable elements by id and latest version › 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 validable 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 validable elements version

toDate
​string · style: form · explode: true

The to date of the validable elements version

Retrieves validable elements by id and latest 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 validable elements by id and latest version › Responses

Returns the info

A ValidationElement
ValidableElement
​GenericParameterAssignment[] · required

The references to access right parameter assignments.

changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare table.

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

Id.

Example: NSB:ValidableElement:Ordinary
modification
​string · enum · required

Modification status.

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

Name of class.

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

Validable element version.

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​AreaValidity

Requirements for area validity.

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

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

​FareStructureElementInSequence[]

The fare structure elements in sequence

​VersionOfObjectRef[]

The reference to the fare divided into a sequence.

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices.

pricingRuleRef
​string

Pricing rule reference.

Example: unused
​ValidityCondition[]

Gives a sequence of conditions for validity.

Retrieves validable elements by organisation id or fareframe

GET
https://api.entur.io/products
/validable-elements

Retrieves validable elements by organisation id or fareframe › 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 a fare frame

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.

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

Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Mutually exclusive with validOnDate.

validOnDate
​string · style: form · explode: true

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

Retrieves validable elements by organisation id or fareframe › 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 validable elements by organisation id or fareframe › Responses

Returns the resources

A ValidationElement
ValidableElement
​GenericParameterAssignment[] · required

The references to access right parameter assignments.

changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare table.

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

Id.

Example: NSB:ValidableElement:Ordinary
modification
​string · enum · required

Modification status.

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

Name of class.

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

Validable element version.

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​AreaValidity

Requirements for area validity.

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

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

​FareStructureElementInSequence[]

The fare structure elements in sequence

​VersionOfObjectRef[]

The reference to the fare divided into a sequence.

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices.

pricingRuleRef
​string

Pricing rule reference.

Example: unused
​ValidityCondition[]

Gives a sequence of conditions for validity.

Create a validable-element

POST
https://api.entur.io/products
/validable-elements

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

ValidableElementInsert
​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:ValidableElement:Child
​TextInLanguage[] · required

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

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

ValidableElement version.

Example: NSB:Version:V1
​VersionOfObjectRef[]

The references to access right parameter assignments.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​AreaValidity

Requirements for area validity.

​FareStructureElementInSequenceInsert[]

Fare structure elements in sequence

​VersionOfObjectRef[]

The reference to the fare divided into a sequence.

​VersionOfObjectRef[]

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

​FarePriceInsert[]

Fare prices.

Create a validable-element › Responses

Entity created successfully

No data returned

Retrieves the number of validable elements. Limit selection by setting the orgId or fareFrameId parameters

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

Retrieves the number of validable elements. Limit selection by setting the orgId or fareFrameId parameters › 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 a fare frame

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

Retrieves the number of validable elements. Limit selection by setting the orgId or fareFrameId parameters › 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 validable elements. Limit selection by setting the orgId or fareFrameId parameters › Responses

Returns the info

integer · int32

Retrieves validable elements by organisation id or fareframe

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

Retrieves validable elements by organisation id or fareframe › query Parameters

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

The number of elements to return

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

The offset to start from

orgId
​string · style: form · explode: true

The unique id to identify a organisation

fareFrameId
​string · style: form · explode: true

The unique id to identify a fare frame

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.

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

Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Mutually exclusive with validOnDate.

validOnDate
​string · style: form · explode: true

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

Retrieves validable elements by organisation id or fareframe › 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 validable elements by organisation id or fareframe › Responses

Returns the resources

Validable Element Page Wrapper
ValidableElementPageWrapper
​ValidableElement[] · readOnly · required

Validable elements for the given page

requestedPageNumber
​integer · int32 · required

Number of the requested page. In case state is lost

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

Retrieves validable elements by id and latest version

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

Retrieves validable elements by id and latest version › path Parameters

id
​string · required · style: simple

The unique id to identify a validable element

Retrieves validable elements by id and latest version › query Parameters

version
​string · style: form · explode: true

The id of the version of the given validable 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.

Retrieves validable elements by id and latest 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.

Retrieves validable elements by id and latest version › Responses

Returns the resource

A ValidationElement
ValidableElement
​GenericParameterAssignment[] · required

The references to access right parameter assignments.

changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare table.

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

Id.

Example: NSB:ValidableElement:Ordinary
modification
​string · enum · required

Modification status.

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

Name of class.

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

Validable element version.

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​AreaValidity

Requirements for area validity.

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

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

​FareStructureElementInSequence[]

The fare structure elements in sequence

​VersionOfObjectRef[]

The reference to the fare divided into a sequence.

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices.

pricingRuleRef
​string

Pricing rule reference.

Example: unused
​ValidityCondition[]

Gives a sequence of conditions for validity.

Retrieves validable elements by id and version

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

Retrieves validable elements by id and version › path Parameters

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

The unique id to identify a validable element

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

The id of the version of the given validable element

Retrieves validable elements by id and version › query Parameters

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 validable elements 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

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 validable elements by id and version › Responses

Returns the resource

A ValidationElement
ValidableElement
​GenericParameterAssignment[] · required

The references to access right parameter assignments.

changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare table.

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

Id.

Example: NSB:ValidableElement:Ordinary
modification
​string · enum · required

Modification status.

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

Name of class.

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

Validable element version.

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​AreaValidity

Requirements for area validity.

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

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

​FareStructureElementInSequence[]

The fare structure elements in sequence

​VersionOfObjectRef[]

The reference to the fare divided into a sequence.

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Fare prices.

pricingRuleRef
​string

Pricing rule reference.

Example: unused
​ValidityCondition[]

Gives a sequence of conditions for validity.

Update a validable element

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

Update a validable element › path Parameters

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

The unique id to identify a validable element

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

The id of the version of the given validable element

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

ValidableElementInsert
​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:ValidableElement:Child
​TextInLanguage[] · required

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

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

ValidableElement version.

Example: NSB:Version:V1
​VersionOfObjectRef[]

The references to access right parameter assignments.

activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
​AreaValidity

Requirements for area validity.

​FareStructureElementInSequenceInsert[]

Fare structure elements in sequence

​VersionOfObjectRef[]

The reference to the fare divided into a sequence.

​VersionOfObjectRef[]

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

​FarePriceInsert[]

Fare prices.

Update a validable element › Responses

Entity updated successfully

No data returned
valid-betweensvalidable-elements-usages
Did you find what you were looking for?