Schemas latest | Entur for Developers

Leg

mode

Mode · enum · required

Travel mode for Leg.

Enum values:

AIR

BICYCLE

BUS

CABLEWAY

CAR

WATER

FUNICULAR

LIFT

subMode

SubMode · enum · required

The transport sub mode (e.g., localBus or expressBus) used when traversing this leg. Null if leg is not a ride

Enum values:

UNKNOWN

UNDEFINED

INTERNATIONAL_FLIGHT

DOMESTIC_FLIGHT

INTERCONTINENTAL_FLIGHT

DOMESTIC_SCHEDULED_FLIGHT

SHUTTLE_FLIGHT

INTERCONTINENTAL_CHARTER_FLIGHT

Example: LOCAL

Default: UNDEFINED

arrivalTime

string · date-time · required

StopPlace · required

departureTime

string · date-time · required

StopPlace · required

serviceJourneyRef

string · required

legId

string

datedServiceJourneyRef

string

Mode

string · enum

Enum values:

AIR

BICYCLE

BUS

CABLEWAY

CAR

WATER

FUNICULAR

LIFT

Travel mode for Leg.

Seat

id

integer · int64 · required

seatNumber

string · required

railcarNumber

string · required

externalSeatId

string · required

object

Properties of a seat. They describe both physical and logical properties of a seat.Physical properties are for example position of the seat.Logical properties describe properties that the operator use when selling the seat. For example fare class.

Email

EmailAddress[] · required

body

string · required

EmailAddress · required

subject

string · required

EmailAddress[]

EmailAddress

EmailAttachment[]

Group

id

string · required

UserProfileInGroup[] · required

A collection of all the different user profiles in the group.

Default: []

name

string

version

string

description

string

Price

amount

string · required

taxAmount

string · required

taxRate

string

currency

string

Parking

Parking data for a PARKING supplement product.

Vehicle[] · required

SubMode

string · enum

Enum values:

UNKNOWN

UNDEFINED

INTERNATIONAL_FLIGHT

DOMESTIC_FLIGHT

INTERCONTINENTAL_FLIGHT

DOMESTIC_SCHEDULED_FLIGHT

SHUTTLE_FLIGHT

INTERCONTINENTAL_CHARTER_FLIGHT

The transport sub mode (e.g., localBus or expressBus) used when traversing this leg. Null if leg is not a ride

Example: LOCAL

Default: UNDEFINED

Vehicle

A vehicle registered for a parking reservation.

licencePlateNumber

string · required

ApiError

path

string · required

error

string · required

title

string · required

Short, human-readable summary of the problem

status

integer · int32 · required

message

string · required

exception

string · required

timestamp

string · date-time · required

Customer

id

integer · int64 · required

The internal id of the customer

Example: 1

customerId

string · required

The id of the customer in the external system

Example: 12345678901

Entitlement[] · required

FareZone

Reference to fare zone with display name. Will eventually replace tariff zones.

id

string · required

name

string · required

Topology

distance

integer · int32

zoneType

string · enum

Enum values:

POINT_TO_POINT

RING

FareZone

Reference to fare zone with display name. Will eventually replace tariff zones.

toStopPlace

string

FareZone

Reference to fare zone with display name. Will eventually replace tariff zones.

FareZone[]

fromStopPlace

string

toStopPlaceExt

integer · int64

toStopPlaceName

string

fromStopPlaceExt

integer · int64

fromStopPlaceName

string

GroupOfTariffZone[]

datedServiceJourneyRef

string[]

Authority

id

string · required

PdfTicket

pdf

