Schemas
PdfTicket
combinedTicketdeleteAtorderIdorderLineIdorderLineVersionorderVersionpdf^(?:[A-Za-z0-9+/]{4}… · requiredticketDistributionIdidorganisationIdPageOfPdfTicket
Items on a specific page
totalItemsTotal number of items
totalPagesTotal number of pages available to browse
ApiError
timestampstatustitleShort, human-readable summary of the problem
errorexceptionmessagepathTicketPdfTraveller
ticketDistributionIdTicketDistributionIds for this traveller
nameFull names of the traveller
LanguageCode
Desired language. Makes display text appear in defined language - if available. Default: nob
TicketPdfCreateRequest
pdfLanguageDesired language. Makes display text appear in defined language - if available. Default: nob
orderVersionDesired version of the order that is going to be distributed as a pdf-ticket. Default: 1
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.
shouldGroupTravellersFlag to indicate that PDF tickets are grouped together for travellers with the same journey.
orderLineIdsList of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.
TicketPdfSendRequest
pdfLanguageDesired language. Makes display text appear in defined language - if available. Default: nob
orderVersionDesired version of the order that is going to be distributed as a pdf-ticket. Default: 1
emailEmail-address for the receiver of pdf-ticket
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.
shouldGroupTravellersFlag to indicate that PDF tickets are grouped together for travellers with the same journey.
orderLineIdsList of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.
EmailAttachment
contentfilenamemimeTypedispositionCustomer
customerIdThe id of the customer in the external system
idThe internal id of the customer
DistributionDetails
clientSecretorderGroupIdfareContractRefReference to an account-based-ticketing farecontract
customerAccountRefReference to an account-based-ticketing customer account
distributedAsPdfIs set to true if distributed as a PDF by ticket-distribution
TicketDistributionStatus
ValidableElement
elementIdThe elementId as found on the validableElement. NOTE: This is NOT the same as validableElementRef.id
legIdslist of legIds that belong to this validableElement
UserProfileInGroup
userProfileIdReference to the product register.
countThe number of travellers with given user profile.
userProfileVersionnameDisplay name of user profile for requested language. Defaults to norwegian name.
Group
idA collection of all the different user profiles in the group.
descriptionnameversionuserProfilesDeprecated in favour of new type userProfileSummary.
Seat
externalSeatIdidrailcarNumberseatNumberProperties 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.
seatCodeDeprecated. Better use the more flexible types in seatingProperties which mirrors the properties from seating manager.
seatTypeDeprecated. Better use the more flexible types in seatingProperties which mirrors the properties from seating manager.
Parking
SupplementProduct
datedServiceJourneyRefssupplementTypeType 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.
Parking data for a PARKING supplement product.
GroupOfTariffZone
idnameFareZone
idnameTopology
datedServiceJourneyRefdistancefromStopPlacefromStopPlaceExtfromStopPlaceNametoStopPlacetoStopPlaceExttoStopPlaceNamezoneTypeReference to fare zone with display name. Will eventually replace tariff zones.
Reference to fare zone with display name. Will eventually replace tariff zones.
fromTariffZonefromTariffZoneExtfromTariffZoneNametoTariffZonetoTariffZoneExttoTariffZoneNameSubMode
The transport sub mode (e.g., localBus or expressBus) used when traversing this leg. Null if leg is not a ride
Leg
arrivalTimedepartureTimemodeTravel mode for Leg.
subModeThe transport sub mode (e.g., localBus or expressBus) used when traversing this leg. Null if leg is not a ride
serviceJourneyRefdatedServiceJourneyReflegIdTicketDistribution
combinedTicketdistributionStatusendOfValidityidloyaltyProgramnetworkIdorderLineVersionproductTemplateproviderpurchaseDatestartOfValiditytariffCodeticketTypeticketWithZonesarrivalTimecreatedAtdeliverAfterdepartureTimedurationfareContractIdfullAreaValiditymaxTravellersmediaSerialNumberIdtravelDocumentIdupdatedAtusageTriggercancellationReasonreason for cancellation of the ticket distribution, Possible values: TRANSFERRED, DEVIATION, SEAT_CHANGED, VALIDITY_UPDATED
TicketDistributionGroup
idorderIdorderLineIdorderVersionupdatedForOrderLineVersioncreatedByDCIdistributedByDCIdistributedByOrgIdorganisationIdfulfillmentMethodThe 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
orderOwnerCustomerIdThe customerId of the customer that owns the order
distributionHolderCustomerIdThe customerId of the customer that will receive the ticket
PageOfTicketDistributionGroup
Items on a specific page
totalItemsTotal number of items
totalPagesTotal number of pages available to browse
OrderLineDistributionRequest
orderLineIdID of the order line
startOfValidityThe time when the ticket for this order line should become active. Will be specified by order data if not overridden here.
deliverAfterThe earliest time it should be possible to pick up the ticket. If specified then it will override the value from the parent
TicketDistributionGroupDistributeRequest
orderIdID of the order
orderVersionVersion of the order
deliverAfterThe earliest time it should be possible to pick up the ticket(s)
List of specific orderlineIds to distribute tickets for. If not specified, all tickets for the order will be distributed.
qrChecksumTypeThe 'toughness' of the QR-code. If not specified the service will determine it automatically based on deliverAfter and startOfValidity
languageCodeDesired language. Makes display text appear in defined language - if available. Default: nob
Distribution
customerAccountRefReference to an account-based-ticketing customer account
fareContractRefReference to an account-based-ticketing farecontract
TicketDistributionSummary
orderIdThe orderId of the ticket distribution summary
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.
TicketDistributionGroupTransfer
ticketDistributionGroupIdThe id of the ticket distribution group to transfer to another customer
toCustomerIdThe customerId of the customer that will receive the ticket
toCustomerAccountRefReference to an account-based-ticketing customer account
TransferDistributionHolderRequest
SuccessfulTicketDistributionGroupTransfer
ticketDistributionGroupIdThe ticketDistributionGroupId of the ticket distribution group that was successfully transferred to another customer
FailedTicketDistributionGroupTransfer
ticketDistributionGroupIdThe ticketDistributionGroupId of the ticket distribution group that failed to be transferred to another customer
errorMessageThe error message that explains why the transfer failed
TransferDistributionHolderResponse
UpdateValidityRequest
ticketDistributionGroupIdticketDistributionIdstartOfValidityFormat is DateTime. It is also possible to send in the keyword NOW to set the startOfValidity to the current time calculated by ticket-distribution
elementIdIf set, startOfValidity will only be updated for this elementId. If not, startOfValidity will be updated for entire TicketDistribution
UpdateValiditiesRequest
FailedValidityUpdates
ticketDistributionGroupIderrorMessageUpdateValiditiesResponse
PaymentMeansType
The payment means type used to purchase the ticket
TicketTravelCardRequest
activateActivate the product
mediaSerialNumberIdThe media serial number (MSN) ID of the travel card
paymentMeansTypeThe payment means type used to purchase the ticket