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

Retrieves all general groups of entities parameters › Headers

ET-Client-Name

string

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> for companies, and <personal name>-<application> for individuals.

X-Correlation-Id

string

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

GeneralGroupOfEntities[]

General Group of Entities.

GeneralGroupOfEntities

id

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

VersionOfObjectRef[] · required

Member refs.

version

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion

nameOfClass

string · readOnly · required

Name of class

Example: GeneralGroupOfEntities

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfMemberClass

string · required

Name of member class

TextInLanguage[]

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

TextInLanguage[]

GeneralGroupOfEntities Description 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.

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

GET/general-groups-of-entities

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

Example Responses

[
  {
    "id": "ENT:GeneralGroupOfEntities:SomeId",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "status": "DRAFT",
    "changed": "changed",
    "created": "created",
    "members": [
      {
        "ref": "ref",
        "version": "version",
        "nameOfClass": "nameOfClass"
      }
    ],
    "version": "ENT:Version:SomeVersion",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "GeneralGroupOfEntities",
    "fareFrameRef": {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    },
    "modification": "NEW",
    "organisationId": "organisationId",
    "nameOfMemberClass": "nameOfMemberClass",
    "validityConditions": [
      {
        "id": "NSB:ValidBetween:2018",
        "status": "DRAFT",
        "toDate": "toDate",
        "changed": "changed",
        "created": "created",
        "version": "NSB:Version:V1",
        "fromDate": "fromDate",
        "nameOfClass": "ValidBetween",
        "modification": "NEW"
      }
    ],
    "derivedFromVersionRef": "derivedFromVersionRef",
    "compatibleWithVersionRef": "compatibleWithVersionRef"
  }
]

text

*/*

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

X-Correlation-Id

string

Correlation id

Create a general group of entities › Request Body

General Group of Entities.

GeneralGroupOfEntities

id

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

VersionOfObjectRef[] · required

Member refs.

version

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion

nameOfClass

string · readOnly · required

Name of class

Example: GeneralGroupOfEntities

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfMemberClass

string · required

Name of member class

TextInLanguage[]

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

TextInLanguage[]

GeneralGroupOfEntities Description 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.

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

Create a general group of entities › Responses

Entity created successfully

No data returned

POST/general-groups-of-entities

curl https://api.entur.io/products/general-groups-of-entities \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "ENT:GeneralGroupOfEntities:SomeId",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "status": "DRAFT",
  "changed": "changed",
  "created": "created",
  "members": [
    {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    }
  ],
  "version": "ENT:Version:SomeVersion",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "GeneralGroupOfEntities",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "modification": "NEW",
  "organisationId": "organisationId",
  "nameOfMemberClass": "nameOfMemberClass",
  "validityConditions": [
    {
      "id": "NSB:ValidBetween:2018",
      "status": "DRAFT",
      "toDate": "toDate",
      "changed": "changed",
      "created": "created",
      "version": "NSB:Version:V1",
      "fromDate": "fromDate",
      "nameOfClass": "ValidBetween",
      "modification": "NEW"
    }
  ],
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}'

Example Request Body

{
  "id": "ENT:GeneralGroupOfEntities:SomeId",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "status": "DRAFT",
  "changed": "changed",
  "created": "created",
  "members": [
    {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    }
  ],
  "version": "ENT:Version:SomeVersion",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "GeneralGroupOfEntities",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "modification": "NEW",
  "organisationId": "organisationId",
  "nameOfMemberClass": "nameOfMemberClass",
  "validityConditions": [
    {
      "id": "NSB:ValidBetween:2018",
      "status": "DRAFT",
      "toDate": "toDate",
      "changed": "changed",
      "created": "created",
      "version": "NSB:Version:V1",
      "fromDate": "fromDate",
      "nameOfClass": "ValidBetween",
      "modification": "NEW"
    }
  ],
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}

json

Example Responses

No example specified for this content type

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

X-Correlation-Id

string

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

id

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

VersionOfObjectRef[] · required

Member refs.

version

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion

nameOfClass

string · readOnly · required

Name of class

Example: GeneralGroupOfEntities

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfMemberClass

string · required

Name of member class

TextInLanguage[]

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

TextInLanguage[]

GeneralGroupOfEntities Description 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.

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

GET/general-groups-of-entities/{id}/{version}

curl https://api.entur.io/products/general-groups-of-entities/:id/:version

Example Responses

{
  "id": "ENT:GeneralGroupOfEntities:SomeId",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "status": "DRAFT",
  "changed": "changed",
  "created": "created",
  "members": [
    {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    }
  ],
  "version": "ENT:Version:SomeVersion",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "GeneralGroupOfEntities",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "modification": "NEW",
  "organisationId": "organisationId",
  "nameOfMemberClass": "nameOfMemberClass",
  "validityConditions": [
    {
      "id": "NSB:ValidBetween:2018",
      "status": "DRAFT",
      "toDate": "toDate",
      "changed": "changed",
      "created": "created",
      "version": "NSB:Version:V1",
      "fromDate": "fromDate",
      "nameOfClass": "ValidBetween",
      "modification": "NEW"
    }
  ],
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}

text

*/*

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

