Entur Developer
Products
Products

geographical-structure-factors

Server
Download schema

Retrieves all geographical structure factors

GET
https://api.entur.io/products
/geographical-structure-factors

Retrieves all geographical structure factors › 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

Possibility of opting out of including child elements

Retrieves all geographical structure factors › 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 geographical structure factors › Responses

Returns the info

GeographicalStructureFactor
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​DistanceMatrixElement[] · required

Distance matrix elements

​VersionOfObjectRef · required

Fare frame ref.

​GeographicalInterval[] · required

Geographical intervals

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

Id

Example: NSB:GeographicalStructureFactor:50TEN
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the geographical structure factor represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: GeographicalStructureFactor
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

Version

Example: NSB:Version:V1
geographicalUnitRef
​string

Geographical unit ref

Create a GeographicalStructureFactor

POST
https://api.entur.io/products
/geographical-structure-factors

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

GeographicalStructureFactor
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​DistanceMatrixElement[] · required

Distance matrix elements

​VersionOfObjectRef · required

Fare frame ref.

​GeographicalInterval[] · required

Geographical intervals

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

Id

Example: NSB:GeographicalStructureFactor:50TEN
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the geographical structure factor represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: GeographicalStructureFactor
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

Version

Example: NSB:Version:V1
geographicalUnitRef
​string

Geographical unit ref

Create a GeographicalStructureFactor › Responses

Entity created successfully

No data returned

Retrieves geographical structure factor for id and version

GET
https://api.entur.io/products
/geographical-structure-factors/{id}/{version}

Retrieves geographical structure factor for id and version › path Parameters

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

The id to identify a GeographicalStructureFactor

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

The id for the version of the GeographicalStructureFactor

Retrieves geographical structure factor for 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 geographical structure factor for id and version › Responses

Returns the info

GeographicalStructureFactor
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​DistanceMatrixElement[] · required

Distance matrix elements

​VersionOfObjectRef · required

Fare frame ref.

​GeographicalInterval[] · required

Geographical intervals

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

Id

Example: NSB:GeographicalStructureFactor:50TEN
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the geographical structure factor represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: GeographicalStructureFactor
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

Version

Example: NSB:Version:V1
geographicalUnitRef
​string

Geographical unit ref

Updates an existing GeographicalStructureFactor

PUT
https://api.entur.io/products
/geographical-structure-factors/{id}/{version}

Updates an existing GeographicalStructureFactor › path Parameters

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

The id to identify a GeographicalStructureFactor

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

The id for the version of the GeographicalStructureFactor

Updates an existing GeographicalStructureFactor › 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 GeographicalStructureFactor › Request Body

GeographicalStructureFactor
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​DistanceMatrixElement[] · required

Distance matrix elements

​VersionOfObjectRef · required

Fare frame ref.

​GeographicalInterval[] · required

Geographical intervals

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

Id

Example: NSB:GeographicalStructureFactor:50TEN
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the geographical structure factor represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: GeographicalStructureFactor
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

Version

Example: NSB:Version:V1
geographicalUnitRef
​string

Geographical unit ref

Updates an existing GeographicalStructureFactor › Responses

Entity updated successfully

No data returned

Deletes a GeographicalStructureFactor by id and version

DELETE
https://api.entur.io/products
/geographical-structure-factors/{id}/{version}

Deletes a GeographicalStructureFactor by id and version › path Parameters

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

The id to identify a GeographicalStructureFactor

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

The id for the version of the GeographicalStructureFactor

Deletes a GeographicalStructureFactor 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

Deletes a GeographicalStructureFactor by id and version › Responses

The resource was deleted

BoxedUnit
geographical-intervalsgeographical-structure-factors-usages
Did you find what you were looking for?