group-of-distance-matrix-elements

Server

Download schema

Retrieves all groups of distance matrix elements

GET

https://api.entur.io/products

/group-of-distance-matrix-elements

Retrieves all groups of distance matrix elements › query Parameters

orgId

string · style: form · explode: true

The unique id to identify a organisation

fareFrameId

string · style: form · explode: true

The unique id to identify dataset to an organization

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Retrieves all groups of distance matrix elements › 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 groups of distance matrix elements › Responses

Returns the info

A GroupfOfDistanceMatrixElemenets

GroupOfDistanceMatrixElements

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:GroupOfDistanceMatrixElements:TENDistances

membersId

string · required

DistanceMatrixElements within the group.

nameOfClass

string · required

Name of class.

Example: GroupOfDistanceMatrixElements

version

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

GroupOfDistanceMatrixElements version.

Example: NSB:Version:V1

TextInLanguage[]

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

fareFrameId

integer · int64

Fare frame id.

TextInLanguage[]

GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.

tariffId

integer · int64

Tariff id.

ValidityCondition[]

Validity conditions for the user profile.

GET/group-of-distance-matrix-elements

curl https://api.entur.io/products/group-of-distance-matrix-elements

Example Responses

{
  "changed": "2024-08-25T15:00:00Z",
  "created": "2024-08-25T15:00:00Z",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameId": 0,
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:GroupOfDistanceMatrixElements:TENDistances",
  "membersId": "membersId",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "GroupOfDistanceMatrixElements",
  "tariffId": 0,
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "version": "NSB:Version:V1"
}

text

*/*

Create a GroupOfDistanceElement

POST

https://api.entur.io/products

/group-of-distance-matrix-elements

Create a GroupOfDistanceElement › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Create a GroupOfDistanceElement › Request Body

A GroupDistanceMatrixElement create request

GroupOfDistanceMatrixElementsInsert

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:GroupOfDistanceMatrixElements:TENDistances

members

string[] · required

DistanceMatrixElements within the group.

version

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

GroupOfDistanceMatrixElements version.

Example: NSB:Version:V1

TextInLanguage[]

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

fareFrameId

integer · int64

Fare frame id.

TextInLanguage[]

GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.

tariffId

integer · int64

Tariff id.

ValidityCondition[]

Validity conditions for the user profile.

Create a GroupOfDistanceElement › Responses

Entity created successfully

No data returned

POST/group-of-distance-matrix-elements

curl https://api.entur.io/products/group-of-distance-matrix-elements \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameId": 0,
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:GroupOfDistanceMatrixElements:TENDistances",
  "members": [
    "string"
  ],
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "tariffId": 0,
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameId": 0,
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:GroupOfDistanceMatrixElements:TENDistances",
  "members": [
    "string"
  ],
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "tariffId": 0,
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

Retrieves a GroupOfDistanceMatrixElementsEntity by id and version

GET

https://api.entur.io/products

/group-of-distance-matrix-elements/{id}/{version}

Retrieves a GroupOfDistanceMatrixElementsEntity by id and version › path Parameters

id

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

The unique id to identify a GroupOfDistanceMatrixElements

version

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

The id for the version of the GroupOfDistanceMatrixElements

Retrieves a GroupOfDistanceMatrixElementsEntity by id and version › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · style: simple

The language code from ISO-639-3

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 a GroupOfDistanceMatrixElementsEntity by id and version › Responses

Returns the info

A GroupfOfDistanceMatrixElemenets

GroupOfDistanceMatrixElements

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:GroupOfDistanceMatrixElements:TENDistances

membersId

string · required

DistanceMatrixElements within the group.

nameOfClass

string · required

Name of class.

Example: GroupOfDistanceMatrixElements

version

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

GroupOfDistanceMatrixElements version.

Example: NSB:Version:V1

TextInLanguage[]

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

fareFrameId

integer · int64

Fare frame id.

TextInLanguage[]

GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.

tariffId

integer · int64

Tariff id.

ValidityCondition[]

Validity conditions for the user profile.

GET/group-of-distance-matrix-elements/{id}/{version}

curl https://api.entur.io/products/group-of-distance-matrix-elements/:id/:version

Example Responses

{
  "changed": "2024-08-25T15:00:00Z",
  "created": "2024-08-25T15:00:00Z",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameId": 0,
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:GroupOfDistanceMatrixElements:TENDistances",
  "membersId": "membersId",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "GroupOfDistanceMatrixElements",
  "tariffId": 0,
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "version": "NSB:Version:V1"
}

text

*/*

geographical-structure-factors-usages group-tickets

Did you find what you were looking for?

group-of-distance-matrix-elements

Retrieves all groups of distance matrix elements

Retrieves all groups of distance matrix elements › query Parameters

Retrieves all groups of distance matrix elements › Headers

Retrieves all groups of distance matrix elements › Responses

Create a GroupOfDistanceElement

Create a GroupOfDistanceElement › Headers

Create a GroupOfDistanceElement › Request Body

Create a GroupOfDistanceElement › Responses

Retrieves a GroupOfDistanceMatrixElementsEntity by id and version

Retrieves a GroupOfDistanceMatrixElementsEntity by id and version › path Parameters

Retrieves a GroupOfDistanceMatrixElementsEntity by id and version › Headers

Retrieves a GroupOfDistanceMatrixElementsEntity by id and version › Responses

Build with Entur

Contribute

Terms & Policies