X-Correlation-Id

string

Correlation id

Updates an existing general group of entities › Request Body

General Group of Entities.

GeneralGroupOfEntities

id

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

VersionOfObjectRef[] · required

Member refs.

version

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion

nameOfClass

string · readOnly · required

Name of class

Example: GeneralGroupOfEntities

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfMemberClass

string · required

Name of member class

TextInLanguage[]

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

TextInLanguage[]

GeneralGroupOfEntities Description 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.

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

Updates an existing general group of entities › Responses

Entity updated successfully

No data returned

PUT/general-groups-of-entities/{id}/{version}

curl https://api.entur.io/products/general-groups-of-entities/:id/:version \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "ENT:GeneralGroupOfEntities:SomeId",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "status": "DRAFT",
  "changed": "changed",
  "created": "created",
  "members": [
    {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    }
  ],
  "version": "ENT:Version:SomeVersion",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "GeneralGroupOfEntities",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "modification": "NEW",
  "organisationId": "organisationId",
  "nameOfMemberClass": "nameOfMemberClass",
  "validityConditions": [
    {
      "id": "NSB:ValidBetween:2018",
      "status": "DRAFT",
      "toDate": "toDate",
      "changed": "changed",
      "created": "created",
      "version": "NSB:Version:V1",
      "fromDate": "fromDate",
      "nameOfClass": "ValidBetween",
      "modification": "NEW"
    }
  ],
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}'

Example Request Body

{
  "id": "ENT:GeneralGroupOfEntities:SomeId",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "status": "DRAFT",
  "changed": "changed",
  "created": "created",
  "members": [
    {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    }
  ],
  "version": "ENT:Version:SomeVersion",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "GeneralGroupOfEntities",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "modification": "NEW",
  "organisationId": "organisationId",
  "nameOfMemberClass": "nameOfMemberClass",
  "validityConditions": [
    {
      "id": "NSB:ValidBetween:2018",
      "status": "DRAFT",
      "toDate": "toDate",
      "changed": "changed",
      "created": "created",
      "version": "NSB:Version:V1",
      "fromDate": "fromDate",
      "nameOfClass": "ValidBetween",
      "modification": "NEW"
    }
  ],
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}

json

Example Responses

No example specified for this content type

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

X-Correlation-Id

string

Correlation id

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

The resource was deleted

BoxedUnit

product-tree-explanations type-of-responsibility-role

Build with Entur

Contribute

Terms & Policies

general-groups-of-entities

Retrieves all general groups of entities parameters

Retrieves all general groups of entities parameters › query Parameters

Retrieves all general groups of entities parameters › Headers

Retrieves all general groups of entities parameters › Responses

Create a general group of entities

Create a general group of entities › Headers

Create a general group of entities › Request Body

Create a general group of entities › Responses

Retrieves general group of entities given id and version

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

Retrieves general group of entities given id and version › Headers

Retrieves general group of entities given id and version › Responses

Updates an existing general group of entities

Updates an existing general group of entities › path Parameters

Updates an existing general group of entities › Headers

Updates an existing general group of entities › Request Body

Updates an existing general group of entities › Responses

Delete a general group of entities given id and version

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

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

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