Entur Developer
Sales v2
Sales v2

Schemas

Download schema

subscriber

Optional URIs for callbacks for this job. Support for this parameter is not required and the parameter may be removed from the API definition, if conformance class **'callback'** is not listed in the conformance declaration under `/conformance`.
successUri
​string · uri
inProgressUri
​string · uri
failedUri
​string · uri

confClasses

conformsTo
​string[] · required

searchOfferInput

A package planning request, resulting in package options
type
​string · pattern: ^(search_offer) · required
​object

Request-wide predicates that every returned offer must satisfy.

​object[]
packageToExchange
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​individualTraveller[] · minItems: 1 · maxItems: 10
​userProfile[] · minItems: 1
​travellingAsset[]

Entur-specific OMSA extensions for search-offers input.

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: travellers
type = object · requires: profiles
Properties for Variant 1:
​individualTraveller[] · minItems: 1 · maxItems: 10 · required
type
​string · pattern: ^(search_offer)
​object

Request-wide predicates that every returned offer must satisfy.

​object[]
packageToExchange
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​userProfile[] · minItems: 1
​travellingAsset[]

Entur-specific OMSA extensions for search-offers input.

enturSearchOfferInput

Entur-specific OMSA extensions for search-offers input.
​enturRecommendationControl

Entur recommendation behavior control for Offers. If omitted, the API defaults to raw mode (recommendation-driven bundling disabled).

enturRecommendationType

string · enum
Enum values:
FLEXIBLE
SEMI_FLEXIBLE
NON_FLEXIBLE
CHEAPEST

Entur Offers recommendation category.

enturRecommendationControl

Entur recommendation behavior control for Offers. If omitted, the API defaults to raw mode (recommendation-driven bundling disabled).
enabled
​boolean

Enable recommendation-driven bundling based on Offers recommendations and offersToBuy.

Default: false
types
​enturRecommendationType[] · minItems: 1

Entur recommendation categories to request when enabled is true. If omitted, the API defaults to ["CHEAPEST", "NON_FLEXIBLE", "SEMI_FLEXIBLE", "FLEXIBLE"].

Enum values:
FLEXIBLE
SEMI_FLEXIBLE
NON_FLEXIBLE
CHEAPEST
stripDuplicates
​boolean

Deduplicate recommendation-driven plans by provider offer + traveller groups + ancillary selections + quantity.

Default: false

selectOffersInput

offerIds
​normalString[] · required
type
​string · pattern: ^(select_offers) · required
​customerRef

Reference to an existing customer by id.

​customerRef

Reference to an existing customer by id.

externalReference
​normalString · maxLength: 200

default string, full names etc (length 0-200)

packageInput

packageId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

type
​string · pattern: ^(package) · required

legInput

packageId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

type
​string · required
legId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

offerId
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​placeReference

refundOptionInput

