Version management endpoints
Create a new version
Create a new version in DRAFT status. The version will be assigned the current date as startDate if not provided.
Headers
ET-Client-NameEntur 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-IdCorrelation id
Create a new version › Request Body
statusMust be DRAFT for new versions.
startDateThe start date of the version. Defaults to current date if not provided.
endDateThe end date of the version (optional).
ownerOrganisationIdThe ID of the organisation that owns the version. The service will fetch the owner organisation from auth token if no organizsation i set here.
Create a new version › Responses
Version created successfully
id^([A-Z]{3}):Version:… · requiredThe netex id reference to the object.
statuschangedChanged datetime
createdCreated datetime
startDateThe start date of the version.
numberVersion number of the version. Only present when versionStatus is VERSIONED. Starts at 1 for a new product and is incremented by 1 for each new version.
endDateThe end date of the version.
publishedTimestamp for when the version was published (set to status VERSIONED).
Get a version by ID
Retrieve a specific version by its netex ID.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe netex ID of the element to retrieve
Headers
ET-Client-NameEntur 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-IdCorrelation id
Get a version by ID › Responses
Version found successfully
id^([A-Z]{3}):Version:… · requiredThe netex id reference to the object.
statuschangedChanged datetime
createdCreated datetime
startDateThe start date of the version.
numberVersion number of the version. Only present when versionStatus is VERSIONED. Starts at 1 for a new product and is incremented by 1 for each new version.
endDateThe end date of the version.
publishedTimestamp for when the version was published (set to status VERSIONED).
Update an existing version
Update an existing version. Can be used to change status (e.g., from DRAFT to PROPOSED or PROPOSED to VERSIONED) or modify dates.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe netex ID of the element to retrieve
Headers
ET-Client-NameEntur 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-IdCorrelation id
Update an existing version › Request Body
statusMust be DRAFT for new versions.
startDateThe start date of the version. Defaults to current date if not provided.
endDateThe end date of the version (optional).
ownerOrganisationIdThe ID of the organisation that owns the version. The service will fetch the owner organisation from auth token if no organizsation i set here.
Update an existing version › Responses
Version updated successfully
id^([A-Z]{3}):Version:… · requiredThe netex id reference to the object.
statuschangedChanged datetime
createdCreated datetime
startDateThe start date of the version.
numberVersion number of the version. Only present when versionStatus is VERSIONED. Starts at 1 for a new product and is incremented by 1 for each new version.
endDateThe end date of the version.
publishedTimestamp for when the version was published (set to status VERSIONED).
Get version history for a versionable element by ID
Retrieve the list for all version that is related to the given versionable element.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe netex ID of the element to retrieve
Headers
ET-Client-NameEntur 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-IdCorrelation id
Get version history for a versionable element by ID › Responses
Version history found successfully
id^([A-Z]{3}):Version:… · requiredThe netex id reference to the object.
statuschangedChanged datetime
createdCreated datetime
startDateThe start date of the version.
numberVersion number of the version. Only present when versionStatus is VERSIONED. Starts at 1 for a new product and is incremented by 1 for each new version.
endDateThe end date of the version.
publishedTimestamp for when the version was published (set to status VERSIONED).