Retrieves all general groups of entities parameters
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
minimizeDataLoadHeaders
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>.
X-Correlation-IdCorrelation id
If-None-MatchUsed 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 general groups of entities parameters › Responses
Returns the info
changedChanged datetime
createdCreated datetime
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Member refs.
modificationModification status
nameOfClassName of class
nameOfMemberClassName of member class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredGeneralGroupOfEntities version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.
GeneralGroupOfEntities Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Validity conditions for the general group of entities.
Create a general group of entities
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>.
X-Correlation-IdCorrelation id
Create a general group of entities › Request Body
changedChanged datetime
createdCreated datetime
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Member refs.
modificationModification status
nameOfClassName of class
nameOfMemberClassName of member class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredGeneralGroupOfEntities version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.
GeneralGroupOfEntities Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Validity conditions for the general group of entities.
Create a general group of entities › Responses
Entity created successfully
Retrieves general group of entities given id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a GeneralGroupOfEntities
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the GeneralGroupOfEntities
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>.
X-Correlation-IdCorrelation id
If-None-MatchUsed 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 general group of entities given id and version › Responses
Returns the info
changedChanged datetime
createdCreated datetime
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Member refs.
modificationModification status
nameOfClassName of class
nameOfMemberClassName of member class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredGeneralGroupOfEntities version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.
GeneralGroupOfEntities Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Validity conditions for the general group of entities.
Updates an existing general group of entities
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a general group of entities
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the general group of entities
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>.
X-Correlation-IdCorrelation id
Updates an existing general group of entities › Request Body
changedChanged datetime
createdCreated datetime
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Member refs.
modificationModification status
nameOfClassName of class
nameOfMemberClassName of member class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredGeneralGroupOfEntities version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.
GeneralGroupOfEntities Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Validity conditions for the general group of entities.
Updates an existing general group of entities › Responses
Entity updated successfully
Delete a general group of entities given id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a general group of entities
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the general group of entities
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>.
X-Correlation-IdCorrelation id
Delete a general group of entities given id and version › Responses
The resource was deleted