Schemas
leg
iddefault string, full names etc (length 0-200)
type^(leg)$ · requireduse an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
modeThese classes are taken from the NeTeX standard, but ALL and UNKNOWN are removed. On the other hand OTHER and PARKING are added.
an amount of money, usable in fares, fare calculations or in extra costs.
statestatus of a leg
NOT_STARTED the leg is not started, initial state
PREPARING the PREPARE operation has been received
PREPARED the leg is ready to use
IN_USE the travelers are on their way
PAUSED the asset is paused
ENDED the travelers have arrived at their destination
ISSUE_REPORTED due to an issue, there is (temporarily) no progress to report, when the issue isn't solved, this is a final state
CANCELLED the leg has been cancelled, before execution
ABENDED the leg is abnormally ended (e.g. due to an issue)
assetsThe physical asset(s) used for the execution of the leg
productsa reference to a product in the 'products' collection of the offer
travellerdefault string, full names etc (length 0-200)
ancillariesadditional products that can be assigned to this leg, references to 'ancillaries' collection
sequenceNumbera bit short integer (0-100)
card
type^(card)$ · requiredcardNumbershort string, display names (length 0-75)
country[A-Z]{2}two-letter country codes according to ISO 3166-1
A generic description of a CARD
descriptionshort string, display names (length 0-75)
endValidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)
additionalNumbershort string, display names (length 0-75)
date
https://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)
link
relthe action that can be performed OR part of the URI allowed values include the 'processId's, prefixes for the referenced data sources, prefixes for deeplinks ('apple' and 'android'), OGC compliant ones (alternative, next, etc)
hrefvalid URL
bodythe (prefilled) body for the request
hashto validate that the content of the link hasn't been changed.
typeshort string, display names (length 0-75)
methodto indicate the http method.
descriptionthe description of the external data source
isMandatoryis this link informative, or must it be used?
mode
These classes are taken from the NeTeX standard, but ALL and UNKNOWN are removed. On the other hand OTHER and PARKING are added.
seat
iddefault string, full names etc (length 0-200)
rowa bit short integer (0-100)
deckshort string, display names (length 0-75)
type^(seat)$spaceshort string, display names (length 0-75)
facingbyAislehasTraybyWindowhasAircohasLightlegSpacea bit short integer (0-100)
hasArmRestseatNumbera bit short integer (0-100)
hasEnergySupplyuuid
https://en.wikipedia.org/wiki/Universally_unique_identifier see also https://www.ietf.org/rfc/rfc4122.txt (ae76f51c-a1a6-46af-b9ab-8233564adcae)
asset
iddefault string, full names etc (length 0-200)
modeThese classes are taken from the NeTeX standard, but ALL and UNKNOWN are removed. On the other hand OTHER and PARKING are added.
type^(asset)$subModedefault string, full names etc (length 0-200)
visualIdshort string, display names (length 0-75)
list of external references
error
codeStable machine-readable OMSA problem code.
hintShort client-facing remediation hint.
typevalid URL
titleshort string, display names (length 0-75)
detaillong string, memos etc (length 0-10.000)
statusHTTP status code (100–599)
categoryPublic problem category used by OMSA curated problems.
offer
idshort string, display names (length 0-75)
type^(offer)$country
[A-Z]{2}two-letter country codes according to ISO 3166-1
geojson
type^(FeatureCollection)…actions that can be performed on this package, but also alternative (rel=alternative+1, alternative+2) offers or references to other resources In case it is an alternative, specify clearly in the description what the financial consequences are.
propertiesnumberMatchednumberReturnedlicense
type^(license)$ · requiredendValidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)
A category of license to use a certain asset class
licenseNumbershort string, display names (length 0-75)
package
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
product
type^(product)$references to products that are contained in this product (to facilitate e.g. travel through) If his combined product is named in a package, the referenced packages must be enlisted as well.
productNamedefault string, full names etc (length 0-200)
cardType
idshort string, display names (length 0-75)
type^(card_type)$ · requiredsubCategoryshort string, display names (length 0-75)
cardCategoryThe category of card
DISCOUNT - discount card, can be applied in the purchase process to get rebate
TRAVEL - (external) travel card, possibly paid for in other context, but also monthly, weekly or day-cards
BANK - bank card
CREDIT - credit card
ID - identification card, like an ID card
PASSPORT - passport to identify yourself
OTHER - unspecified, use 'subCategory' to specify the category of card
dictionary for extra fields (bilatural agreements)
references to accepting parties, only if applicable
customer
lastNameshort string, display names (length 0-75)
firstNameshort string, display names (length 0-75)
iddefault string, full names etc (length 0-200)
emaildefault string, full names etc (length 0-200)
prefixreal short string, codes (length 0-10)
address parts, where addressLine1 and 2 should contain the complete address, matches Content-Language
postfixreal short string, codes (length 0-10)
initialsreal short string, codes (length 0-10)
middleNameshort string, display names (length 0-75)
dateOfBirthhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)
phoneNumberdefault string, full names etc (length 0-200)
placeOfBirthshort string, display names (length 0-75)
countryOfBirth[A-Z]{2}two-letter country codes according to ISO 3166-1
dictionary for extra fields (bilatural agreements)
dataType
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = string | |
| type = string |
dateTime
https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
legInput
type^(?=.*(?:^(package))… · requiredpackageIddefault string, full names etc (length 0-200)
legIddefault string, full names etc (length 0-200)
offerIddefault string, full names etc (length 0-200)
legState
status of a leg
NOT_STARTED the leg is not started, initial state
PREPARING the PREPARE operation has been received
PREPARED the leg is ready to use
IN_USE the travelers are on their way
PAUSED the asset is paused
ENDED the travelers have arrived at their destination
ISSUE_REPORTED due to an issue, there is (temporarily) no progress to report, when the issue isn't solved, this is a final state
CANCELLED the leg has been cancelled, before execution
ABENDED the leg is abnormally ended (e.g. due to an issue)
metadata
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: href, rel | |
| type = object |
relthe action that can be performed OR part of the URI allowed values include the 'processId's, prefixes for the referenced data sources, prefixes for deeplinks ('apple' and 'android'), OGC compliant ones (alternative, next, etc)
hrefvalid URL
bodythe (prefilled) body for the request
hashto validate that the content of the link hasn't been changed.
typeshort string, display names (length 0-75)
methodto indicate the http method.
descriptionthe description of the external data source
isMandatoryis this link informative, or must it be used?
ancillary
ancillaryIddefault string, full names etc (length 0-200)
namedefault string, full names etc (length 0-200)
type^(ancillary)$an amount of money, usable in fares, fare calculations or in extra costs.
availableNumber of items available in stock (inventory). Useful for creating urgency in GUI.
descriptionA user-friendly description of the ancillary (e.g. 'Reserved seat for bike').
guarantee
idshort string, display names (length 0-75)
typedefault string, full names etc (length 0-200)
assetInput
type^(?=.*(?:^(?=.*(?:^(… · requiredpackageIddefault string, full names etc (length 0-200)
legIddefault string, full names etc (length 0-200)
assetIddefault string, full names etc (length 0-200)
offerIddefault string, full names etc (length 0-200)
replaceAssetIddefault string, full names etc (length 0-200)
classOfUse
A classification of fare and other service classes by category of user entitled to use them.
subscriber
failedUrisuccessUriinProgressUricollections
timeStampnumberMatchednumberReturnedcustomerRef
iddefault string, full names etc (length 0-200)
geojsonLine
coordinateslandingPage
titleattributionThe attribution should be short and intended for presentation to a user, for example, in a corner of a map. Parts of the text can be links to other resources if additional information is needed. The string can include HTML markup.
descriptionlicenseType
type^(license_type)$ · requiredmodeslicenseCodeshort string, display names (length 0-75)
dictionary for extra fields (bilatural agreements)
issuingCountry[A-Z]{2}two-letter country codes according to ISO 3166-1
onboardStay
type^(onboard_stay)$ · requireddurationshort string, display names (length 0-75)
classOfUseA classification of fare and other service classes by category of user entitled to use them.
permissiondescriptionlong string, memos etc (length 0-10.000)
processList
tripPattern
datehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)
serviceJourneydefault string, full names etc (length 0-200)
userProfile
type^(user_profile)$ · requirediddefault string, full names etc (length 0-200)
counta bit short integer (0-100)
ageGroupmaximumAgea bit short integer (0-100)
minimumAgea bit short integer (0-100)
localResidentmaximumHeighta bit short integer (0-100)
minimumHeighta bit short integer (0-100)
genderLimitationmonthDayOnWhichAgeAppliesa bit short integer (0-100)
binaryTicket
endvalidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startvalidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
travelDocumentTypehow this type is implemented?
base64long string, memos etc (length 0-10.000)
contentTypethe media type (IANA)
statusThe lifecycle status of a travel document.
PENDING the document is being processed or awaiting distribution pickup
ACTIVE the document is ready for use
FAILED the document distribution failed
EXPIRED the document has expired
CANCELLED the document has been cancelled
type^(binary_ticket)$versionreal short string, codes (length 0-10)
changeOption
idtype^(change_option)$changeTypelegReference
default string, full names etc (length 0-200)
packageInput
type^(package) · requiredpackageIddefault string, full names etc (length 0-200)
refundOption
idhttps://en.wikipedia.org/wiki/Universally_unique_identifier see also https://www.ietf.org/rfc/rfc4122.txt (ae76f51c-a1a6-46af-b9ab-8233564adcae)
type^(refund_option)$refundTypepackageStateThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
accommodation
nameshort string, display names (length 0-75)
type^(accommodation)$genderberthTypeclassOfUseA classification of fare and other service classes by category of user entitled to use them.
descriptionlong string, memos etc (length 0-10.000)
nuisanceFacilityamountOfMoney
amountThis should be in the base unit as defined by the ISO 4217 currency code with the appropriate number of decimal places and omitting the currency symbol. e.g. if the price is in US Dollars the price would be 9.95. This is inclusive VAT
currencyCode[a-zA-Z]{3}ISO 4217 currency code
vatCountryCode[A-Z]{2}two-letter country codes according to ISO 3166-1
taxPercentageUsedthe travelled distance. Only if applicable.
customerInput
lastNameshort string, display names (length 0-75)
firstNameshort string, display names (length 0-75)
emaildefault string, full names etc (length 0-200)
prefixreal short string, codes (length 0-10)
address parts, where addressLine1 and 2 should contain the complete address, matches Content-Language
postfixreal short string, codes (length 0-10)
initialsreal short string, codes (length 0-10)
middleNameshort string, display names (length 0-75)
dateOfBirthhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)
phoneNumberdefault string, full names etc (length 0-200)
placeOfBirthshort string, display names (length 0-75)
countryOfBirth[A-Z]{2}two-letter country codes according to ISO 3166-1
dictionary for extra fields (bilatural agreements)
dateTimeOrNow
Either RFC3339 date-time (for example 2019-10-12T07:20:50Z) or the keyword NOW for server-side immediate start.
lineReference
default string, full names etc (length 0-200)
packageStatus
The life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
pendingTicket
endvalidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startvalidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
travelDocumentTypehow this type is implemented?
statusThe lifecycle status of a travel document.
PENDING the document is being processed or awaiting distribution pickup
ACTIVE the document is ready for use
FAILED the document distribution failed
EXPIRED the document has expired
CANCELLED the document has been cancelled
type^(pending_ticket)$postalAddress
addressLine1long string, memos etc (length 0-10.000)
addressLine2long string, memos etc (length 0-10.000)
cityshort string, display names (length 0-75)
stateshort string, display names (length 0-75)
streetdefault string, full names etc (length 0-200)
country[A-Z]{2}two-letter country codes according to ISO 3166-1
provinceshort string, display names (length 0-75)
postalCodeshort string, display names (length 0-75)
houseNumberdefault length for an integer (0-1000)
additionalInfolong string, memos etc (length 0-10.000)
houseNumberAdditionreal short string, codes (length 0-10)
zoneReference
zoneIddefault string, full names etc (length 0-200)
namedefault string, full names etc (length 0-200)
ancillaryInput
type^(?=.*(?:^(?=.*(?:^(… · requiredpackageIddefault string, full names etc (length 0-200)
legIddefault string, full names etc (length 0-200)
offerIddefault string, full names etc (length 0-200)
assetReference
default string, full names etc (length 0-200)
collectionInfo
ididentifier of the collection used, for example, in URIs
crsthe list of coordinate reference systems supported by the API; the first item is the default coordinate reference system
titlehuman readable title of the collection
extentitemTypeindicator about the type of the items in the collection if the collection has an accessible /collections/{collectionId}/items endpoint
descriptiona description of the data in the collection
maxCellSizeMaximum cell size for usage of the collection
minCellSizeMinimum cell size for usage of the collection
geometryDimensionThe geometry dimension of the features shown in this layer (0: points, 1: curves, 2: surfaces, 3: solids), unspecified: mixed or unknown
maxScaleDenominatorMaximum scale denominator for usage of the collection
minScaleDenominatorMinimum scale denominator for usage of the collection
externalTicket
endvalidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startvalidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
travelDocumentTypehow this type is implemented?
statusThe lifecycle status of a travel document.
PENDING the document is being processed or awaiting distribution pickup
ACTIVE the document is ready for use
FAILED the document distribution failed
EXPIRED the document has expired
CANCELLED the document has been cancelled
typegeojsonFeature
idshort string, display names (length 0-75)
type^(Feature)$ · requiredgeojsonPolygon
coordinatesofferReference
default string, full names etc (length 0-200)
placeReference
placeId^(GPS:|NSR:StopPlace… · requiredthis string references to information that can be found in the data sources. Enlist all prefixes (=rel) from the /collections/datasources/items that apply to a place/location. Default it matches already with 'GPS' (no entry required in the datasources). In case of a custom place (like home address), you can use the 'P:' prefix and add the address to the placeDefinitions list of the request.
namedefault string, full names etc (length 0-200)
processSummary
idversiontitlekeywordsdescriptionjobControlOptionstravelDocument
endvalidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startvalidityhttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
travelDocumentTypehow this type is implemented?
statusThe lifecycle status of a travel document.
PENDING the document is being processed or awaiting distribution pickup
ACTIVE the document is ready for use
FAILED the document distribution failed
EXPIRED the document has expired
CANCELLED the document has been cancelled
financialDetail
legdefault string, full names etc (length 0-200)
offerdefault string, full names etc (length 0-200)
an amount of money, usable in fares, fare calculations or in extra costs.
packagedefault string, full names etc (length 0-200)
categoryThe category of the journalled item
ALL - for filtering purposes only
TO initiated payments
To request these payments, use the notifications, send a notification containing the payment confirmation._DEPOSIT_ - a deposit, to refund, use _REFUND_
_DAMAGE_ - extra costs that must be paid by the MP due to damage to the asset or ancillaries
_LOSS_ - extra costs that must be paid by the MP due to loss of asset or ancillaries
_STOLEN_ - the asset (and ancillaries) are stolen and should be paid for
_EXTRA_USAGE_ - the asset is paid for in advance, additional usage must be paid for (can also be a refund when used less! The amount should be negative in that case)
_FINE_ - a fine that arrived later on
_OTHER_ASSET_USED_ - additional costs for a replaced asset
_FARE_ - the normal costs of the purchased and executed leg(s)
_OTHER_ - unspecified
_CREDIT_ - generic CREDIT, e.g. for kick-backs
_VOUCHER_ - part of the fare that is covered by a voucher (no need to pay)
_REFUND_ - refund of the deposit or upfront paid fare
_REBATE_ - (partial) rebate of the fare
_REIMBURSEMENT_ - reimbursement of the fare
dictionary for extra fields (bilatural agreements)
expirationDatehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
offerCollection
type^(OfferCollection)$ · requiredactions that can be performed on this package, but also alternative (rel=alternative+1, alternative+2) offers or references to other resources In case it is an alternative, specify clearly in the description what the financial consequences are.
numberMatchednumberReturnedpaymentCategory
The category of the journalled item
ALL - for filtering purposes only
TO initiated payments
To request these payments, use the notifications, send a notification containing the payment confirmation._DEPOSIT_ - a deposit, to refund, use _REFUND_
_DAMAGE_ - extra costs that must be paid by the MP due to damage to the asset or ancillaries
_LOSS_ - extra costs that must be paid by the MP due to loss of asset or ancillaries
_STOLEN_ - the asset (and ancillaries) are stolen and should be paid for
_EXTRA_USAGE_ - the asset is paid for in advance, additional usage must be paid for (can also be a refund when used less! The amount should be negative in that case)
_FINE_ - a fine that arrived later on
_OTHER_ASSET_USED_ - additional costs for a replaced asset
_FARE_ - the normal costs of the purchased and executed leg(s)
_OTHER_ - unspecified
_CREDIT_ - generic CREDIT, e.g. for kick-backs
_VOUCHER_ - part of the fare that is covered by a voucher (no need to pay)
_REFUND_ - refund of the deposit or upfront paid fare
_REBATE_ - (partial) rebate of the fare
_REIMBURSEMENT_ - reimbursement of the fare
travellingAsset
iddefault string, full names etc (length 0-200)
type^(asset)$ · requiredentitlementGiven
type^(entitlement)$ · requiredentitlementTypedefault string, full names etc (length 0-200)
idshort string, display names (length 0-75)
networkParameter
type^(network)$ · requiredlinedefault string, full names etc (length 0-200)
packageReference
default string, full names etc (length 0-200)
placeDefinitions
Places that are not specified in an external data source (like a home address)
productReference
namedefault string, full names etc (length 0-200)
productIddefault string, full names etc (length 0-200)
routingParameter
type^(routing)$ · requiredjourneyPatternsearchOfferInput
type^(search_offer) · requiredEntur-specific OMSA extensions for search-offers input.
packageToExchangedefault string, full names etc (length 0-200)
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: travellers | |
| type = object · requires: profiles |
type^(search_offer)Entur-specific OMSA extensions for search-offers input.
packageToExchangedefault string, full names etc (length 0-200)
serviceParameter
type^(service)$ · requiredassetdefault string, full names etc (length 0-200)
classA classification of fare and other service classes by category of user entitled to use them.
serviceJourneydefault string, full names etc (length 0-200)
addTravellerInput
type^(traveller)$ · requiredpackageIddefault string, full names etc (length 0-200)
A generic description of a traveler, not including any identifying information
commercialProfile
type^(commercial_profile… · requiredidshort string, display names (length 0-75)
codeshort string, display names (length 0-75)
namedefault string, full names etc (length 0-200)
customerReference
default string, full names etc (length 0-200)
externalReference
default string, full names etc (length 0-200)
purchaseParameter
type^(purchase)$ · requiredONE of these licenses is required to operate the asset
maximumPeriodBeforeDeparturelong number, for distances etc. (>1.000)
refundOptionInput
type^(claim_refund_optio… · requiredoptionIdhttps://en.wikipedia.org/wiki/Universally_unique_identifier see also https://www.ietf.org/rfc/rfc4122.txt (ae76f51c-a1a6-46af-b9ab-8233564adcae)
selectOffersInput
type^(select_offers) · requiredofferIdsReference to an existing customer by id.
Reference to an existing customer by id.
externalReferencedefault string, full names etc (length 0-200)
temporalParameter
type^(temporal)$ · requireddayTypeendTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
durationdefault length for an integer (0-1000)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
userNeedReference
iddefault string, full names etc (length 0-200)
namedefault string, full names etc (length 0-200)
ancillaryReference
ancillaryIddefault string, full names etc (length 0-200)
namedefault string, full names etc (length 0-200)
customerCollection
typeactions that can be performed on this package, but also alternative (rel=alternative+1, alternative+2) offers or references to other resources In case it is an alternative, specify clearly in the description what the financial consequences are.
numberMatchednumberReturnedequipmentParameter
type^(equipment)$ · requirednameshort string, display names (length 0-75)
imagevalid URL
infoLinkvalid URL
descriptionlong string, memos etc (length 0-10.000)
equipmentReference
equipmentIddefault string, full names etc (length 0-200)
namedefault string, full names etc (length 0-200)
travellerReference
default string, full names etc (length 0-200)
ancillaryCollection
type^(AncillaryCollectio… · requiredactions that can be performed on this package, but also alternative (rel=alternative+1, alternative+2) offers or references to other resources In case it is an alternative, specify clearly in the description what the financial consequences are.
numberMatchednumberReturnedgeojsonMultiPolygon
coordinatesindividualTraveller
type^(individual_travell… · requirediddefault string, full names etc (length 0-200)
agea bit short integer (0-100)
genderfullNamedefault string, full names etc (length 0-200)
isValidatedWhether this traveler's identity and properties have been verified by the MaaS provider
dictionary for extra fields (bilatural agreements)
customerReferencedefault string, full names etc (length 0-200)
purchaseOffersInput
type^(?=.*(?:^(select_of… · requiredofferIdsReference to an existing customer by id.
Reference to an existing customer by id.
externalReferencedefault string, full names etc (length 0-200)
travelSpecification
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
removeTravellerInput
type^(traveller)$ · requiredpackageIddefault string, full names etc (length 0-200)
travellerIddefault string, full names etc (length 0-200)
travelDocumentStatus
The lifecycle status of a travel document.
PENDING the document is being processed or awaiting distribution pickup
ACTIVE the document is ready for use
FAILED the document distribution failed
EXPIRED the document has expired
CANCELLED the document has been cancelled
typeOfTravelDocument
how this type is implemented?
updateTravellerInput
type^(traveller)$ · requiredpackageIddefault string, full names etc (length 0-200)
travellerIddefault string, full names etc (length 0-200)
A generic description of a traveler, not including any identifying information
userProfileReference
default string, full names etc (length 0-200)
cancellationParameter
type^(cancel)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
cancellationAllowedis it possible to cancel this package?
cancellationFeePercentagepercentage of the offered price you have to pay when you cancel this purchased package
distributionParameter
type^(distribution)$ · requiredfulfilmentMethoddefault string, full names etc (length 0-200)
distributionChanneldefault string, full names etc (length 0-200)
enturSearchOfferInput
Entur recommendation behavior control for Offers. If omitted, OMSA defaults to raw mode (recommendation-driven bundling disabled).
extendExpiryTimeInput
type^(?=.*(?:^(package))… · requiredpackageIddefault string, full names etc (length 0-200)
extensionReason^(purchase_pending|p…in case operation is EXTEND_EXPIRY_TIME, the reason for extension must be supplied here.
PURCHASE_PENDING - The internal purchase process on the MP side is not yet finished
PAYMENT_PENDING - The customer is in the payment process
OTHER - unspecified
organisationReference
organisationIddefault string, full names etc (length 0-200)
namedefault string, full names etc (length 0-200)
changeOptionCollection
type^(ChangeOptionCollec… · requiredactions that can be performed on this collection
numberMatchednumberReturnedrefundOptionCollection
type^(RefundOptionCollec… · requiredactions that can be performed on this package, but also alternative (rel=alternative+1, alternative+2) offers or references to other resources In case it is an alternative, specify clearly in the description what the financial consequences are.
numberMatchednumberReturnedenturRecommendationType
Entur Offers recommendation category.
organisationalParameter
idshort string, display names (length 0-75)
type^(organisational)$ · requirednamedefault string, full names etc (length 0-200)
legalNamedefault string, full names etc (length 0-200)
serviceJourneyReference
default string, full names etc (length 0-200)
spotReservationParameter
spotFor LUGGAGE_SPOT and VEHICLE_SPOT, supported values are: HANDBAG, HAND_LUGGAGE, SMALL_SUITCASE, SUITCASE, TRUNK, OVERSIZE_ITEM, BICYCLE, SPORTING_EQUIPMENT, SKIS, MUSICAL_INSTRUMENT, PUSH_CHAIR, MOTORIZED_WHEELCHAIR, LARGE_MOTORIZED_WHEELCHAIR, WHEELCHAIR, SMALL_ANIMAL, ANIMAL, GAME, MOTORCYCLE, OTHER, GUIDE_DOG. Unknown values are ignored. Use VEHICLE_SPOT for vehicles transported as cargo (e.g. motorcycle on a ferry). For PASSENGER_SPOT, the value is an operator-specific seat identifier and is not used for requirement mapping.
type^(spot_reservation)$ · requiredspotTypedeckdefault string, full names etc (length 0-200)
fuelmodeThese classes are taken from the NeTeX standard, but ALL and UNKNOWN are removed. On the other hand OTHER and PARKING are added.
spacedefault string, full names etc (length 0-200)
widthheightlengthweighttravelDocumentCollection
type^(TravelDocumentColl… · requiredactions that can be performed on this package, but also alternative (rel=alternative+1, alternative+2) offers or references to other resources In case it is an alternative, specify clearly in the description what the financial consequences are.
numberMatchednumberReturnedenturRecommendationControl
typesEntur recommendation categories to request when enabled is true.
If omitted, OMSA defaults to ["CHEAPEST", "NON_FLEXIBLE", "SEMI_FLEXIBLE", "FLEXIBLE"].
enabledEnable recommendation-driven bundling based on Offers recommendations and offersToBuy.
stripDuplicatesDeduplicate recommendation-driven plans by provider offer + traveller groups + ancillary selections + quantity.
updateTravelDocumentValidityInput
type^(?=.*(?:^(package))… · requiredpackageIddefault string, full names etc (length 0-200)
newStartTimeEither RFC3339 date-time (for example 2019-10-12T07:20:50Z) or the keyword NOW for server-side immediate start.
travelDocumentIdThe id of the travel document to update