tariffs

Server

Download schema

Create a tariff

POST

https://api.entur.io/products

/tariffs

Create a tariff › Headers

ET-Client-Name

string

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> for companies, and <personal name>-<application> for individuals.

X-Correlation-Id

string

Correlation id

Create a tariff › Request Body

TariffInsert

id

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

Example: NSB:Tariff:Ordinary

TextInLanguage[] · required

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

version

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

Tariff version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

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

tariffBasis

string · enum

TariffBasis.

Enum values:

NEW

REVISE

DELETE

Example: NEW

derivedFromVersionRef

string

Derived from version.

returnFareTwiceSingle

boolean

returnFareTwiceSingle

Create a tariff › Responses

Entity created successfully

No data returned

POST/tariffs

curl https://api.entur.io/products/tariffs \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "NSB:Tariff:Ordinary",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "tariffBasis": "NEW",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "validBetweenRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "returnFareTwiceSingle": true
}'

Example Request Body

{
  "id": "NSB:Tariff:Ordinary",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "tariffBasis": "NEW",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "validBetweenRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "returnFareTwiceSingle": true
}

json

Example Responses

No example specified for this content type

Retrives a tariff by id

GET

https://api.entur.io/products

/v1/tariffs/{id}

Retrives a tariff by id › path Parameters

id

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

The unique id to identify a tariff

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

fromDate

string · style: form · explode: true

The from date of the tariffs version

toDate

string · style: form · explode: true

The to date of the tariffs version

Retrives a tariff by id › Headers

ET-Client-Name

string

X-Correlation-Id

string

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.

Retrives a tariff by id › Responses

Returns the info

Tariff[]

A tariff

Tariff

id

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

Id.

Example: NSB:Tariff:Ordinary

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

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

Tariffs version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: Tariff

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

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

TextInLanguage[]

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

tariffBasis

string · enum

TariffBasis.

Enum values:

NEW

REVISE

DELETE

Example: NEW

organisationId

string

Organisation related to the userProfile

VersionOfObjectRef

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

returnFareTwiceSingle

boolean

returnFareTwiceSingle

compatibleWithVersionRef

string

Compatible with version.

GET/v1/tariffs/{id}

curl https://api.entur.io/products/v1/tariffs/:id

Example Responses

[
  {
    "id": "NSB:Tariff:Ordinary",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "status": "DRAFT",
    "changed": "2024-08-25T15:00:00Z",
    "created": "2024-08-25T15:00:00Z",
    "version": "NSB:Version:V1",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "Tariff",
    "tariffBasis": "NEW",
    "fareFrameRef": {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    },
    "modification": "NEW",
    "organisationId": "organisationId",
    "validBetweenRef": {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    },
    "derivedFromVersionRef": "derivedFromVersionRef",
    "returnFareTwiceSingle": true,
    "compatibleWithVersionRef": "compatibleWithVersionRef"
  }
]

json

application/json

Retrives a tariff by id

GET

https://api.entur.io/products

/tariffs/{id}/{version}

Retrives a tariff by id › path Parameters

id

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

The unique id to identify a tariff

version

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

The id for the version of the tariff

Retrives a tariff by id › Headers

ET-Client-Name

string

X-Correlation-Id

string

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.

Retrives a tariff by id › Responses

Returns the info

Tariff[]

A tariff

Tariff

id

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

Id.

Example: NSB:Tariff:Ordinary

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

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

Tariffs version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: Tariff

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

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

TextInLanguage[]

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

tariffBasis

string · enum

TariffBasis.

Enum values:

NEW

REVISE

DELETE

Example: NEW

organisationId

string

Organisation related to the userProfile

VersionOfObjectRef

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

returnFareTwiceSingle

boolean

returnFareTwiceSingle

compatibleWithVersionRef

string

Compatible with version.

GET/tariffs/{id}/{version}

curl https://api.entur.io/products/tariffs/:id/:version

Example Responses

[
  {
    "id": "NSB:Tariff:Ordinary",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "status": "DRAFT",
    "changed": "2024-08-25T15:00:00Z",
    "created": "2024-08-25T15:00:00Z",
    "version": "NSB:Version:V1",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "Tariff",
    "tariffBasis": "NEW",
    "fareFrameRef": {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    },
    "modification": "NEW",
    "organisationId": "organisationId",
    "validBetweenRef": {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    },
    "derivedFromVersionRef": "derivedFromVersionRef",
    "returnFareTwiceSingle": true,
    "compatibleWithVersionRef": "compatibleWithVersionRef"
  }
]

json

application/json

supplement-products versions

Build with Entur

Contribute

Terms & Policies

tariffs

Create a tariff

Create a tariff › Headers

Create a tariff › Request Body

Create a tariff › Responses

Retrives a tariff by id

Retrives a tariff by id › path Parameters

Retrives a tariff by id › query Parameters

Retrives a tariff by id › Headers

Retrives a tariff by id › Responses

Retrives a tariff by id

Retrives a tariff by id › path Parameters

Retrives a tariff by id › Headers

Retrives a tariff by id › Responses