Entur Developer
Products
Products

frequencies-of-use

Server
Download schema

Retrieves all frequencies of use

GET
https://api.entur.io/products
/frequencies-of-use

Retrieves all frequencies of use › 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

Retrieves all frequencies of use › 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 all frequencies of use › Responses

Returns the frequencies of use

Frequency of use
FrequencyOfUse
changed
​string · date-time · required

Frequency of use changed datetime.

created
​string · date-time · required

Frequency of use created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare tables.

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

Id.

Example: NSB:FrequencyOfUse:Single
modification
​string · enum · required

Modification status.

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

Name of class.

Example: FrequencyOfUse
status
​string · enum · required

Status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Frequency of use version.

Example: NSB:Version:V1
​TextInLanguage[]

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

frequencyOfUseType
​string · enum

Frequency of use type.

Enum values:
NONE
SINGLE
LIMITED
UNLIMITED
TWICE_A_DAY
Example: SINGLE
maximalFrequency
​integer · int32

Maximal frequency given for this frequency of use.

minimalFrequency
​integer · int32

Minimal frequency given for this frequency of use.

​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the refunding rule.

Create a frequency-of-use

POST
https://api.entur.io/products
/frequencies-of-use

Create a frequency-of-use › 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 frequency-of-use › Request Body

FrequencyOfUseInsert
​VersionOfObjectRef · required

Fare frame ref.

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

Id.

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

Frequency of use version.

Example: NSB:Version:V1
​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

frequencyOfUseType
​string · enum

Frequency of use type.

Enum values:
NONE
SINGLE
LIMITED
UNLIMITED
TWICE_A_DAY
Example: SINGLE
maximalFrequency
​integer · int32

Maximal frequency given for this frequency of use.

minimalFrequency
​integer · int32

Minimal frequency given for this frequency of use.

​TextInLanguage[]

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

​FarePriceInsert[]

Prices in different currencies for the frequency of use.

Create a frequency-of-use › Responses

Entity created successfully

No data returned

Retrieves frequencies of use by id and version

GET
https://api.entur.io/products
/frequencies-of-use/{id}/{version}

Retrieves frequencies of use by id and version › path Parameters

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

The unique id to identify a frequency of use

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

The id for the version of the frequency of use

Retrieves frequencies of use 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 frequencies of use by id and version › Responses

Returns the frequencies of use

Frequency of use
FrequencyOfUse
changed
​string · date-time · required

Frequency of use changed datetime.

created
​string · date-time · required

Frequency of use created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare tables.

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

Id.

Example: NSB:FrequencyOfUse:Single
modification
​string · enum · required

Modification status.

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

Name of class.

Example: FrequencyOfUse
status
​string · enum · required

Status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Frequency of use version.

Example: NSB:Version:V1
​TextInLanguage[]

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

frequencyOfUseType
​string · enum

Frequency of use type.

Enum values:
NONE
SINGLE
LIMITED
UNLIMITED
TWICE_A_DAY
Example: SINGLE
maximalFrequency
​integer · int32

Maximal frequency given for this frequency of use.

minimalFrequency
​integer · int32

Minimal frequency given for this frequency of use.

​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the refunding rule.

Update a frequency of use parameter.

PUT
https://api.entur.io/products
/frequencies-of-use/{id}/{version}

Update a frequency of use parameter. › path Parameters

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

The unique id to identify a frequency of use

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

The id for the version of the frequency of use

Update a frequency of use parameter. › 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 a frequency of use parameter. › Request Body

FrequencyOfUseInsert
​VersionOfObjectRef · required

Fare frame ref.

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

Id.

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

Frequency of use version.

Example: NSB:Version:V1
​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

frequencyOfUseType
​string · enum

Frequency of use type.

Enum values:
NONE
SINGLE
LIMITED
UNLIMITED
TWICE_A_DAY
Example: SINGLE
maximalFrequency
​integer · int32

Maximal frequency given for this frequency of use.

minimalFrequency
​integer · int32

Minimal frequency given for this frequency of use.

​TextInLanguage[]

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

​FarePriceInsert[]

Prices in different currencies for the frequency of use.

Update a frequency of use parameter. › Responses

Entity updated successfully

No data returned

Retrieves frequencies of use by id

GET
https://api.entur.io/products
/v1/frequencies-of-use/{id}

Retrieves frequencies of use by id › path Parameters

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

The unique id to identify a frequency of use

Retrieves frequencies of use by id › query Parameters

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

The version status of the frequency of use

fromDate
​string · style: form · explode: true

The from date of the frequency of use version

toDate
​string · style: form · explode: true

The to date of the frequency of use version

Retrieves frequencies of use 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.

Retrieves frequencies of use by id › Responses

Returns the frequencies of use

Frequency of use
FrequencyOfUse
changed
​string · date-time · required

Frequency of use changed datetime.

created
​string · date-time · required

Frequency of use created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare tables.

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

Id.

Example: NSB:FrequencyOfUse:Single
modification
​string · enum · required

Modification status.

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

Name of class.

Example: FrequencyOfUse
status
​string · enum · required

Status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Frequency of use version.

Example: NSB:Version:V1
​TextInLanguage[]

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

frequencyOfUseType
​string · enum

Frequency of use type.

Enum values:
NONE
SINGLE
LIMITED
UNLIMITED
TWICE_A_DAY
Example: SINGLE
maximalFrequency
​integer · int32

Maximal frequency given for this frequency of use.

minimalFrequency
​integer · int32

Minimal frequency given for this frequency of use.

​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the refunding rule.

fare-tablesfulfilment-methods
Did you find what you were looking for?