Entur Developer
Products
Products

distance-matrix-elements

Server
Download schema

Retrieves distance matrix elements and filter by query params

GET
https://api.entur.io/products
/distance-matrix-elements

Retrieves distance matrix elements and filter by query params › query Parameters

fareFrameId
​string · style: form · explode: true

The unique id to identify dataset to an organization

groupId
​string · style: form · explode: true

The netexId to identify group the distance matrix elements belong to

groupVersion
​string · style: form · explode: true

The version of the group the distance matrix elements belong to

page
​integer · int32 · style: form · explode: true

The page of the pagination

pageSize
​integer · int32 · style: form · explode: true

The size of the page

Retrieves distance matrix elements and filter by query params › 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 distance matrix elements and filter by query params › Responses

Returns the info

A DistanceMatrixElement
DistanceMatrixElement
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: NSB:DistanceMatrixElement:NSR167ToNSR359
nameOfClass
​string · readOnly · required

Name of class.

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

DistanceMatrixElement version.

Example: NSB:Version:V1
​TextInLanguage[]

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

distance
​number · double

Distance.

Example: 16.4
endFareZoneRef
​string

End fare zone reference.

endScheduledStopPointId
​string

End scheduled stop point netexId.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

groupId
​integer · int64

Group id.

Example: 4
​VersionOfObjectRef

Fare frame ref.

inverseAllowed
​boolean

Inverse is allowed.

Example: true
isDirect
​boolean

Is a direct route.

Example: true
​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

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

​FarePrice[]

Fare prices for the user profile.

relativeRanking
​integer · int32

Relative ranking.

Example: 2
startFareZoneRef
​string

Start fare zone reference.

startScheduledStopPointId
​string

Start scheduled stop point netexId.

tariffId
​integer · int64

Tariff id.

​VersionOfObjectRef

Fare frame ref.

​ValidityCondition[]

Validity conditions for the user profile.

Create a DistanceElement

POST
https://api.entur.io/products
/distance-matrix-elements

Create a DistanceElement › 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 DistanceElement › Request Body

A DistanceMatrixElement create request
DistanceMatrixElementInsert
​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: NSB:DistanceMatrixElement:NSR167ToNSR359
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

DistanceMatrixElement version.

Example: NSB:Version:V1
​TextInLanguage[]

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

distance
​number · double

Distance.

Example: 16.4
endFareZoneRef
​string

End fare zone reference.

endScheduledStopPointId
​string

End scheduled stop point netexId.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

​VersionOfObjectRef

Fare frame ref.

inverseAllowed
​boolean

Inverse is allowed.

Example: true
isDirect
​boolean

Is a direct route.

Example: true
​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

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

​FarePriceInsert[]

Fare prices for the user profile.

relativeRanking
​integer · int32

Relative ranking.

Example: 2
startFareZoneRef
​string

Start fare zone reference.

startScheduledStopPointId
​string

Start scheduled stop point netexId.

​VersionOfObjectRef

Fare frame ref.

​ValidityCondition[]

Validity conditions for the user profile.

Create a DistanceElement › Responses

Entity created successfully

No data returned

Update batch of distance matrix elements

PUT
https://api.entur.io/products
/distance-matrix-elements/batch/{version}

Update batch of distance matrix elements › path Parameters

version
​string · required · style: simple

version

Update batch 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

Update batch of distance matrix elements › Request Body

A DistanceMatrixElement create request
DistanceMatrixElementInsert
​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: NSB:DistanceMatrixElement:NSR167ToNSR359
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

DistanceMatrixElement version.

Example: NSB:Version:V1
​TextInLanguage[]

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

distance
​number · double

Distance.

Example: 16.4
endFareZoneRef
​string

End fare zone reference.

endScheduledStopPointId
​string

End scheduled stop point netexId.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

​VersionOfObjectRef

Fare frame ref.

inverseAllowed
​boolean

Inverse is allowed.

Example: true
isDirect
​boolean

