Retrieves purchase window by fareFrame id or organisation id
query Parameters
orgIdThe unique organisation id to identify the owner of the data
fareFrameIdThe unique fareFrame id to identify the owner of the data
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>.
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 purchase window by fareFrame id or organisation id › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredPurchaseWindow version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
latestTimeLatest time to purchase.
A LimitingRule
maxmumPeriodBeforeDepartureMaximum period before departure.
minimumPeriodBeforeDepartureMinimum period before departure.
PurchaseWindow Name represented in different languages. Language codes are ISO-639.
purchaseWhenWhen to purchase.
Create a purchase window
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>.
X-Correlation-IdCorrelation id
Create a purchase window › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
PurchaseWindow Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredPurchaseWindow version.
Description represented in different languages. Language codes are ISO-639.
latestTimeLatest time.
A LimitingRule
maxmumPeriodBeforeDepartureMaximum period before departure.
minimumPeriodBeforeDepartureMinimum period before departure.
purchaseWhenWhen to purchase.
Create a purchase window › Responses
Entity created successfully
Retrives a purchase window by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a purchase window
query Parameters
versionThe id for the version of the purchase window
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>.
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 purchase window by id › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredPurchaseWindow version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
latestTimeLatest time to purchase.
A LimitingRule
maxmumPeriodBeforeDepartureMaximum period before departure.
minimumPeriodBeforeDepartureMinimum period before departure.
PurchaseWindow Name represented in different languages. Language codes are ISO-639.
purchaseWhenWhen to purchase.
Retrives a purchase window by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a purchase window
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the purchase window
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>.
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 purchase window by id and version › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredPurchaseWindow version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
latestTimeLatest time to purchase.
A LimitingRule
maxmumPeriodBeforeDepartureMaximum period before departure.
minimumPeriodBeforeDepartureMinimum period before departure.
PurchaseWindow Name represented in different languages. Language codes are ISO-639.
purchaseWhenWhen to purchase.
Update a purchase window
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a purchase window
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the purchase window
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>.
X-Correlation-IdCorrelation id
Update a purchase window › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
PurchaseWindow Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredPurchaseWindow version.
Description represented in different languages. Language codes are ISO-639.
latestTimeLatest time.
A LimitingRule
maxmumPeriodBeforeDepartureMaximum period before departure.
minimumPeriodBeforeDepartureMinimum period before departure.
purchaseWhenWhen to purchase.
Update a purchase window › Responses
Entity updated successfully
Retrieves a purchase window by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a purchase window
query Parameters
startDateendDatestatusThe version status of the purchase window
fromDateThe from date of the purchase windows version
toDateThe to date of the purchase windows 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>.
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 purchase window by id › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredPurchaseWindow version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
latestTimeLatest time to purchase.
A LimitingRule
maxmumPeriodBeforeDepartureMaximum period before departure.
minimumPeriodBeforeDepartureMinimum period before departure.
PurchaseWindow Name represented in different languages. Language codes are ISO-639.
purchaseWhenWhen to purchase.