interchangings

Server

Download schema

Retrieves all interchangings for a given fare frame

GET

https://api.entur.io/products

/interchangings

Retrieves all interchangings for a given fare frame › 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

Retrieves all interchangings for a given fare frame › 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 interchangings for a given fare frame › Responses

Returns the info

Interchanging[]

Interchanging

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Interchanging:Trondelag

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: Interchanging

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

Version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

Description.

fromMode

string · enum

Vehicle fromMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

maximumNumberOfChanges

integer · int32

MaximumNumberOfChanges.

maximumTimeToMakeATransfer

string

MaximumTimeToMakeATransfer

TextInLanguage[]

Name.

toMode

string · enum

Vehicle toMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

VersionOfObjectRef

Fare frame ref.

GET/interchangings

curl https://api.entur.io/products/interchangings

Example Responses

[
  {
    "changed": "2024-08-25T15:00:00Z",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "2024-08-25T15:00:00Z",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "fromMode": "AIR",
    "id": "NSB:Interchanging:Trondelag",
    "maximumNumberOfChanges": 0,
    "maximumTimeToMakeATransfer": "maximumTimeToMakeATransfer",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "Interchanging",
    "status": "DRAFT",
    "toMode": "AIR",
    "typeOfUsageParameterRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "version": "NSB:Version:V1"
  }
]

json

application/json

Create an interchanging

POST

https://api.entur.io/products

/interchangings

Create an interchanging › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Create an interchanging › Request Body

InterchangingInsert

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Interchanging:Trondelag

TextInLanguage[] · required

Name.

TextInLanguage[]

Description.

fromMode

string · enum

Vehicle fromMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

maximumNumberOfChanges

integer · int32

MaximumNumberOfChanges.

maximumTimeToMakeATransfer

string

MaximumTimeToMakeATransfer

toMode

string · enum

Vehicle toMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

VersionOfObjectRef

Fare frame ref.

version

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

Version.

Example: NSB:Version:V1

Create an interchanging › Responses

Returns the info

BoxedUnit

POST/interchangings

curl https://api.entur.io/products/interchangings \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fromMode": "AIR",
  "id": "NSB:Interchanging:Trondelag",
  "maximumNumberOfChanges": 0,
  "maximumTimeToMakeATransfer": "maximumTimeToMakeATransfer",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "toMode": "AIR",
  "typeOfUsageParameterRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fromMode": "AIR",
  "id": "NSB:Interchanging:Trondelag",
  "maximumNumberOfChanges": 0,
  "maximumTimeToMakeATransfer": "maximumTimeToMakeATransfer",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "toMode": "AIR",
  "typeOfUsageParameterRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "version": "NSB:Version:V1"
}

json

Example Responses

{}

json

application/json

Retrieves an interchanging by id and version

GET

https://api.entur.io/products

/interchangings/{id}/{version}

Retrieves an interchanging by id and version › path Parameters

id

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

The unique id to identify a interchanging

version

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

The id for the version of the interchanging

Retrieves an interchanging by id and version › Headers

ET-Client-Name

string · style: simple

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 an interchanging by id and version › Responses

Returns the interchanging

Interchanging

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Interchanging:Trondelag

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: Interchanging

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

Version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

Description.

fromMode

string · enum

Vehicle fromMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

maximumNumberOfChanges

integer · int32

MaximumNumberOfChanges.

maximumTimeToMakeATransfer

string

MaximumTimeToMakeATransfer

TextInLanguage[]

Name.

toMode

string · enum

Vehicle toMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

VersionOfObjectRef

Fare frame ref.

GET/interchangings/{id}/{version}

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

Example Responses

{
  "changed": "2024-08-25T15:00:00Z",
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "created": "2024-08-25T15:00:00Z",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fromMode": "AIR",
  "id": "NSB:Interchanging:Trondelag",
  "maximumNumberOfChanges": 0,
  "maximumTimeToMakeATransfer": "maximumTimeToMakeATransfer",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "Interchanging",
  "status": "DRAFT",
  "toMode": "AIR",
  "typeOfUsageParameterRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "version": "NSB:Version:V1"
}

