Entur Developer
Products
Products

fare-sections

Server
Download schema

Retrieves all fare sections

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

Retrieves all fare sections › query Parameters

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

Retrieves all fare sections › 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 all fare sections › Responses

Returns the info

A Fare section.
FareSection
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:FareSection:TrondheimOslo
modification
​string · enum · readOnly · required

Modification status

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

Name of class

Example: FareSection
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
​TextInLanguage[]

Description

​VersionOfObjectRef

Fare frame ref.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name

​VersionOfObjectRef

Fare frame ref.

Create a fareSection

POST
https://api.entur.io/products
/fare-sections

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

A Fare section.
FareSection
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:FareSection:TrondheimOslo
modification
​string · enum · readOnly · required

Modification status

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

Name of class

Example: FareSection
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
​TextInLanguage[]

Description

​VersionOfObjectRef

Fare frame ref.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name

​VersionOfObjectRef

Fare frame ref.

Create a fareSection › Responses

Entity created successfully

No data returned

Retrieves fare section for id and version

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

Retrieves fare section for id and version › path Parameters

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

The id to identify a FareSection

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

The id for the version of the FareSection

Retrieves fare section for 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 fare section for id and version › Responses

Returns the info

GeographicalStructureFactor
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​DistanceMatrixElement[] · required

Distance matrix elements

​VersionOfObjectRef · required

Fare frame ref.

​GeographicalInterval[] · required

Geographical intervals

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

Id

Example: NSB:GeographicalStructureFactor:50TEN
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the geographical structure factor represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: GeographicalStructureFactor
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
geographicalUnitRef
​string

Geographical unit ref

Updates an existing FareSection

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

Updates an existing FareSection › path Parameters

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

The id to identify a FareSection

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

The id for the version of the FareSection

Updates an existing FareSection › 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

Updates an existing FareSection › Request Body

A Fare section.
FareSection
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:FareSection:TrondheimOslo
modification
​string · enum · readOnly · required

Modification status

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

Name of class

Example: FareSection
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
​TextInLanguage[]

Description

​VersionOfObjectRef

Fare frame ref.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name

​VersionOfObjectRef

Fare frame ref.

Updates an existing FareSection › Responses

Entity updated successfully

No data returned

Deletes a FareSection by id and version

DELETE
https://api.entur.io/products
/fare-sections/{id}/{version}

Deletes a FareSection by id and version › path Parameters

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

The id to identify a FareSection

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

The id for the version of the FareSection

Deletes a FareSection 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

Deletes a FareSection by id and version › Responses

The resource was deleted

BoxedUnit
fare-quota-factorsfare-structure-element-usages
Did you find what you were looking for?