Schemas
LocalizedString
lang^[a-z]{2}-[A-Z]{2}$ · requiredBCP-47 language tag (e.g., 'nb-NO', 'en-GB').
valueThe localized string value for the specified lang.
FarePriceType
Discriminator for a fare table price cell. Only the flat FlatPrice (a fixed amount with no
selectors, NeTEx FarePrice) is implemented today; DistanceMatrixElementPrice and
GeographicalIntervalPrice will be added as sibling types when the price model is extended
beyond flat prices.
FarePriceEntry
typeDiscriminator for a fare table price cell. Only the flat FlatPrice (a fixed amount with no
selectors, NeTEx FarePrice) is implemented today; DistanceMatrixElementPrice and
GeographicalIntervalPrice will be added as sibling types when the price model is extended
beyond flat prices.
amount^[0-9]+(\.[0-9]+)?$ · requiredThe price in the major unit of this entry's currency, as a decimal string (for example
"49.00"). The number of decimals must not exceed what that currency allows — 2 for NOK and
EUR, 0 for JPY, 3 for KWD.
currency^[A-Z]{3}$ · requiredISO 4217 currency code for this individual price, per NeTEx FarePrice.Currency. Required:
the flat amount cannot be interpreted without knowing its currency (the number of decimals
depends on it). Different entries in the same fare table may declare different currencies.
FareTableRequest
startDateFirst day this price version is valid.
statusStatus of the fare table version. Required; on create only DRAFT or PROPOSED is accepted — a new version cannot be published directly.
- DRAFT - Under construction and not ready for operational use.
- PROPOSED - Complete but pending review and approval.
- VERSIONED - Finalized and frozen; a new version must be created for further modifications. Remains authoritative for its validity period even after expiry.
- DEPRECATED - Explicitly withdrawn and should not be used; indicates an active decision to retract, not a natural expiry.
The prices in this table. Each entry must be uniquely identified by its selector
combination, so a flat price with no passenger-type differentiation is a single
selector-less entry. Each entry carries its own optional currency, per NeTEx.
ownerOrganisationIdInternal id of the organisation that owns this element. Omit it to use the organisation in the access token, which is what a caller acting for itself should do. Supplying a different organisation requires permission to act on behalf of that organisation.
endDateLast day this price version is valid (optional). Omit for an open-ended version.
FareTableResponse
id^([A-Z]{3}):FareTabl… · requiredNeTEx id of the fare table.
versionId^([A-Z]{3}):Version:… · requiredNeTEx id of this fare table version.
ownerOrganisationIdInternal id of the organisation that owns this fare table.
startDateFirst day this price version is valid.
statusStatus of the fare table version.
- DRAFT - Under construction and not ready for operational use.
- PROPOSED - Complete but pending review and approval.
- VERSIONED - Finalized and frozen; a new version must be created for further modifications. Remains authoritative for its validity period even after expiry.
- DEPRECATED - Explicitly withdrawn and should not be used; indicates an active decision to retract, not a natural expiry.
The prices in this table. Each entry echoes its own currency, per NeTEx
FarePrice.Currency.
endDateLast day this price version is valid (optional). Omit for an open-ended version.
pricesForNeTEx ids of the priceable objects (e.g. supplement products) this fare table prices —
NeTEx FareTable.pricesFor.
The FareTable → PriceableObject link is deliberately loose: a versioned fare table prices a priceable object by netex id only, never pinned to a specific priceable object version. Version resolution happens later, when the product tree is built.
ProblemDetails
typeA URI reference that identifies the problem type.
titleShort, human-readable summary of the problem type.
statusThe HTTP status code.
detailHuman-readable explanation specific to this occurrence.
instanceA URI reference that identifies the specific occurrence.
VersionResponse
id^([A-Z]{3}):Version:… · requiredThe netex id reference to the object.
statusstartDateThe start date of the version.
createdCreated datetime
changedChanged datetime
numberVersion number of the version. Only present when versionStatus is VERSIONED. Starts at 1 for a new product and is incremented by 1 for each new version.
endDateThe end date of the version.
publishedTimestamp for when the version was published (set to status VERSIONED).
VersionRequest
statusMust be DRAFT for new versions.
startDateThe start date of the version. Defaults to current date if not provided.
endDateThe end date of the version (optional).
ownerOrganisationIdInternal id of the organisation that owns this element. Omit it to use the organisation in the access token, which is what a caller acting for itself should do. Supplying a different organisation requires permission to act on behalf of that organisation.