string · pattern: ^(?:[A-Za-z0-9+/]{4}… · required

orderId

string · required

deleteAt

string · date-time · required

orderLineId

string · required

orderVersion

integer · int32 · required

combinedTicket

boolean · required

orderLineVersion

integer · int32 · required

ticketDistributionId

integer · int64 · required

id

integer · int64

organisationId

integer · int64

StopPlace

ref

string · required

name

string

TariffZone

id

string · required

name

string · required

Entitlement

entitlementProductId

string · required

contractId

string

FareProduct

id

string · required

name

string

version

string

organisation

integer · int64

ValidableElement[]

Reservation

id

integer · int64 · required

Seat[] · required

externalReservationId

string · required

datedServiceJourneyId

string

UserProfile

id

string · required

name

string

version

string

Distribution

fareContractRef

string

Reference to an account-based-ticketing farecontract

customerAccountRef

string

Reference to an account-based-ticketing customer account

EmailAddress

email

string · required

name

string

LanguageCode

string · enum

Enum values:

nob

nno

eng

Desired language. Makes display text appear in defined language - if available. Default: nob

Default: nob

SalesPackage

id

string · required

name

string

version

string

EmailAttachment

content

string · required

filename

string · required

mimeType

string · required

disposition

string · enum

Enum values:

ATTACHMENT

INLINE

PageOfPdfTicket

Page displays a subset of a list of entities

PdfTicket[] · readOnly · required

Items on a specific page

totalItems

integer · int64 · readOnly · required

Total number of items

Example: 72

totalPages

integer · int64 · readOnly · required

Total number of pages available to browse

Example: 9

PaymentMeansType

string · enum

Enum values:

NULL

FREE

TPURSE

The payment means type used to purchase the ticket

ValidableElement

legIds

string[] · required

list of legIds that belong to this validableElement

elementId

string · required

The elementId as found on the validableElement. NOTE: This is NOT the same as validableElementRef.id

GroupOfTariffZone

Reference to a group of tariff zones with display name.

id

string · required

name

string · required

SupplementProduct

id

integer · int64 · required

Price · required

FareProduct · required

Parking

Parking data for a PARKING supplement product.

supplementType

string · enum

Type to indicate if for instance the product is some kind of passenger or just a seat allocation. Mirrors the supplement types defined in NeTEx and configured on supplement products in Entur Product catalog.

Enum values:

ANIMAL

BICYCLE

DOG

EVENT_ADD_ON

EXTRA_LUGGAGE

JOURNEY_ADD_ON

JOURNEY_EXTENSION

MEAL

datedServiceJourneyRefs

string[]

TicketDistribution

id

integer · int64 · required

Price · required

provider

integer · int32 · required

Topology · required

Authority · required

Customer[] · required

networkId

integer · int32 · required

tariffCode

integer · int32 · required

ticketType

string · enum · required

Enum values:

SINGLE

PERIODIC

purchaseDate

string · date-time · required

Reservation[] · required

endOfValidity

string · date-time · required

combinedTicket

boolean · required

loyaltyProgram

boolean · required

productTemplate

integer · int32 · required

startOfValidity

string · date-time · required

ticketWithZones

boolean · required

orderLineVersion

integer · int32 · required

distributionStatus

TicketDistributionStatus · enum · required

Enum values:

CREATED

DISTRIBUTED

CANCELLED

PICKED_UP

VALIDATED

EXPIRED

FAILED

ACTIVATED

SupplementProduct[] · required

Leg[]

Group

duration

string

createdAt

string · date-time

updatedAt

string · date-time

arrivalTime

string · date-time

FareProduct

UserProfile

deliverAfter

string · date-time

usageTrigger

string · enum

Enum values:

START_OF_PERIOD

START_OUT_BOUND_RIDE

END_OUT_BOUND_RIDE

START_RETURN_RIDE

PURCHASE

SPECIFIED_START_DATE

FULFILMENT

DAY_OFFSET_BEFORE_CALENDAR_PERIOD

departureTime

string · date-time

maxTravellers

integer · int32

fareContractId

string

fullAreaValidity

boolean

travelDocumentId

string

cancellationReason

string

reason for cancellation of the ticket distribution, Possible values: TRANSFERRED, DEVIATION, SEAT_CHANGED, VALIDITY_UPDATED

DistributionDetails

mediaSerialNumberId

integer · int64

TicketPdfTraveller

Travellers who will be written on the pdf-ticket

name

string · required

Full names of the traveller

ticketDistributionId

integer · int64 · required

TicketDistributionIds for this traveller

UserProfileInGroup

A representation of a user profile to summarize parts of a group product.

count

integer · required

The number of travellers with given user profile.

userProfileId

string · required

Reference to the product register.

name

string

Display name of user profile for requested language. Defaults to norwegian name.

userProfileVersion

string

DistributionDetails

clientSecret

string

orderGroupId

string

fareContractRef

string

Reference to an account-based-ticketing farecontract

distributedAsPdf

boolean

Is set to true if distributed as a PDF by ticket-distribution

customerAccountRef

string

Reference to an account-based-ticketing customer account

TicketPdfSendRequest

Request for generating and sending pdf-ticket by email

pdfLanguage

LanguageCode · enum · required

Desired language. Makes display text appear in defined language - if available. Default: nob

Enum values:

nob

nno

eng

Default: nob

orderVersion

integer · int32 · required

Desired version of the order that is going to be distributed as a pdf-ticket. Default: 1

Default: 1

email

string · required

Email-address for the receiver of pdf-ticket

TicketPdfTraveller[]

Array of names and ticketDistributionIds of travellers. These names will overwrite existing traveller names on the ticket if the order line does not include any entitlements.

Default: []

orderLineIds

string[]

List of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.

shouldGroupTravellers

boolean

Flag to indicate that PDF tickets are grouped together for travellers with the same journey.

Default: true

FailedValidityUpdates

errorMessage

string · required

ticketDistributionGroupId

integer · int64 · required

UpdateValidityRequest

startOfValidity

string · required

Format is DateTime. It is also possible to send in the keyword NOW to set the startOfValidity to the current time calculated by ticket-distribution

Example: NOW, 2020-01-01T00:00:00Z

ticketDistributionId

integer · int64 · required

ticketDistributionGroupId

integer · int64 · required

elementId

string

If set, startOfValidity will only be updated for this elementId. If not, startOfValidity will be updated for entire TicketDistribution

TicketPdfCreateRequest

Request for generating and sending pdf-ticket by email

pdfLanguage

LanguageCode · enum · required

Desired language. Makes display text appear in defined language - if available. Default: nob

Enum values:

nob

nno

eng

Default: nob

orderVersion

integer · int32 · required

Desired version of the order that is going to be distributed as a pdf-ticket. Default: 1

Default: 1

TicketPdfTraveller[]

Array of names and ticketDistributionIds of travellers. These names will overwrite existing traveller names on the ticket if the order line does not include any entitlements.

Default: []

orderLineIds

string[]

List of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.

shouldGroupTravellers

boolean

Flag to indicate that PDF tickets are grouped together for travellers with the same journey.

Default: true

TicketDistributionGroup

id

integer · int64 · required

orderId

string · required

orderLineId

string · required

orderVersion

integer · int32 · required

TicketDistribution[] · required

updatedForOrderLineVersion

integer · int32 · required

createdByDCI

string

SalesPackage

organisationId

integer · int64

distributedByDCI

string

fulfillmentMethod

string

The fulfillment method given by the order line. Useful for determining which external ticketing system to retrieve validation data from. Possible values: NOD, ACCOUNT_BASED_TICKETING, INTERNATIONAL, BIFROST

distributedByOrgId

integer · int64

orderOwnerCustomerId

string

The customerId of the customer that owns the order

distributionHolderCustomerId

string

The customerId of the customer that will receive the ticket

TicketTravelCardRequest

Request for generating ticket for travel card

activate

boolean · required

Activate the product

paymentMeansType

PaymentMeansType · enum · required

The payment means type used to purchase the ticket

Enum values:

NULL

FREE

TPURSE

mediaSerialNumberId

integer · int64 · min: 0 · max: 4294967295 · required

The media serial number (MSN) ID of the travel card

UpdateValiditiesRequest

UpdateValidityRequest[] · required

TicketDistributionStatus

string · enum

Enum values:

CREATED

DISTRIBUTED

CANCELLED

PICKED_UP

VALIDATED

EXPIRED

FAILED

ACTIVATED

UpdateValiditiesResponse

FailedValidityUpdates[] · required

SuccessfulValidityUpdates[] · required

SuccessfulValidityUpdates

ticketDistributionGroupId

integer · int64 · required

TicketDistributionSummary

orderId

string · required

The orderId of the ticket distribution summary

Distribution[] · required

List of distinct summaries of all ticket distributions of the ticket distribution groups for a given orderId. At least one of the fields in a distribution is non-null.

OrderLineDistributionRequest

Distribute a set of ticket distribution groups to NOD

orderLineId

string · required

ID of the order line

deliverAfter

string · date-time

The earliest time it should be possible to pick up the ticket. If specified then it will override the value from the parent

startOfValidity

string · date-time

The time when the ticket for this order line should become active. Will be specified by order data if not overridden here.

PageOfTicketDistributionGroup

Page displays a subset of a list of entities

TicketDistributionGroup[] · readOnly · required

Items on a specific page

totalItems

integer · int64 · readOnly · required

Total number of items

Example: 72

totalPages

integer · int64 · readOnly · required

Total number of pages available to browse

Example: 9

TicketDistributionGroupTransfer

toCustomerId

string · required

The customerId of the customer that will receive the ticket

Example: 123456789

ticketDistributionGroupId

integer · int64 · required

The id of the ticket distribution group to transfer to another customer

toCustomerAccountRef

string

Reference to an account-based-ticketing customer account

TransferDistributionHolderRequest

TicketDistributionGroupTransfer[] · required

TransferDistributionHolderResponse

FailedTicketDistributionGroupTransfer[] · required

SuccessfulTicketDistributionGroupTransfer[] · required

FailedTicketDistributionGroupTransfer

errorMessage

string · required

The error message that explains why the transfer failed

ticketDistributionGroupId

integer · int64 · required

The ticketDistributionGroupId of the ticket distribution group that failed to be transferred to another customer

TicketDistributionGroupDistributeRequest

Distribute a set of ticket distribution groups to NOD

orderId

string · required

ID of the order

orderVersion

integer · int32 · required

Version of the order

Default: 1

deliverAfter

string · date-time

The earliest time it should be possible to pick up the ticket(s)

languageCode

LanguageCode · enum

Desired language. Makes display text appear in defined language - if available. Default: nob

Enum values:

nob

nno

eng

Default: nob

qrChecksumType

integer · int32

The 'toughness' of the QR-code. If not specified the service will determine it automatically based on deliverAfter and startOfValidity

OrderLineDistributionRequest[]

List of specific orderlineIds to distribute tickets for. If not specified, all tickets for the order will be distributed.

SuccessfulTicketDistributionGroupTransfer

ticketDistributionGroupId

integer · int64 · required

The ticketDistributionGroupId of the ticket distribution group that was successfully transferred to another customer