Retrieves usage validity periods by organisation id
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to identify a fare frame
languageCodeThe language code from ISO-639-3
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
If-None-MatchUsed 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 usage validity periods by organisation id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References to FareTable.
UsageValidityPeriod Name represented in different languages. Language codes are ISO-639.
usageEndUsage end.
Description represented in different languages. Language codes are ISO-639.
usageTriggerUsage trigger.
activationMeansActivation Means. Describes how a product can be activated.
A LimitingRule
Stepped duration.
standardDurationStandard duration. Represented as a string formatted according to ISO-8601
usageValidityTypeUsage validity type.
usageValidityTypesUsage validity type list.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
usageStartConstraintTypeUsage start constraint.
usageEndsUsage ends. This field is deprecated, please use the field usageEnd
Create a usage validity parameter
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a usage validity parameter › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
Fare frame ref.
References to FareTable.
usageEndUsage end.
usageEndsUsage End list.
Description represented in different languages. Language codes are ISO-639.
usageTriggerUsage trigger.
activationMeansActivation Means. Describes how a product can be activated.
Stepped duration.
standardDurationStandard duration. Represented as a string formatted according to ISO-8601
usageValidityTypesUsage validity type list.
usageStartConstraintTypeUsage start constraint.
Create a usage validity parameter › Responses
Entity created successfully
Retrives a usage validity period by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a usage validity period
query Parameters
versionThe id for the version of the usage validity period
languageCodeThe language code from ISO-639-3
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
If-None-MatchUsed 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 usage validity period by id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References to FareTable.
UsageValidityPeriod Name represented in different languages. Language codes are ISO-639.
usageEndUsage end.
Description represented in different languages. Language codes are ISO-639.
usageTriggerUsage trigger.
activationMeansActivation Means. Describes how a product can be activated.
A LimitingRule
Stepped duration.
standardDurationStandard duration. Represented as a string formatted according to ISO-8601
usageValidityTypeUsage validity type.
usageValidityTypesUsage validity type list.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
usageStartConstraintTypeUsage start constraint.
usageEndsUsage ends. This field is deprecated, please use the field usageEnd
Update a list of uvps
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update a list of uvps › Responses
Entity updated successfully
Create a list of uvp
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a list of uvp › Responses
Entity created successfully
Retrieves a usage validity period by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a usage validity period
query Parameters
startDateendDatestatusThe version status of the usage validity period
fromDateThe from date of the usage validity periods version
toDateThe to date of the usage validity periods version
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Accept-LanguageThe language code from ISO-639-3
If-None-MatchUsed 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 usage validity period by id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References to FareTable.
UsageValidityPeriod Name represented in different languages. Language codes are ISO-639.
usageEndUsage end.
Description represented in different languages. Language codes are ISO-639.
usageTriggerUsage trigger.
activationMeansActivation Means. Describes how a product can be activated.
A LimitingRule
Stepped duration.
standardDurationStandard duration. Represented as a string formatted according to ISO-8601
usageValidityTypeUsage validity type.
usageValidityTypesUsage validity type list.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
usageStartConstraintTypeUsage start constraint.
usageEndsUsage ends. This field is deprecated, please use the field usageEnd
Retrives a usage validity period by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a usage validity period
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the usage validity period
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Accept-LanguageThe language code from ISO-639-3
If-None-MatchUsed 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 usage validity period by id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
References to FareTable.
UsageValidityPeriod Name represented in different languages. Language codes are ISO-639.
usageEndUsage end.
Description represented in different languages. Language codes are ISO-639.
usageTriggerUsage trigger.
activationMeansActivation Means. Describes how a product can be activated.
A LimitingRule
Stepped duration.
standardDurationStandard duration. Represented as a string formatted according to ISO-8601
usageValidityTypeUsage validity type.
usageValidityTypesUsage validity type list.
derivedFromVersionRefDerived from version.
compatibleWithVersionRefCompatible with version.
usageStartConstraintTypeUsage start constraint.
usageEndsUsage ends. This field is deprecated, please use the field usageEnd
Update a usage validity period
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a usage validity period
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the usage validity period
query Parameters
languageCodeThe language code from ISO-639-3
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update a usage validity period › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
Fare frame ref.
References to FareTable.
usageEndUsage end.
usageEndsUsage End list.
Description represented in different languages. Language codes are ISO-639.
usageTriggerUsage trigger.
activationMeansActivation Means. Describes how a product can be activated.
Stepped duration.
standardDurationStandard duration. Represented as a string formatted according to ISO-8601
usageValidityTypesUsage validity type list.
usageStartConstraintTypeUsage start constraint.
Update a usage validity period › Responses
Entity updated successfully