versions

Server

Download schema

Create version

POST

https://api.entur.io/products

/versions

Create 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

Create version › Request Body

A case class for versioning.

Version

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: RUT:Version:RuterSingleTicket

modification

string · enum · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: Version

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

Default: DRAFT

versionType

string · enum · required

VersionType.

Enum values:

BASELINE

POINT

description

string

Description.

endDate

string · date-time

EndDate

startDate

string · date-time

StartDate

Create version › Responses

Entity created successfully

No data returned

POST/versions

curl https://api.entur.io/products/versions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "changed": "changed",
  "created": "created",
  "description": "description",
  "endDate": "2024-08-25T15:00:00Z",
  "id": "RUT:Version:RuterSingleTicket",
  "modification": "NEW",
  "nameOfClass": "Version",
  "startDate": "2024-08-25T15:00:00Z",
  "status": "DRAFT",
  "versionType": "BASELINE"
}'

Example Request Body

{
  "changed": "changed",
  "created": "created",
  "description": "description",
  "endDate": "2024-08-25T15:00:00Z",
  "id": "RUT:Version:RuterSingleTicket",
  "modification": "NEW",
  "nameOfClass": "Version",
  "startDate": "2024-08-25T15:00:00Z",
  "status": "DRAFT",
  "versionType": "BASELINE"
}

json

Example Responses

No example specified for this content type

Get all versions

POST

https://api.entur.io/products

/versions/batch

Get all versions › query Parameters

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Get all versions › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get all versions › Request Body

A case class for versioning.

VersionBatchRetrieve

entityIds

string[] · required

entityIds

Example: ["ENT:PreassignedFareProduct:abc123","ENT:PreassignedFareProduct:123abc"]

Get all versions › Responses

Returns the info

Version[]

A case class for versioning.

Version

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: RUT:Version:RuterSingleTicket

modification

string · enum · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: Version

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

Default: DRAFT

versionType

string · enum · required

VersionType.

Enum values:

BASELINE

POINT

description

string

Description.

endDate

string · date-time

EndDate

startDate

string · date-time

StartDate

POST/versions/batch

curl https://api.entur.io/products/versions/batch \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "entityIds": [
    "ENT:PreassignedFareProduct:abc123",
    "ENT:PreassignedFareProduct:123abc"
  ]
}'

Example Request Body

{
  "entityIds": [
    "ENT:PreassignedFareProduct:abc123",
    "ENT:PreassignedFareProduct:123abc"
  ]
}

json

Example Responses

[
  {
    "changed": "changed",
    "created": "created",
    "description": "description",
    "endDate": "2024-08-25T15:00:00Z",
    "id": "RUT:Version:RuterSingleTicket",
    "modification": "NEW",
    "nameOfClass": "Version",
    "startDate": "2024-08-25T15:00:00Z",
    "status": "DRAFT",
    "versionType": "BASELINE"
  }
]

json

application/json

Retrieves metadata of specific element type by class name

GET

https://api.entur.io/products

/versions/element-type/{nameOfClass}

Retrieves metadata of specific element type by class name › path Parameters

nameOfClass

string · required · style: simple

The unique class name to identify for an elementType

Retrieves metadata of specific element type by class name › query Parameters

fareFrameId

string · style: form · explode: true

The unique id to identify a dataset to an organisation

statusFilter

string[] · style: form · explode: true

Filter by version status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.

Retrieves metadata of specific element type by class name › Headers

ET-Client-Name

string · style: simple

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 metadata of specific element type by class name › Responses

Returns the info

MininmalVersionInfo[]

MininmalVersionInfo

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

string · readOnly · required

Id.

Example: NSB:ElementTypeMetadata:Test

nameOfClass

string · readOnly · required

Name of class.

Example: ElementTypeMetadata

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · readOnly · required

Version

Example: NSB:Version:V1

endDate

string · date-time · readOnly

EndDate

TextInLanguage[] · readOnly

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

startDate

string · date-time · readOnly

StartDate

Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter

GET

https://api.entur.io/products

/versions/product-element-type/{nameOfClass}

Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter › path Parameters

nameOfClass

string · required · style: simple

The unique class name to identify for a fare product element type

Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter › query Parameters