Is a direct route.

Example: true
​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

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

​FarePriceInsert[]

Fare prices for the user profile.

relativeRanking
​integer · int32

Relative ranking.

Example: 2
startFareZoneRef
​string

Start fare zone reference.

startScheduledStopPointId
​string

Start scheduled stop point netexId.

​VersionOfObjectRef

Fare frame ref.

​ValidityCondition[]

Validity conditions for the user profile.

Update batch of distance matrix elements › Responses

Entity updated successfully

No data returned

Retrieves a distance-matrix-elements by id and version

GET
https://api.entur.io/products
/distance-matrix-elements/{id}/{version}

Retrieves a distance-matrix-elements by id and version › path Parameters

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

The unique id to identify a charging moment

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

version

Retrieves a distance-matrix-elements by 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

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 distance-matrix-elements by id and version › Responses

Returns the info

A DistanceMatrixElement
DistanceMatrixElement
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: NSB:DistanceMatrixElement:NSR167ToNSR359
nameOfClass
​string · readOnly · required

Name of class.

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

DistanceMatrixElement version.

Example: NSB:Version:V1
​TextInLanguage[]

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

distance
​number · double

Distance.

Example: 16.4
endFareZoneRef
​string

End fare zone reference.

endScheduledStopPointId
​string

End scheduled stop point netexId.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

groupId
​integer · int64

Group id.

Example: 4
​VersionOfObjectRef

Fare frame ref.

inverseAllowed
​boolean

Inverse is allowed.

Example: true
isDirect
​boolean

Is a direct route.

Example: true
​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

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

​FarePrice[]

Fare prices for the user profile.

relativeRanking
​integer · int32

Relative ranking.

Example: 2
startFareZoneRef
​string

Start fare zone reference.

startScheduledStopPointId
​string

Start scheduled stop point netexId.

tariffId
​integer · int64

Tariff id.

​VersionOfObjectRef

Fare frame ref.

​ValidityCondition[]

Validity conditions for the user profile.

Retrives a distance matrix elment by id

GET
https://api.entur.io/products
/v1/distance-matrix-elements/{id}

Retrives a distance matrix elment by id › path Parameters

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

The unique id to identify a distance matrix elment

Retrives a distance matrix elment by id › query Parameters

languageCode
​string · style: form · explode: true
startDate
​string · style: form · explode: true
endDate
​string · style: form · explode: true
status
​string · style: form · explode: true

The version status of the distance matrix elment

fromDate
​string · style: form · explode: true

The from date of the distance matrix elments version

toDate
​string · style: form · explode: true

The to date of the distance matrix elments version

Retrives a distance matrix elment by id › 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

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.

Retrives a distance matrix elment by id › Responses

Returns the distance matrix elment

A DistanceMatrixElement
DistanceMatrixElement
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: NSB:DistanceMatrixElement:NSR167ToNSR359
nameOfClass
​string · readOnly · required

Name of class.

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

DistanceMatrixElement version.

Example: NSB:Version:V1
​TextInLanguage[]

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

distance
​number · double

Distance.

Example: 16.4
endFareZoneRef
​string

End fare zone reference.

endScheduledStopPointId
​string

End scheduled stop point netexId.

​VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

groupId
​integer · int64

Group id.

Example: 4
​VersionOfObjectRef

Fare frame ref.

inverseAllowed
​boolean

Inverse is allowed.

Example: true
isDirect
​boolean

Is a direct route.

Example: true
​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

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

​FarePrice[]

Fare prices for the user profile.

relativeRanking
​integer · int32

Relative ranking.

Example: 2
startFareZoneRef
​string

Start fare zone reference.

startScheduledStopPointId
​string

Start scheduled stop point netexId.

tariffId
​integer · int64

Tariff id.

​VersionOfObjectRef

Fare frame ref.

​ValidityCondition[]

Validity conditions for the user profile.

day-typesdistribution-channel-usages
Did you find what you were looking for?