Entur Developer
Products
Products

fare-quota-factors

Server
Download schema

Retrieves all fare quota factors given

GET
https://api.entur.io/products
/fare-quota-factors

Retrieves all fare quota factors given › 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 fare quota factors given › 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 fare quota factors given › Responses

Returns the info

A FareQuotaFactor
FareQuotaFactor
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: ENT:FareQuotaFactor:SomeFareQuota4
modification
​string · enum · readOnly · required

Modification status

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

Name of class

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

FareQuotaFactor version. Versioned child of FSE,trying to set other versions will be ignored

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

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​TextInLanguage[]

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

numberOfUnits
​integer · int32

The number of units.

​FarePrice[]

Fare prices for the fare quota factor.

​ValidityCondition[]

Gives a sequence of conditions for validity.

value
​string

The value of fare quota factor.

Create a fareQuotaFactor

POST
https://api.entur.io/products
/fare-quota-factors

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

A FareQuotaFactor
FareQuotaFactor
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: ENT:FareQuotaFactor:SomeFareQuota4
modification
​string · enum · readOnly · required

Modification status

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

Name of class

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

FareQuotaFactor version. Versioned child of FSE,trying to set other versions will be ignored

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

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​TextInLanguage[]

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

numberOfUnits
​integer · int32

The number of units.

​FarePrice[]

Fare prices for the fare quota factor.

​ValidityCondition[]

Gives a sequence of conditions for validity.

value
​string

The value of fare quota factor.

Create a fareQuotaFactor › Responses

Entity created successfully

No data returned

Retrieves fare quota factor for id and version

GET
https://api.entur.io/products
/fare-quota-factors/{id}/{version}

Retrieves fare quota factor for id and version › path Parameters

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

The id to identify a FareQuotaFactor

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

The id for the version of the FareQuotaFactor

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

Returns the info

A FareQuotaFactor
FareQuotaFactor
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: ENT:FareQuotaFactor:SomeFareQuota4
modification
​string · enum · readOnly · required

Modification status

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

Name of class

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

FareQuotaFactor version. Versioned child of FSE,trying to set other versions will be ignored

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

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​TextInLanguage[]

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

numberOfUnits
​integer · int32

The number of units.

​FarePrice[]

Fare prices for the fare quota factor.

​ValidityCondition[]

Gives a sequence of conditions for validity.

value
​string

The value of fare quota factor.

Updates an existing FareQuotaFactor

PUT
https://api.entur.io/products
/fare-quota-factors/{id}/{version}

Updates an existing FareQuotaFactor › path Parameters

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

The id to identify a FareQuotaFactor

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

The id for the version of the FareQuotaFactor

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

A FareQuotaFactor
FareQuotaFactor
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: ENT:FareQuotaFactor:SomeFareQuota4
modification
​string · enum · readOnly · required

Modification status

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

Name of class

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

FareQuotaFactor version. Versioned child of FSE,trying to set other versions will be ignored

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

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​TextInLanguage[]

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

numberOfUnits
​integer · int32

The number of units.

​FarePrice[]

Fare prices for the fare quota factor.

​ValidityCondition[]

Gives a sequence of conditions for validity.

value
​string

The value of fare quota factor.

Updates an existing FareQuotaFactor › Responses

Entity updated successfully

No data returned

Deletes a FareQuotaFactor by id and version

DELETE
https://api.entur.io/products
/fare-quota-factors/{id}/{version}

Deletes a FareQuotaFactor by id and version › path Parameters

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

The id to identify a FareQuotaFactor

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

The id for the version of the FareQuotaFactor

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

The resource was deleted

BoxedUnit
fare-productsfare-sections
Did you find what you were looking for?