fareFrameId

string · style: form · explode: true

The unique id to identify a dataset to an organisation

excludeTypeOfFareProductId

string · style: form · explode: true

A typeOfFareProduct netex ID whose products should be excluded from the result (e.g. ENT:TypeOfFareProduct:PersonalisationProgram). NOTE: Far from all products has this datatype set

statusFilter

string[] · style: form · explode: true

Filter by version status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.

Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter › Headers

ET-Client-Name

string · style: simple

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 product metadata by class name, with optional typeOfFareProduct exclusion filter › Responses

Returns the info

MininmalVersionInfo[]

MininmalVersionInfo

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

string · readOnly · required

Id.

Example: NSB:ElementTypeMetadata:Test

nameOfClass

string · readOnly · required

Name of class.

Example: ElementTypeMetadata

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · readOnly · required

Version

Example: NSB:Version:V1

endDate

string · date-time · readOnly

EndDate

TextInLanguage[] · readOnly

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

startDate

string · date-time · readOnly

StartDate

Get version for netexid

GET

https://api.entur.io/products

/versions/{id}

Get version for netexid › path Parameters

id

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

The netex id to identify a version entry

Get version for netexid › query Parameters

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Get version for netexid › Headers

ET-Client-Name

string · style: simple

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.

Get version for netexid › Responses

Returns the info

A case class for versioning.

Version

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: RUT:Version:RuterSingleTicket

modification

string · enum · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: Version

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

Default: DRAFT

versionType

string · enum · required

VersionType.

Enum values:

BASELINE

POINT

description

string

Description.

endDate

string · date-time

EndDate

startDate

string · date-time

StartDate

Set the status of a product version by id

PUT

https://api.entur.io/products

/versions/{id}

Set the status of a product version by id › path Parameters

id

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

The unique id to identify a version of a product

Set the status of a product version by id › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Set the status of a product version by id › Request Body

A case class for versioning.

Version

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: RUT:Version:RuterSingleTicket

modification

string · enum · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: Version

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

Default: DRAFT

versionType

string · enum · required

VersionType.

Enum values:

BASELINE

POINT

description

string

Description.

endDate

string · date-time

EndDate

startDate

string · date-time

StartDate

Set the status of a product version by id › Responses

Entity updated successfully

No data returned

PUT/versions/{id}

curl https://api.entur.io/products/versions/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "changed": "changed",
  "created": "created",
  "description": "description",
  "endDate": "2024-08-25T15:00:00Z",
  "id": "RUT:Version:RuterSingleTicket",
  "modification": "NEW",
  "nameOfClass": "Version",
  "startDate": "2024-08-25T15:00:00Z",
  "status": "DRAFT",
  "versionType": "BASELINE"
}'

Example Request Body

{
  "changed": "changed",
  "created": "created",
  "description": "description",
  "endDate": "2024-08-25T15:00:00Z",
  "id": "RUT:Version:RuterSingleTicket",
  "modification": "NEW",
  "nameOfClass": "Version",
  "startDate": "2024-08-25T15:00:00Z",
  "status": "DRAFT",
  "versionType": "BASELINE"
}

json

Example Responses

No example specified for this content type

vat-register

Did you find what you were looking for?

versions

Create version

Create version › Headers

Create version › Request Body

Create version › Responses

Get all versions

Get all versions › query Parameters

Get all versions › Headers

Get all versions › Request Body

Get all versions › Responses

Retrieves metadata of specific element type by class name

Retrieves metadata of specific element type by class name › path Parameters

Retrieves metadata of specific element type by class name › query Parameters

Retrieves metadata of specific element type by class name › Headers

Retrieves metadata of specific element type by class name › Responses

Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter

Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter › path Parameters

Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter › query Parameters

Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter › Headers

Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter › Responses

Get version for netexid

Get version for netexid › path Parameters

Get version for netexid › query Parameters

Get version for netexid › Headers

Get version for netexid › Responses

Set the status of a product version by id

Set the status of a product version by id › path Parameters

Set the status of a product version by id › Headers

Set the status of a product version by id › Request Body

Set the status of a product version by id › Responses

Build with Entur

Contribute

Terms & Policies