Entur Developer
Products
Products

journey-patterns

Server
Download schema

Retrieves all journey patterns

GET
https://api.entur.io/products
/journey-patterns

Retrieves all journey patterns › query Parameters

orgId
​string · style: form · explode: true
fareFrameId
​string · style: form · explode: true
minimizeDataLoad
​boolean · style: form · explode: true
validOnDate
​string · date-time · style: form · explode: true

Return only the versions valid on the given date (ISO-8601).

Retrieves all journey patterns › 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 journey patterns › Responses

Returns the info

A Journey Pattern
JourneyPattern
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:JourneyPattern: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

​FarePointInPattern[]

Fare points in pattern. Versioned child of JourneyPattern

​TextInLanguage[]

Name

Create a JourneyPattern

POST
https://api.entur.io/products
/journey-patterns

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

A Journey Pattern
JourneyPattern
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:JourneyPattern: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

​FarePointInPattern[]

Fare points in pattern. Versioned child of JourneyPattern

​TextInLanguage[]

Name

Create a JourneyPattern › Responses

Entity created successfully

No data returned

Retrieves the journey pattern valid on a given date

GET
https://api.entur.io/products
/journey-patterns/{id}

Optional validOnDate query parameter (defaults to now). In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.

Retrieves the journey pattern valid on a given date › path Parameters

id
​string · required · style: simple

The id to identify a JourneyPattern

Retrieves the journey pattern valid on a given date › query Parameters

validOnDate
​string · date-time · style: form · explode: true

Return the version valid on the given date (ISO-8601).

Retrieves the journey pattern valid on a given date › 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 journey pattern valid on a given date › Responses

Returns the info

A Journey Pattern
JourneyPattern
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:JourneyPattern: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

​FarePointInPattern[]

Fare points in pattern. Versioned child of JourneyPattern

​TextInLanguage[]

Name

Retrieves journey pattern for id and version

GET
https://api.entur.io/products
/journey-patterns/{id}/{version}

Retrieves journey pattern for id and version › path Parameters

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

The id to identify a JourneyPattern

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

The id for the version of the JourneyPattern

Retrieves journey pattern 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 journey pattern for id and version › Responses

Returns the info

A Journey Pattern
JourneyPattern
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:JourneyPattern: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

​FarePointInPattern[]

Fare points in pattern. Versioned child of JourneyPattern

​TextInLanguage[]

Name

Updates an existing JourneyPattern

PUT
https://api.entur.io/products
/journey-patterns/{id}/{version}

Updates an existing JourneyPattern › path Parameters

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

The id to identify a JourneyPattern

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

The id for the version of the JourneyPattern

Updates an existing JourneyPattern › 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 JourneyPattern › Request Body

A Journey Pattern
JourneyPattern
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:JourneyPattern: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

​FarePointInPattern[]

Fare points in pattern. Versioned child of JourneyPattern

​TextInLanguage[]

Name

Updates an existing JourneyPattern › Responses

Entity updated successfully

No data returned

Deletes a JourneyPattern by id and version

DELETE
https://api.entur.io/products
/journey-patterns/{id}/{version}

Deletes a JourneyPattern by id and version › path Parameters

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

The id to identify a JourneyPattern

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

The id for the version of the JourneyPattern

Deletes a JourneyPattern 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 JourneyPattern by id and version › Responses

The resource was deleted

BoxedUnit
interchangingsluggage-allowances
Did you find what you were looking for?