json

application/json

Update an interchanging

PUT

https://api.entur.io/products

/interchangings/{id}/{version}

Update an interchanging › path Parameters

id

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

The unique id to identify a interchanging

version

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

The id for the version of the interchanging

Update an interchanging › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Update an interchanging › Request Body

InterchangingInsert

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Interchanging:Trondelag

TextInLanguage[] · required

Name.

TextInLanguage[]

Description.

fromMode

string · enum

Vehicle fromMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

maximumNumberOfChanges

integer · int32

MaximumNumberOfChanges.

maximumTimeToMakeATransfer

string

MaximumTimeToMakeATransfer

toMode

string · enum

Vehicle toMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

VersionOfObjectRef

Fare frame ref.

version

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

Version.

Example: NSB:Version:V1

Update an interchanging › Responses

Entity updated successfully

No data returned

PUT/interchangings/{id}/{version}

curl https://api.entur.io/products/interchangings/:id/:version \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fromMode": "AIR",
  "id": "NSB:Interchanging:Trondelag",
  "maximumNumberOfChanges": 0,
  "maximumTimeToMakeATransfer": "maximumTimeToMakeATransfer",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "toMode": "AIR",
  "typeOfUsageParameterRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fromMode": "AIR",
  "id": "NSB:Interchanging:Trondelag",
  "maximumNumberOfChanges": 0,
  "maximumTimeToMakeATransfer": "maximumTimeToMakeATransfer",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "toMode": "AIR",
  "typeOfUsageParameterRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

Retrieves an interchanging by id

GET

https://api.entur.io/products

/v1/interchangings/{id}

Retrieves an interchanging by id › path Parameters

id

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

The unique id to identify a group ticket

Retrieves an interchanging 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 interchaning

fromDate

string · style: form · explode: true

The from date of the interchaning version

toDate

string · style: form · explode: true

The to date of the interchaning version

Retrieves an interchanging by id › Headers

ET-Client-Name

string · style: simple

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 an interchanging by id › Responses

Returns interchaning

Interchanging[]

Interchanging

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Interchanging:Trondelag

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: Interchanging

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

Version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

Description.

fromMode

string · enum

Vehicle fromMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

maximumNumberOfChanges

integer · int32

MaximumNumberOfChanges.

maximumTimeToMakeATransfer

string

MaximumTimeToMakeATransfer

TextInLanguage[]

Name.

toMode

string · enum

Vehicle toMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

VersionOfObjectRef

Fare frame ref.

GET/v1/interchangings/{id}

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

Example Responses

[
  {
    "changed": "2024-08-25T15:00:00Z",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "2024-08-25T15:00:00Z",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "fromMode": "AIR",
    "id": "NSB:Interchanging:Trondelag",
    "maximumNumberOfChanges": 0,
    "maximumTimeToMakeATransfer": "maximumTimeToMakeATransfer",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "Interchanging",
    "status": "DRAFT",
    "toMode": "AIR",
    "typeOfUsageParameterRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "version": "NSB:Version:V1"
  }
]

json

application/json

group-tickets journey-patterns

Did you find what you were looking for?

interchangings

Retrieves all interchangings for a given fare frame

Retrieves all interchangings for a given fare frame › query Parameters

Retrieves all interchangings for a given fare frame › Headers

Retrieves all interchangings for a given fare frame › Responses

Create an interchanging

Create an interchanging › Headers

Create an interchanging › Request Body

Create an interchanging › Responses

Retrieves an interchanging by id and version

Retrieves an interchanging by id and version › path Parameters

Retrieves an interchanging by id and version › Headers

Retrieves an interchanging by id and version › Responses

Update an interchanging

Update an interchanging › path Parameters

Update an interchanging › Headers

Update an interchanging › Request Body

Update an interchanging › Responses

Retrieves an interchanging by id

Retrieves an interchanging by id › path Parameters

Retrieves an interchanging by id › query Parameters

Retrieves an interchanging by id › Headers

Retrieves an interchanging by id › Responses

Build with Entur

Contribute

Terms & Policies