Entur Developer
Products
Products

general-groups-of-entities

Server
Download schema

Retrieves all general groups of entities parameters

GET
https://api.entur.io/products
/general-groups-of-entities

Retrieves all general groups of entities parameters › query Parameters

orgId
​string · style: form · explode: true

The unique id to identify an organisation

fareFrameId
​string · style: form · explode: true

The unique id to identify a dataset to an organisation

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 general groups of entities parameters › 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 general groups of entities parameters › Responses

Returns the info

General Group of Entities.
GeneralGroupOfEntities
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId
​VersionOfObjectRef[] · required

Member refs.

modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class

Example: GeneralGroupOfEntities
nameOfMemberClass
​string · required

Name of member class

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​ValidityCondition[] · readOnly

Validity conditions for the general group of entities.

Create a general group of entities

POST
https://api.entur.io/products
/general-groups-of-entities

Create a general group of entities › 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 general group of entities › Request Body

General Group of Entities.
GeneralGroupOfEntities
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId
​VersionOfObjectRef[] · required

Member refs.

modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class

Example: GeneralGroupOfEntities
nameOfMemberClass
​string · required

Name of member class

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​ValidityCondition[] · readOnly

Validity conditions for the general group of entities.

Create a general group of entities › Responses

Entity created successfully

No data returned

Retrieves the general group of entities valid on a given date

GET
https://api.entur.io/products
/general-groups-of-entities/{id}

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

Retrieves the general group of entities valid on a given date › path Parameters

id
​string · required · style: simple

The id to identify a GeneralGroupOfEntities

Retrieves the general group of entities 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 general group of entities 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 general group of entities valid on a given date › Responses

Returns the info

General Group of Entities.
GeneralGroupOfEntities
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId
​VersionOfObjectRef[] · required

Member refs.

modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class

Example: GeneralGroupOfEntities
nameOfMemberClass
​string · required

Name of member class

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​ValidityCondition[] · readOnly

Validity conditions for the general group of entities.

Retrieves general group of entities given id and version

GET
https://api.entur.io/products
/general-groups-of-entities/{id}/{version}

Retrieves general group of entities given id and version › path Parameters

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

The id to identify a GeneralGroupOfEntities

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

The id for the version of the GeneralGroupOfEntities

Retrieves general group of entities given 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 general group of entities given id and version › Responses

Returns the info

General Group of Entities.
GeneralGroupOfEntities
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId
​VersionOfObjectRef[] · required

Member refs.

modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class

Example: GeneralGroupOfEntities
nameOfMemberClass
​string · required

Name of member class

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​ValidityCondition[] · readOnly

Validity conditions for the general group of entities.

Updates an existing general group of entities

PUT
https://api.entur.io/products
/general-groups-of-entities/{id}/{version}

Updates an existing general group of entities › path Parameters

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

The id to identify a general group of entities

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

The id for the version of the general group of entities

Updates an existing general group of entities › 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 general group of entities › Request Body

General Group of Entities.
GeneralGroupOfEntities
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId
​VersionOfObjectRef[] · required

Member refs.

modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class

Example: GeneralGroupOfEntities
nameOfMemberClass
​string · required

Name of member class

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​ValidityCondition[] · readOnly

Validity conditions for the general group of entities.

Updates an existing general group of entities › Responses

Entity updated successfully

No data returned

Delete a general group of entities given id and version

DELETE
https://api.entur.io/products
/general-groups-of-entities/{id}/{version}

Delete a general group of entities given id and version › path Parameters

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

The id to identify a general group of entities

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

The id for the version of the general group of entities

Delete a general group of entities given 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

Delete a general group of entities given id and version › Responses

The resource was deleted

BoxedUnit
fulfilment-methodsgeneric-parameter-assignments
Did you find what you were looking for?