type
​string · pattern: ^(claim_refund_optio… · required
optionId
​uuid

https://en.wikipedia.org/wiki/Universally_unique_identifier see also https://www.ietf.org/rfc/rfc4122.txt (ae76f51c-a1a6-46af-b9ab-8233564adcae)

addTravellerInput

type
​string · pattern: ^(traveller)$ · required
packageId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

​individualTraveller

A generic description of a traveler, not including any identifying information

​userProfile
​travellingAsset

removeTravellerInput

type
​string · pattern: ^(traveller)$ · required
travellerId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

packageId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

updateTravellerInput

type
​string · pattern: ^(traveller)$ · required
packageId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

travellerId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

​individualTraveller

A generic description of a traveler, not including any identifying information

​userProfile
​travellingAsset

assetInput

packageId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

type
​string · pattern: ^(asset)$ · required
legId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

assetId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

offerId
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​placeReference
replaceAssetId
​normalString · maxLength: 200

default string, full names etc (length 0-200)

ancillaryInput

packageId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

type
​string · pattern: ^(ancillary)$ · required
legId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

​ancillaryReference · required
offerId
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​placeReference
​ancillaryReference

purchaseOffersInput

offerIds
​normalString[] · required
type
​string · pattern: ^(purchase_offers)$ · required
​customerRef

Reference to an existing customer by id.

​customerRef

Reference to an existing customer by id.

externalReference
​normalString · maxLength: 200

default string, full names etc (length 0-200)

extendExpiryTimeInput

packageId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

type
​string · pattern: ^(extend_expiry_time… · required
extensionReason
​string · pattern: ^(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

updateTravelDocumentValidityInput

packageId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

type
​string · pattern: ^(update_travel_docu… · required
travelDocumentId
​string · required

The id of the travel document to update

newStartTime
​dateTimeOrNow · required

Either RFC3339 date-time (for example 2019-10-12T07:20:50Z) or the keyword NOW for server-side immediate start.

updateTravelDocumentValidityResponse

previousTravelDocumentId
​string · required

The travel document id that was replaced

newTravelDocumentId
​string · required

The new travel document id with updated validity

basePoint

​number[] · minItems: 2 · maxItems: 2

geojsonPoint

Geojson Coordinate
coordinates
​number[] · minItems: 2 · maxItems: 2 · required

geojsonLine

An array of WGS84 coordinate pairs
coordinates
​basePoint[] · required

geojsonPolygon

geojson representation of a polygon. First and last point must be equal. See also https://geojson.org/geojson-spec.html#polygon and example https://geojson.org/geojson-spec.html#id4. The order should be lon, lat [[[lon1, lat1], [lon2,lat2], [lon3,lat3], [lon1,lat1]]], the first point should match the last point.
coordinates
​array[] · required

geojsonMultiPolygon

geojson representation of a multi polygon. See also https://geojson.org/geojson-spec.html#multipolygon
coordinates
​array[] · required

geojsonFeature

type
​string · pattern: ^(Feature)$ · required
​required
id
​shortString · maxLength: 75 · required

short string, display names (length 0-75)

​
​link[]

geojson

type
​string · pattern: ^(FeatureCollection)…
​geojsonFeature[]
properties
​object
​object
numberMatched
​integer
numberReturned
​integer
​link[]

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.

offerCollection

type
​string · pattern: ^(OfferCollection)$ · required
​offer[]
numberMatched
​integer
numberReturned
​integer
​link[]

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.

packageCollection

type
​string · enum · required
Enum values:
PackageCollection
​package[] · required
numberMatched
​integer

Total number of packages available (for pagination)

numberReturned
​integer

Number of packages in this response

​link[]

Actions that can be performed on this collection.

package

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions
type
​string · pattern: ^(package)$ · required
status
​packageStatus · enum · required

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.

Enum values:
OFFERED
SELECTED
PENDING
CONFIRMED
RELEASED
EXPIRED
CANCELLED
REFUND_CLAIMED
​amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

​offer[] · required
​placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

startTime
​dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime
​dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

​postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id
​string
externalReference
​normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees
​normalString[]
​array
​link[]

offer

​object · required
id
​shortString · maxLength: 75

short string, display names (length 0-75)

type
​string · pattern: ^(offer)$
​link[]

leg

A (planned) consumption of a product within a package
id
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

type
​string · pattern: ^(leg)$ · required
​placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

startTime
​dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime
​dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

sequenceNumber
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
traveller
​normalString · maxLength: 200

default string, full names etc (length 0-200)

state
​legState · enum

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)

Enum values:
NOT_STARTED
PREPARING
PREPARED
IN_USE
PAUSED
ENDED
ISSUE_REPORTED
CANCELLED

an amount of money, usable in fares, fare calculations or in extra costs.

products
​shortString[]

a reference to a product in the 'products' collection of the offer

ancillaries
​shortString[]

additional products that can be assigned to this leg, references to 'ancillaries' collection

usageValidityPeriods
​normalString[]

References to usage validity periods in the offer's usageValidityPeriods collection.

frequenciesOfUse
​normalString[]

References to frequency-of-use parameters in the offer's frequenciesOfUse collection.

mode
​mode · enum

These classes are taken from the NeTeX standard, but ALL and UNKNOWN are removed. On the other hand OTHER and PARKING are added.

Enum values:
AIR
BUS
TROLLEYBUS
TRAM
COACH
RAIL
INTERCITYRAIL
URBANRAIL

The physical asset(s) used for the execution of the leg

​reservationRequirement

usageValidityPeriod

id
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

type
​string · pattern: ^(usage_validity_per… · required
validityPeriodType
​usageValidityPeriodType · enum

NeTEx classification of a usage validity period.

Enum values:
SINGLE_RIDE
SINGLE_TRIP
RETURN_TRIP
CARNET
DAY_PASS
WEEKLY_PASS
WEEKEND_PASS
MONTHLY_PASS
usageTrigger
​usageTrigger · enum

Event that starts the usage validity period.

Enum values:
ENROLMENT
RESERVATION
PURCHASE
FULFILMENT
ACTIVATION
SPECIFIED_START_DATE
START_OUTBOUND_RIDE
END_OUTBOUND_RIDE
usageEnd
​usageEnd · enum

Event that ends the usage validity period.

Enum values:
STANDARD_DURATION
END_OF_CALENDAR_PERIOD
END_OF_RIDE
END_OF_TRIP
END_OF_FARE_DAY
END_OF_FARE_PERIOD
PRODUCT_EXPIRY
PROFILE_EXPIRY
standardDuration
​string · duration

Positive ISO 8601 duration of the usage validity period, for example PT168H.

activationMeans
​activationMeans · enum

Means used to activate the usage validity period.

Enum values:
NONE_REQUIRED
CHECK_IN
USE_OF_VALIDATOR
USE_OF_MOBILE_DEVICE
AUTOMATIC_BY_TIME
AUTOMATIC_BY_PROXIMITY
ACCESS_CODE
OTHER
startDate
​date · full-date

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)

startTime
​string · time
endDate
​date · full-date

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)

endTime
​string · time
usageStartConstraintType
​usageStartConstraintType · enum

Constraint applied to the start of the usage validity period.

Enum values:
VARIABLE
FIXED
FIXED_WINDOW
blackoutUse
​blackoutUse · enum

How the validity period interacts with blackout periods.

Enum values:
MAY_TRAVEL_ANYTIME
NO_TRAVEL_WITHIN_PERIOD
NO_TRAVEL_WITHIN_TIMEBAND
MAY_COMPLETE_IF_STARTED_BEFORE

usageValidityPeriodType

string · enum
Enum values:
SINGLE_RIDE
SINGLE_TRIP
RETURN_TRIP
CARNET
DAY_PASS
WEEKLY_PASS
WEEKEND_PASS
MONTHLY_PASS

NeTEx classification of a usage validity period.

usageTrigger

string · enum
Enum values:
ENROLMENT
RESERVATION
PURCHASE
FULFILMENT
ACTIVATION
SPECIFIED_START_DATE
START_OUTBOUND_RIDE
END_OUTBOUND_RIDE

Event that starts the usage validity period.

usageEnd

string · enum
Enum values:
STANDARD_DURATION
END_OF_CALENDAR_PERIOD
END_OF_RIDE
END_OF_TRIP
END_OF_FARE_DAY
END_OF_FARE_PERIOD
PRODUCT_EXPIRY
PROFILE_EXPIRY

Event that ends the usage validity period.

activationMeans

string · enum
Enum values:
NONE_REQUIRED
CHECK_IN
USE_OF_VALIDATOR
USE_OF_MOBILE_DEVICE
AUTOMATIC_BY_TIME
AUTOMATIC_BY_PROXIMITY
ACCESS_CODE
OTHER

Means used to activate the usage validity period.

usageStartConstraintType

string · enum
Enum values:
VARIABLE
FIXED
FIXED_WINDOW

Constraint applied to the start of the usage validity period.

blackoutUse

string · enum
Enum values:
MAY_TRAVEL_ANYTIME
NO_TRAVEL_WITHIN_PERIOD
NO_TRAVEL_WITHIN_TIMEBAND
MAY_COMPLETE_IF_STARTED_BEFORE

How the validity period interacts with blackout periods.

frequencyOfUse

id
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

type
​string · pattern: ^(frequency_of_use)$ · required
frequencyOfUseType
​frequencyOfUseType · enum

NeTEx classification of a frequency-of-use parameter.

Enum values:
NONE
UNLIMITED
LIMITED
TWICE_A_DAY
SINGLE
minimalFrequency
​integer · min: 0

Minimum number of times the product can be used.

maximalFrequency
​integer · min: 0

Maximum number of times the product can be used.

frequencyInterval
​string · duration

Positive ISO 8601 interval within which frequency is measured.

frequencyOfUseType

string · enum
Enum values:
NONE
UNLIMITED
LIMITED
TWICE_A_DAY
SINGLE

NeTEx classification of a frequency-of-use parameter.

product

type
​string · pattern: ^(product)$
​productReference
productName
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​guarantee[]

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.

Service characteristics covered by this product, such as service journey, class of use, asset, or accommodation.

​reservationRequirement[]

Reservation rules carried by this product.

tripPattern

​object[]
serviceJourney
​normalString · maxLength: 200

default string, full names etc (length 0-200)

date
​date · full-date

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)

travelSpecification

​placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

startTime
​dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime
​dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

travelDocument

startvalidity
​dateTime · date-time · required

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endvalidity
​dateTime · date-time · required

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

format
​travelDocumentFormat · enum · required

how the travel document is presented to the traveller

Enum values:
LINK
BARCODE
QRCODE
AZTECCODE
AXA_EKEY_OTP
BLUETOOTH
NFC
PHYSICAL_KEY
status
​travelDocumentStatus · enum

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

Enum values:
PENDING
ACTIVE
FAILED
EXPIRED
CANCELLED

travelDocumentFormat

string · enum
Enum values:
LINK
BARCODE
QRCODE
AZTECCODE
AXA_EKEY_OTP
BLUETOOTH
NFC
PHYSICAL_KEY

how the travel document is presented to the traveller

mode

string · enum
Enum values:
AIR
BUS
TROLLEYBUS
TRAM
COACH
RAIL
INTERCITYRAIL
URBANRAIL

These classes are taken from the NeTeX standard, but ALL and UNKNOWN are removed. On the other hand OTHER and PARKING are added.

classOfUse

string · enum
Enum values:
FIRST_CLASS
SECOND_CLASS
THIRD_CLASS
ECONOMY_CLASS
BUSINESS_CLASS
TURISTA
PREFERENTE
PREMIUM_CLASS

A classification of fare and other service classes by category of user entitled to use them. Use ECONOMY_CLASS for standard class products.

berthType

string · enum
Enum values:
SLEEPER
COUCHETTE
SEAT
OTHER

individualTraveller

A generic description of a traveler, not including any identifying information
type
​string · pattern: ^(individual_travell… · required
id
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

​object
isValidated
​boolean

Whether this traveler's identity and properties have been verified by the MaaS provider

age
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
gender
​string · enum
Enum values:
M
F
X
U
fullName
​normalString · maxLength: 200

default string, full names etc (length 0-200)

customerReference
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​customProperties · maxProps: 20

dictionary for extra fields (bilatural agreements)

travelParty

type
​string
​object

travelPartyRequirements

​organisationalParameter[]
​spotReservationParameter[]

searchOfferFilter

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object
type = object · requires: organisationId
Properties for Variant 1:
Service characteristics that every returned offer must satisfy.
serviceFilter
type
​string · pattern: ^(service)$ · required
productId
​normalString · maxLength: 200

default string, full names etc (length 0-200)

serviceJourney
​normalString · maxLength: 200

default string, full names etc (length 0-200)

class
​classOfUse · enum

A classification of fare and other service classes by category of user entitled to use them. Use ECONOMY_CLASS for standard class products.

Enum values:
FIRST_CLASS
SECOND_CLASS
THIRD_CLASS
ECONOMY_CLASS
BUSINESS_CLASS
TURISTA
PREFERENTE
PREMIUM_CLASS
berthTypes
​berthType[] · minItems: 1 · unique
Enum values:
SLEEPER
COUCHETTE
SEAT
OTHER

serviceFilter

Service characteristics that every returned offer must satisfy.
type
​string · pattern: ^(service)$ · required
productId
​normalString · maxLength: 200

default string, full names etc (length 0-200)

serviceJourney
​normalString · maxLength: 200

default string, full names etc (length 0-200)

class
​classOfUse · enum

A classification of fare and other service classes by category of user entitled to use them. Use ECONOMY_CLASS for standard class products.

Enum values:
FIRST_CLASS
SECOND_CLASS
THIRD_CLASS
ECONOMY_CLASS
BUSINESS_CLASS
TURISTA
PREFERENTE
PREMIUM_CLASS
berthTypes
​berthType[] · minItems: 1 · unique
Enum values:
SLEEPER
COUCHETTE
SEAT
OTHER

organisationalFilter

Organisation or operator that every returned offer must reference.
type
​string · pattern: ^(organisational)$ · required
organisationId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

postalAddress

address parts, where addressLine1 and 2 should contain the complete address, matches Content-Language
addressLine1
​longString · maxLength: 10000 · required

long string, memos etc (length 0-10.000)

addressLine2
​longString · maxLength: 10000 · required

long string, memos etc (length 0-10.000)

​placeReference
street
​normalString · maxLength: 200

default string, full names etc (length 0-200)

houseNumber
​normalInt · min: 0 · max: 1000

default length for an integer (0-1000)

Default: 0
houseNumberAddition
​tinyString · maxLength: 10

real short string, codes (length 0-10)

postalCode
​shortString · maxLength: 75

short string, display names (length 0-75)

city
​shortString · maxLength: 75

short string, display names (length 0-75)

province
​shortString · maxLength: 75

short string, display names (length 0-75)

state
​shortString · maxLength: 75

short string, display names (length 0-75)

country
​country · minLength: 2 · maxLength: 2 · pattern: [A-Z]{2}

two-letter country codes according to ISO 3166-1

additionalInfo
​longString · maxLength: 10000

long string, memos etc (length 0-10.000)

packageStatus

string · enum
Enum values:
OFFERED
SELECTED
PENDING
CONFIRMED
RELEASED
EXPIRED
CANCELLED
REFUND_CLAIMED

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.

travelDocumentStatus

string · enum
Enum values:
PENDING
ACTIVE
FAILED
EXPIRED
CANCELLED

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

legState

string · enum
Enum values:
NOT_STARTED
PREPARING
PREPARED
IN_USE
PAUSED
ENDED
ISSUE_REPORTED
CANCELLED

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)

travellingAsset

type
​string · pattern: ^(asset)$ · required
id
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

userProfile

type
​string · pattern: ^(user_profile)$ · required
id
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

​object
count
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
minimumAge
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
maximumAge
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
monthDayOnWhichAgeApplies
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
ageGroup
​string · enum
Enum values:
ANYONE
INFANT
CHILD
YOUTH
ADULT
SENIOR
minimumHeight
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
maximumHeight
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
localResident
​boolean
genderLimitation
​boolean

commercialProfile

type
​string · pattern: ^(commercial_profile… · required
id
​shortString · maxLength: 75

short string, display names (length 0-75)

code
​shortString · maxLength: 75

short string, display names (length 0-75)

name
​normalString · maxLength: 200

default string, full names etc (length 0-200)

entitlementGiven

type
​string · pattern: ^(entitlement)$ · required
entitlementType
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

id
​shortString · maxLength: 75

short string, display names (length 0-75)

equipmentParameter

type
​string · pattern: ^(equipment)$ · required
name
​shortString · maxLength: 75

short string, display names (length 0-75)

description
​longString · maxLength: 10000

long string, memos etc (length 0-10.000)

infoLink
​url · uri

valid URL

image
​url · uri

valid URL

temporalParameter

type
​string · pattern: ^(temporal)$ · required
startTime
​dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime
​dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

duration
​normalInt · min: 0 · max: 1000

default length for an integer (0-1000)

Default: 0
dayType
​day · enum
Enum values:
MON
TUE
WED
THU
FRI
SAT
SUN

spotReservationParameter

type
​string · pattern: ^(spot_reservation)$ · required
spotType
​string · enum · required
Enum values:
VEHICLE_SPOT
PASSENGER_SPOT
LUGGAGE_SPOT
spot
​string · maxLength: 200 · required

For 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.

deck
​normalString · maxLength: 200

default string, full names etc (length 0-200)

space
​normalString · maxLength: 200

default string, full names etc (length 0-200)

width
​number
length
​number
height
​number
fuel
​string
weight
​string
mode
​mode · enum

These classes are taken from the NeTeX standard, but ALL and UNKNOWN are removed. On the other hand OTHER and PARKING are added.

Enum values:
AIR
BUS
TROLLEYBUS
TRAM
COACH
RAIL
INTERCITYRAIL
URBANRAIL

reservationRequirement

type
​string · pattern: ^(reservation_requir… · required
spotType
​string · enum · required

The kind of spot the reservation rule applies to.

Enum values:
VEHICLE_SPOT
PASSENGER_SPOT
LUGGAGE_SPOT
reservationPolicy
​reservationPolicy · enum · required

Reservation policy used by clients to decide whether reservation UI is hidden, optional, recommended, or required.

Enum values:
NOT_POSSIBLE
OPTIONAL
RECOMMENDED
COMPULSORY
sourceReservationPolicy
​string

Raw reservation policy from the upstream provider, when available.

assetSelection
​assetSelection · enum

Whether a concrete asset, such as a seat, can be selected manually, assigned automatically, or is not available for this reservation.

Enum values:
NOT_AVAILABLE
AUTO_ASSIGNED
MANUAL_AVAILABLE
serviceJourney
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​ancillaryReference[]

Ancillaries that can fulfill this reservation requirement when reservation is sold as a separate product.

reservationPolicy

string · enum
Enum values:
NOT_POSSIBLE
OPTIONAL
RECOMMENDED
COMPULSORY

Reservation policy used by clients to decide whether reservation UI is hidden, optional, recommended, or required.

assetSelection

string · enum
Enum values:
NOT_AVAILABLE
AUTO_ASSIGNED
MANUAL_AVAILABLE

Whether a concrete asset, such as a seat, can be selected manually, assigned automatically, or is not available for this reservation.

networkParameter

type
​string · pattern: ^(network)$ · required
​placeReference
line
​normalString · maxLength: 200

default string, full names etc (length 0-200)

routingParameter

type
​string · pattern: ^(routing)$ · required
journeyPattern
​normalString[] · required

serviceParameter

type
​string · pattern: ^(service)$ · required
asset
​normalString · maxLength: 200

default string, full names etc (length 0-200)

serviceJourney
​normalString · maxLength: 200

default string, full names etc (length 0-200)

class
​classOfUse · enum

A classification of fare and other service classes by category of user entitled to use them. Use ECONOMY_CLASS for standard class products.

Enum values:
FIRST_CLASS
SECOND_CLASS
THIRD_CLASS
ECONOMY_CLASS
BUSINESS_CLASS
TURISTA
PREFERENTE
PREMIUM_CLASS
​onboardStay[]
​accommodation[]

onboardStay

Permission to board early before the journey or stay on board after the journey.
type
​string · pattern: ^(onboard_stay)$ · required
description
​longString · maxLength: 10000

long string, memos etc (length 0-10.000)

classOfUse
​classOfUse · enum

A classification of fare and other service classes by category of user entitled to use them. Use ECONOMY_CLASS for standard class products.

Enum values:
FIRST_CLASS
SECOND_CLASS
THIRD_CLASS
ECONOMY_CLASS
BUSINESS_CLASS
TURISTA
PREFERENTE
PREMIUM_CLASS
permission
​boolean
duration
​shortString · maxLength: 75

short string, display names (length 0-75)

accommodation

A combination of accommodation characteristics available on a service, e.g. "First Class Couchette with shower and 2 bunks".
type
​string · pattern: ^(accommodation)$
description
​longString · maxLength: 10000

long string, memos etc (length 0-10.000)

classOfUse
​classOfUse · enum

A classification of fare and other service classes by category of user entitled to use them. Use ECONOMY_CLASS for standard class products.

Enum values:
FIRST_CLASS
SECOND_CLASS
THIRD_CLASS
ECONOMY_CLASS
BUSINESS_CLASS
TURISTA
PREFERENTE
PREMIUM_CLASS
name
​shortString · maxLength: 75

short string, display names (length 0-75)

gender
​string · enum
Enum values:
M
F
X
U
berthType
​berthType · enum
Enum values:
SLEEPER
COUCHETTE
SEAT
OTHER
nuisanceFacility
​shortString[]

distributionParameter

type
​string · pattern: ^(distribution)$ · required
fulfilmentMethod
​normalString · maxLength: 200

default string, full names etc (length 0-200)

distributionChannel
​normalString · maxLength: 200

default string, full names etc (length 0-200)

organisationalParameter

id
​shortString · maxLength: 75 · required

short string, display names (length 0-75)

type
​string · pattern: ^(organisational)$ · required
name
​normalString · maxLength: 200

default string, full names etc (length 0-200)

legalName
​normalString · maxLength: 200

default string, full names etc (length 0-200)

cancellationParameter

conditions regarding cancellation of a purchased package
type
​string · pattern: ^(cancel)$ · required
cancellationAllowed
​boolean

is it possible to cancel this package?

​amountOfMoney

an amount of money, usable in fares, fare calculations or in extra costs.

cancellationFeePercentage
​number · min: 0 · max: 100

percentage of the offered price you have to pay when you cancel this purchased package

purchaseParameter

specify required information to complete a purchase
type
​string · pattern: ^(purchase)$ · required
maximumPeriodBeforeDeparture
​longInt · min: 0

long number, for distances etc. (>1.000)

Default: 0
​licenseType[] · maxItems: 5

ONE of these licenses is required to operate the asset

card

Any kind of card that isn't a license, only provide the cards that are required
type
​string · pattern: ^(card)$ · required
cardNumber
​shortString · maxLength: 75 · required

short string, display names (length 0-75)

​cardType

A generic description of a CARD

description
​shortString · maxLength: 75

short string, display names (length 0-75)

additionalNumber
​shortString · maxLength: 75

short string, display names (length 0-75)

endValidity
​date · full-date

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)

country
​country · minLength: 2 · maxLength: 2 · pattern: [A-Z]{2}

two-letter country codes according to ISO 3166-1

cardType

A generic description of a CARD
id
​shortString · maxLength: 75 · required

short string, display names (length 0-75)

type
​string · pattern: ^(card_type)$ · required
cardCategory
​string · enum

The 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

Enum values:
DISCOUNT
TRAVEL
BANK
CREDIT
ID
PASSPORT
OTHER
subCategory
​shortString · maxLength: 75

short string, display names (length 0-75)

​productReference
​organisationReference[] · maxItems: 15

references to accepting parties, only if applicable

​customProperties · maxProps: 20

dictionary for extra fields (bilatural agreements)

license

driver or usage license for a specific user. Contains the number and the assetType you're allowed to operate (e.g. driver license for CAR)
type
​string · pattern: ^(license)$ · required
​licenseType

A category of license to use a certain asset class

licenseNumber
​shortString · maxLength: 75

short string, display names (length 0-75)

endValidity
​date · full-date

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)

licenseType

A category of license to use a certain asset class
type
​string · pattern: ^(license_type)$ · required
modes
​mode[]
Enum values:
AIR
BUS
TROLLEYBUS
TRAM
COACH
RAIL
INTERCITYRAIL
URBANRAIL
licenseCode
​shortString · maxLength: 75

short string, display names (length 0-75)

issuingCountry
​country · minLength: 2 · maxLength: 2 · pattern: [A-Z]{2}

two-letter country codes according to ISO 3166-1

​customProperties · maxProps: 20

dictionary for extra fields (bilatural agreements)

guarantee

id
​shortString · maxLength: 75

short string, display names (length 0-75)

type
​normalString · maxLength: 200

default string, full names etc (length 0-200)

amountOfMoney

an amount of money, usable in fares, fare calculations or in extra costs.
amount
​number · float · required

This 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

taxPercentageUsed
​float · float · min: 0

the travelled distance. Only if applicable.

currencyCode
​currencyCode · minLength: 3 · maxLength: 3 · pattern: [a-zA-Z]{3}

ISO 4217 currency code

vatCountryCode
​country · minLength: 2 · maxLength: 2 · pattern: [A-Z]{2}

two-letter country codes according to ISO 3166-1

ancillaryCollection

type
​string · pattern: ^(AncillaryCollectio… · required
​object[]
numberMatched
​integer
numberReturned
​integer
​link[]

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.

changeOptionCollection

type
​string · pattern: ^(ChangeOptionCollec… · required
​object[]
numberMatched
​integer
numberReturned
​integer
​link[]

actions that can be performed on this collection

refundOptionCollection

type
​string · pattern: ^(RefundOptionCollec… · required
​object[]
numberMatched
​integer
numberReturned
​integer
​link[]

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.

travelDocumentCollection

type
​string · pattern: ^(TravelDocumentColl… · required
​object[]
numberMatched
​integer
numberReturned
​integer
​link[]

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.

ancillary

ancillaryId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

name
​normalString · maxLength: 200

default string, full names etc (length 0-200)

type
​string · pattern: ^(ancillary)$

an amount of money, usable in fares, fare calculations or in extra costs.

description
​string

A user-friendly description of the ancillary (e.g. 'Reserved seat for bike').

available
​integer

Number of items available in stock (inventory). Useful for creating urgency in GUI.

Service characteristics covered by this ancillary, such as service journey, class of use, asset, or accommodation.

​reservationRequirement[]

Reservation rules carried by this ancillary.

​link[]

seat

type
​string · pattern: ^(seat)$
id
​normalString · maxLength: 200

default string, full names etc (length 0-200)

deck
​shortString · maxLength: 75

short string, display names (length 0-75)

space
​shortString · maxLength: 75

short string, display names (length 0-75)

row
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
seatNumber
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
facing
​string · enum
Enum values:
FRONT
REAR
LEFT
RIGHT
OTHER
byWindow
​boolean
legSpace
​shortInt · min: 0 · max: 100

a bit short integer (0-100)

Default: 0
byAisle
​boolean
hasArmRest
​boolean
hasTray
​boolean
hasAirco
​boolean
hasEnergySupply
​boolean
hasLight
​boolean

asset

the asset that can by applied to execute a leg.
type
​string · pattern: ^(asset)$
id
​normalString · maxLength: 200

default string, full names etc (length 0-200)

visualId
​shortString · maxLength: 75

short string, display names (length 0-75)

mode
​mode · enum

These classes are taken from the NeTeX standard, but ALL and UNKNOWN are removed. On the other hand OTHER and PARKING are added.

Enum values:
AIR
BUS
TROLLEYBUS
TRAM
COACH
RAIL
INTERCITYRAIL
URBANRAIL
subMode
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​equipmentReference[] · maxItems: 100

list of external references

changeOption

type
​string · pattern: ^(change_option)$
id
​string
changeType
​string · enum
Enum values:
REMOVE_TRAVELLER
ADD_TRAVELLER
UPDATE_TRAVELLER
ASSIGN_ASSET
REMOVE_ASSET
ASSIGN_ANCILLARY
REMOVE_ANCILLARY
CANCEL_PACKAGE
​financialDetail[]

refundOption

type
​string · pattern: ^(refund_option)$
id
​uuid

https://en.wikipedia.org/wiki/Universally_unique_identifier see also https://www.ietf.org/rfc/rfc4122.txt (ae76f51c-a1a6-46af-b9ab-8233564adcae)

packageState
​packageStatus · enum

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.

Enum values:
OFFERED
SELECTED
PENDING
CONFIRMED
RELEASED
EXPIRED
CANCELLED
REFUND_CLAIMED
refundType
​string · enum
Enum values:
PACKAGE_REFUND
REMOVE_TRAVELLER
REMOVE_ANCILLARY
​financialDetail[]

country

string · minLength: 2 · maxLength: 2 · pattern: [A-Z]{2}

two-letter country codes according to ISO 3166-1

currencyCode

string · minLength: 3 · maxLength: 3 · pattern: [a-zA-Z]{3}

ISO 4217 currency code

customProperties

dictionary for extra fields (bilatural agreements)

placeDefinitions

​postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

binaryTicket

Binary information, like a image or certificate
startvalidity
​dateTime · date-time · required

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endvalidity
​dateTime · date-time · required

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

format
​travelDocumentFormat · enum · required

how the travel document is presented to the traveller

Enum values:
LINK
BARCODE
QRCODE
AZTECCODE
AXA_EKEY_OTP
BLUETOOTH
NFC
PHYSICAL_KEY
type
​string · pattern: ^(binary_ticket)$ · required
contentType
​string · required

the media type (IANA)

base64
​longString · maxLength: 10000 · required

long string, memos etc (length 0-10.000)

status
​travelDocumentStatus · enum

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

Enum values:
PENDING
ACTIVE
FAILED
EXPIRED
CANCELLED
version
​tinyString · maxLength: 10

real short string, codes (length 0-10)

externalTicket

External ticket, can be accessed using the links collection, with rel=ticket
startvalidity
​dateTime · date-time · required

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endvalidity
​dateTime · date-time · required

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

format
​travelDocumentFormat · enum · required

how the travel document is presented to the traveller

Enum values:
LINK
BARCODE
QRCODE
AZTECCODE
AXA_EKEY_OTP
BLUETOOTH
NFC
PHYSICAL_KEY
type
​string · pattern: ^(external_ticket)$ · required
status
​travelDocumentStatus · enum

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

Enum values:
PENDING
ACTIVE
FAILED
EXPIRED
CANCELLED

pendingTicket

A travel document that exists but whose content (e.g. QR code) is not yet available. Typically for future tickets where the start of validity has not yet begun.
startvalidity
​dateTime · date-time · required

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endvalidity
​dateTime · date-time · required

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

format
​travelDocumentFormat · enum · required

how the travel document is presented to the traveller

Enum values:
LINK
BARCODE
QRCODE
AZTECCODE
AXA_EKEY_OTP
BLUETOOTH
NFC
PHYSICAL_KEY
type
​string · pattern: ^(pending_ticket)$ · required
status
​travelDocumentStatus · enum

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

Enum values:
PENDING
ACTIVE
FAILED
EXPIRED
CANCELLED

financialDetail

​amountOfMoney

an amount of money, usable in fares, fare calculations or in extra costs.

package
​normalString · maxLength: 200

default string, full names etc (length 0-200)

offer
​normalString · maxLength: 200

default string, full names etc (length 0-200)

leg
​normalString · maxLength: 200

default string, full names etc (length 0-200)

category
​paymentCategory · enum

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
Enum values:
ALL
DAMAGE
LOSS
STOLEN
EXTRA_USAGE
REFUND
REBATE
REIMBURSEMENT
expirationDate
​dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

​customProperties · maxProps: 20

dictionary for extra fields (bilatural agreements)

paymentCategory

string · enum
Enum values:
ALL
DAMAGE
LOSS
STOLEN
EXTRA_USAGE
REFUND
REBATE
REIMBURSEMENT

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

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

organisationReference

organisationId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

name
​normalString · maxLength: 200

default string, full names etc (length 0-200)

placeReference

placeId
​string · maxLength: 200 · pattern: ^(GPS:|NSR:StopPlace… · required

this 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.

name
​normalString · maxLength: 200

default string, full names etc (length 0-200)

customerInput

Customer details supplied when creating or replacing a customer. The id is the Entur customer number, assigned by the Entur Customer Profiles service, and must not be set here.
firstName
​shortString · maxLength: 75 · required

short string, display names (length 0-75)

lastName
​shortString · maxLength: 75 · required

short string, display names (length 0-75)

initials
​tinyString · maxLength: 10

real short string, codes (length 0-10)

middleName
​shortString · maxLength: 75

short string, display names (length 0-75)

prefix
​tinyString · maxLength: 10

real short string, codes (length 0-10)

postfix
​tinyString · maxLength: 10

real short string, codes (length 0-10)

email
​normalString · maxLength: 200

default string, full names etc (length 0-200)

phoneNumber
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​postalAddress

address parts, where addressLine1 and 2 should contain the complete address, matches Content-Language

dateOfBirth
​date · full-date

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)

placeOfBirth
​shortString · maxLength: 75

short string, display names (length 0-75)

countryOfBirth
​country · minLength: 2 · maxLength: 2 · pattern: [A-Z]{2}

two-letter country codes according to ISO 3166-1

​customProperties · maxProps: 20

dictionary for extra fields (bilatural agreements)

externalReference
​string · minLength: 1 · maxLength: 40

The client's own reference for this customer, unique within the organisation. Must not be blank. Leading and trailing whitespace is trimmed. Defaults to the customer number when not set. Can only be set when the customer is created. On replace it must be omitted or equal to the stored value. Use id, not this value, when referring to the customer elsewhere in the API.

customer

A customer record returned by the API.
firstName
​shortString · maxLength: 75 · required

short string, display names (length 0-75)

lastName
​shortString · maxLength: 75 · required

short string, display names (length 0-75)

id
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

initials
​tinyString · maxLength: 10

real short string, codes (length 0-10)

middleName
​shortString · maxLength: 75

short string, display names (length 0-75)

prefix
​tinyString · maxLength: 10

real short string, codes (length 0-10)

postfix
​tinyString · maxLength: 10

real short string, codes (length 0-10)

email
​normalString · maxLength: 200

default string, full names etc (length 0-200)

phoneNumber
​normalString · maxLength: 200

default string, full names etc (length 0-200)

​postalAddress

address parts, where addressLine1 and 2 should contain the complete address, matches Content-Language

dateOfBirth
​date · full-date

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)

placeOfBirth
​shortString · maxLength: 75

short string, display names (length 0-75)

countryOfBirth
​country · minLength: 2 · maxLength: 2 · pattern: [A-Z]{2}

two-letter country codes according to ISO 3166-1

​customProperties · maxProps: 20

dictionary for extra fields (bilatural agreements)

externalReference
​string · minLength: 1 · maxLength: 40

The client's own reference for this customer, unique within the organisation. Must not be blank. Leading and trailing whitespace is trimmed. Defaults to the customer number when not set. Can only be set when the customer is created. On replace it must be omitted or equal to the stored value. Use id, not this value, when referring to the customer elsewhere in the API.

customerRef

Reference to an existing customer by id.
id
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

customerCollection

type
​string · enum · required
Enum values:
CustomerCollection
​customer[]
numberMatched
​integer
numberReturned
​integer
​link[]

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.

customerReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

travellerReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

userProfileReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

productReference

productId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

name
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

offerReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

packageReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

legReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

usageValidityPeriodReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

frequencyOfUseReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

lineReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

zoneReference

zoneId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

name
​normalString · maxLength: 200

default string, full names etc (length 0-200)

assetReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

ancillaryReference

ancillaryId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

name
​normalString · maxLength: 200

default string, full names etc (length 0-200)

equipmentReference

equipmentId
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

name
​normalString · maxLength: 200

default string, full names etc (length 0-200)

serviceJourneyReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

userNeedReference

id
​normalString · maxLength: 200 · required

default string, full names etc (length 0-200)

name
​normalString · maxLength: 200

default string, full names etc (length 0-200)

error

JSON schema for exceptions based on RFC 7807
type
​url · uri · required

valid URL

title
​shortString · maxLength: 75 · required

short string, display names (length 0-75)

status
​httpStatus · min: 100 · max: 599 · required

HTTP status code (100–599)

detail
​longString · maxLength: 10000 · required

long string, memos etc (length 0-10.000)

code
​string · required

Stable machine-readable problem code.

category
​string · enum · required

Public problem category used by curated problems.

Enum values:
authorization
validation
downstream
state
resource
availability
server
hint
​string · required

Short client-facing remediation hint.

instance
​url · uri

valid URL

​link[]
​object

Safe structured context fields for the problem.

landingPage

​link[] · required
title
​string
description
​string
attribution
​string

The 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.

collections

​link[] · required
​collectionInfo[] · required
timeStamp
​string · date-time
numberMatched
​integer · min: 0
numberReturned
​integer · min: 0

collectionInfo

id
​string · required

identifier of the collection used, for example, in URIs

Example: dem
​link[] · required
title
​string

human readable title of the collection

Example: Digital Elevation Model
description
​string

a description of the data in the collection

Example: A Digital Elevation Model.
extent
​object
itemType
​string

indicator about the type of the items in the collection if the collection has an accessible /collections/{collectionId}/items endpoint

Default: unknown
crs
​string[]

the list of coordinate reference systems supported by the API; the first item is the default coordinate reference system

Example: ["http://www.opengis.net/def/crs/OGC/1.3/CRS84","http://www.opengis.net/def/crs/EPSG/0/4326"]
Default: ["http://www.opengis.net/def/crs/OGC/1.3/CRS84"]
​dataType
geometryDimension
​integer · min: 0 · max: 3

The geometry dimension of the features shown in this layer (0: points, 1: curves, 2: surfaces, 3: solids), unspecified: mixed or unknown

minScaleDenominator
​number

Minimum scale denominator for usage of the collection

maxScaleDenominator
​number

Maximum scale denominator for usage of the collection

minCellSize
​number

Minimum cell size for usage of the collection

maxCellSize
​number

Maximum cell size for usage of the collection

dataType

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = string
type = string
Properties for Variant 1:
string

processList

​processSummary[] · required
​link[] · required

processSummary

id
​string · required
version
​string · required
title
​string
description
​string
keywords
​string[]
​metadata[]
jobControlOptions
​jobControlOptions[]
Enum values:
sync-execute
async-execute
dismiss
​link[]

jobControlOptions

string · enum
Enum values:
sync-execute
async-execute
dismiss

descriptionType

title
​string
description
​string
keywords
​string[]
​metadata[]

metadata

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: href, rel
type = object
Properties for Variant 1:
rel
​string · required

the 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)

href
​url · uri · required

valid URL

type
​shortString · maxLength: 75

short string, display names (length 0-75)

method
​string · enum

to indicate the http method.

Enum values:
POST
GET
PUT
DELETE
PATCH
description
​string

the description of the external data source

body
​object

the (prefilled) body for the request

​object
isMandatory
​boolean

is this link informative, or must it be used?

hash
​string

to validate that the content of the link hasn't been changed.

link

rel
​string · required

the 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)

href
​url · uri · required

valid URL

type
​shortString · maxLength: 75

short string, display names (length 0-75)

method
​string · enum

to indicate the http method.

Enum values:
POST
GET
PUT
DELETE
PATCH
description
​string

the description of the external data source

body
​object

the (prefilled) body for the request

​object
isMandatory
​boolean

is this link informative, or must it be used?

hash
​string

to validate that the content of the link hasn't been changed.

date

string · full-date

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, full-date (2019-10-12)

dateTime

string · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

dateTimeOrNow

string

Either RFC3339 date-time (for example 2019-10-12T07:20:50Z) or the keyword NOW for server-side immediate start.

day

string · enum
Enum values:
MON
TUE
WED
THU
FRI
SAT
SUN

float

number · float · min: 0

the travelled distance. Only if applicable.

longInt

integer · min: 0

long number, for distances etc. (>1.000)

Default: 0

longString

string · maxLength: 10000

long string, memos etc (length 0-10.000)

normalInt

integer · min: 0 · max: 1000

default length for an integer (0-1000)

Default: 0

normalString

string · maxLength: 200

default string, full names etc (length 0-200)

shortInt

integer · min: 0 · max: 100

a bit short integer (0-100)

Default: 0

shortString

string · maxLength: 75

short string, display names (length 0-75)

tinyInt

integer · min: 0 · max: 10

for really small numbers (0-10)

Default: 0

httpStatus

integer · min: 100 · max: 599

HTTP status code (100–599)

tinyString

string · maxLength: 10

real short string, codes (length 0-10)

url

string · uri

valid URL

uuid

string

https://en.wikipedia.org/wiki/Universally_unique_identifier see also https://www.ietf.org/rfc/rfc4122.txt (ae76f51c-a1a6-46af-b9ab-8233564adcae)

Did you find what you were looking for?