OJPFareRequestOJPFareRequestStructureOJPFareDeliveryOJPFareDeliveryStructureOJPPlaceInformationRequestOJPPlaceInformationRequestStructureOJPPlaceInformationDeliveryOJPPlaceInformationDeliveryStructureOJPExchangePointsRequestOJPExchangePointsRequestStructureOJPExchangePointsDeliveryOJPExchangePointsDeliveryStructureOJPStopEventRequestOJPStopEventRequestStructureOJPStopEventDeliveryOJPStopEventDeliveryStructureOJPTripInfoRequestOJPTripInfoRequestStructureOJPTripInfoDeliveryOJPTripInfoDeliveryStructureOJPTripRequestOJPTripRequestStructureOJPTripDeliveryOJPTripDeliveryStructureOJPMultiPointTripRequestOJPMultiPointTripRequestStructureOJPMultiPointTripDeliveryOJPMultiPointTripDeliveryStructureOJPTripRefineRequestOJPTripRefineRequestStructureOJPTripRefineDeliveryOJPTripRefineDeliveryStructureOJPAvailabilityRequestOJPAvailabilityRequestStructureOJPAvailabilityDeliveryOJPAvailabilityDeliveryStructureOJPLineInformationRequestOJPLineInformationRequestStructureOJPLineInformationDeliveryOJPLineInformationDeliveryStructureMessageIntegrityPropertiesGroup groupServiceRequestContextGroup groupServiceResponseContextGroup groupSubscriptionRequestContextGroup groupAbstractOJPServiceRequestStructureAbstractOJPSubscriptionRequestStructureDeliveryRequestGroup groupStatusRequestGroup groupTerminateSubscriptionRequestServiceResponseGroup groupPlacesStructureOperators_RelStructureResponseContextStructureOJPGenericProblemStructureOJPFareRequestOJPFareRequestStructureOJPFareDeliveryOJPFareDeliveryStructureOJPLocationInformationRequestOJPLocationInformationRequestStructureOJPLocationInformationDeliveryOJPLocationInformationDeliveryStructureOJPExchangePointsRequestOJPExchangePointsRequestStructureOJPExchangePointsDeliveryOJPExchangePointsDeliveryStructureOJPStopEventRequestOJPStopEventRequestStructureOJPStopEventDeliveryOJPStopEventDeliveryStructureOJPTripInfoRequestOJPTripInfoRequestStructureOJPTripInfoDeliveryOJPTripInfoDeliveryStructureOJPTripRequestOJPTripRequestStructureOJPTripDeliveryOJPTripDeliveryStructureOJPMultiPointTripRequestOJPMultiPointTripRequestStructureOJPMultiPointTripDeliveryOJPMultiPointTripDeliveryStructureOJPTripRefineRequestOJPTripRefineRequestStructureOJPTripRefineDeliveryOJPTripRefineDeliveryStructureOJPAvailabilityRequestOJPAvailabilityRequestStructureOJPAvailabilityDeliveryOJPAvailabilityDeliveryStructureOJPLineInformationRequestOJPLineInformationRequestStructureOJPLineInformationDeliveryOJPLineInformationDeliveryStructureMessageIntegrityPropertiesGroup groupServiceRequestContextGroup groupServiceResponseContextGroup groupAbstractOJPServiceRequestStructurePlacesStructureOperators_RelStructureResponseContextStructureOJPGenericProblemStructureFareRequestGroup groupStopFareRequestStructureStaticFareRequestStructureTripFareRequestStructureMultiTripFareRequestStructureFareResponseGroup groupFareResultStructureStopFareResultStructureStaticFareResultStructureTripFareProductReferenceStructureMultiTripFareResultStructureFareAuthorityRefStructureFareAuthorityRefFareAuthorityGroup groupTariffZoneRefStructureTariffZoneRefTariffZoneStructureTariffZoneListInAreaStructureTariffZoneRefListStructureContactDetailsStructureBookingMethodListOfEnumerationsPurchaseMomentListOfEnumerationsBookingProcessListOfEnumerationsGroupBookingListOfEnumerationsBookingArrangementsStructureBookingArrangementsGroup groupBookingArrangementsContainerStructureFareProductRefStructureFareProductRefEntitlementProductListStructureEntitlementProductStructureFareProductStructureFareProductPriceGroup groupFareProductValidityGroup groupFareProductBookingGroup groupTripLegRangeGroup groupTripFareResultStructureFarePassengerStructureFareDataFilterGroup groupFareParamStructureFareProblemStructurePlaceInformationRequestGroup groupPlaceInformationResponseGroup groupInitialPlaceInputStructurePlaceParamStructureGeoRestrictionsStructureGeoCircleStructureGeoRectangleStructureGeoAreaStructurePlaceResultStructurePlacePolicyGroup groupPlaceDataFilterGroup groupPlaceSortingGroup groupExchangePointsRequestGroup groupExchangePointsParamStructureExchangePointsDataFilterGroup groupExchangePointsPolicyGroup groupExchangePointsResponseGroup groupExchangePointsResultStructureStopPointGroup groupStopPointStructureStopPlaceRefStructureStopPlaceRefStopPlaceGroup groupStopPlaceStructureStopAttributesGroup groupTopographicPlaceRefStructureTopographicPlaceRefTopographicPlaceStructurePointOfInterestRefStructurePointOfInterestRefPointOfInterestStructurePointOfInterestCategoryStructureOsmTagStructurePointOfInterestFilterStructureAddressRefStructureAddressRefAddressDetailGroup groupAddressStructurePlaceStructurePlaceRefStructureLocationProblemStructureExchangePointProblemStructureFareAuthorityRefStructureFareAuthorityRefFareAuthorityGroup groupTariffZoneRefStructureTariffZoneRefTariffZoneStructureTariffZoneListInAreaStructureTariffZoneRefListStructureContactDetailsStructureBookingMethodListOfEnumerationsPurchaseMomentListOfEnumerationsBookingProcessListOfEnumerationsGroupBookingListOfEnumerationsBookingArrangementsStructureBookingArrangementsGroup groupBookingArrangementsContainerStructureFareProductRefStructureFareProductRefEntitlementProductListStructureEntitlementProductStructureFareProductStructureFareProductPriceGroup groupFareProductValidityGroup groupFareProductBookingGroup groupLegRangeGroup groupTripFareResultStructureFarePassengerStructureFareDataFilterGroup groupFareParamStructureFareProblemStructureLocationInformationRequestGroup groupLocationInformationResponseGroup groupInitialLocationInputStructurePlaceParamStructureGeoRestrictionsStructureGeoCircleStructureGeoRectangleStructureGeoAreaStructurePlaceResultStructurePlacePolicyGroup groupPlaceDataFilterGroup groupPlaceSortingGroup groupExchangePointsRequestGroup groupExchangePointsParamStructureExchangePointsDataFilterGroup groupExchangePointsPolicyGroup groupExchangePointsResponseGroup groupExchangePointsResultStructureStopPointGroup groupStopPointStructureStopPlaceRefStructureStopPlaceRefStopPlaceGroup groupStopPlaceStructureStopAttributesGroup groupTopographicPlaceRefStructureTopographicPlaceRefTopographicPlaceStructurePointOfInterestRefStructurePointOfInterestRefPointOfInterestStructurePointOfInterestCategoryStructurePointOfInterestAdditionalInformationStructureCategoryKeyValueTypeOsmTagStructurePointOfInterestFilterStructureAddressRefStructureAddressRefAddressDetailGroup groupAddressStructurePlaceStructurePlaceRefStructureLocationProblemStructureExchangePointsProblemStructureStopEventRequestGroup groupStopEventParamStructureStopEventDataFilterGroup groupStopEventPolicyGroup groupStopEventContentFilterGroup groupStopEventResponseGroup groupStopEventResultStructureStopEventStructureCallAtNearStopStructureStopEventProblemStructureTripInfoRequestGroup groupTripInfoParamStructureTripInfoPolicyGroup groupTripInfoContentFilterGroup groupTripInfoResponseGroup groupTripInfoResultStructureTripInfoProblemStructureTripRequestGroup groupTripParamStructureTripDataFilterGroup groupTripPolicyGroup groupTripMobilityFilterGroup groupTripContentFilterGroup groupOptimisationMethodListNotViaStructureNoChangeAtStructureTariffzoneFilterStructureTripResponseGroup groupTripResultStructureTripSummaryStructureTripStructureTripLegStructureTimedLegStructureTransferLegStructureContinuousLegStructureLegBoardStructureLegAlightStructureLegIntermediateStructurePathGuidanceStructurePathGuidanceSectionStructureFollowStructureTransferDurationGroup groupPathLinkStructurePathLinkEndStructureMultiPointTripRequestGroup groupMultiPointTripParamStructureMultiPointTripPolicyGroup groupMultiPointTripResponseGroup groupMultiPointTripResultStructureMultiPointWaitTimeGroup groupTripStatusGroup groupTripRefineRequestGroup groupTripRefinementDataFilterGroup groupTripRefineParamStructureTripRefineResponseGroup groupTripProblemStructureServiceViaPointStructureProductCategoryStructureTripViaStructureScheduledJourneyGroup groupServiceGroup groupServiceOriginGroup groupServiceDestinationGroup groupRouteDescriptionGroup groupDatedJourneyGroup groupPrivateServiceGroup groupDatedJourneyStructureTripPlaceStructureTimeWindowGroup groupServiceTimeGroup groupEstimatedTimeBandGroup groupServiceArrivalStructureServiceDepartureStructureCallAtStopStructureStopCallStatusGroup groupServiceStatusGroup groupContinuousServiceStructureVehiclePositionStructurePlaceContextStructureNumberOfResultsGroup groupBaseTripPolicyGroup groupBaseTripMobilityFilterGroup groupBaseTripContentFilterGroup groupLegAttributeStructureLegTrackStructureTrackSectionStructureTripRequestGroup groupTripParamStructureTripDataFilterGroup groupTripPolicyGroup groupTripMobilityFilterGroup groupTripContentFilterGroup groupOptimisationMethodListNotViaStructureNoChangeAtStructureTariffzoneFilterStructureTripResponseGroup groupTripResultStructureTripSummaryStructureTripStructureLegStructureTimedLegStructureTransferLegStructureContinuousLegStructureLegBoardStructureLegAlightStructureLegIntermediateStructurePathGuidanceStructurePathGuidanceSectionStructureFollowStructureTransferDurationGroup groupPathLinkStructurePathLinkEndStructureMultiPointTripRequestGroup groupMultiPointTripParamStructureMultiPointTripPolicyGroup groupMultiPointTripResponseGroup groupMultiPointTripResultStructureMultiPointWaitTimeGroup groupTripStatusGroup groupTripRefineRequestGroup groupTripRefinementDataFilterGroup groupTripRefineParamStructureTripRefineResponseGroup groupTripProblemStructureServiceViaPointStructureProductCategoryStructureTripViaStructureScheduledJourneyGroup groupServiceGroup groupServiceOriginGroup groupServiceDestinationGroup groupRouteDescriptionGroup groupDatedJourneyGroup groupPrivateServiceGroup groupDatedJourneyStructureTripLocationStructureTimeWindowGroup groupServiceTimeGroup groupEstimatedTimeBandGroup groupServiceArrivalStructureServiceDepartureStructureCallAtStopStructureStopCallStatusGroup groupServiceStatusGroup groupContinuousServiceStructureVehiclePositionStructurePlaceContextStructureNumberOfResultsGroup groupBaseTripPolicyGroup groupBaseTripMobilityFilterGroup groupBaseTripContentFilterGroup groupLegAttributeStructureLegTrackStructureTrackSectionStructureAvailabilityRequestGroup groupBookingPTLegStructureBookingUserStructureProvisionedCallAtPlaceStructureMinMaxTimeBandGroup groupPassengerProfileGroup groupPassengerRequirementsGroup groupDriverAssistanceGroup groupAvailabilityResponseGroup groupAvailabilityResultStructureBookableTicketAndServiceInformationGroup groupBookableServiceItemStructureAvailabilityProblemStructureProblemDetailGroup groupPrivateCodeStructureLinearShapeStructureAreaStructureParticipantRefOperatorRefOperatorRefs_RelStructureOperatorFilterStructureProductCategoryRefStructureProductCategoryRefLineDirectionFilterStructureJourneyRefStructureJourneyRefDatedJourneyRefGroup groupTimedVehicleRefGroup groupVehicleFilterStructureSharingServiceUsageGroup groupSharingServiceStructureOwnerRefStructureOwnerRefOperatingDayRefStructureOperatingDayRefOperatingDaysStructureOperatingDaysGroup groupWeekdayTimePeriodStructureGeneralAttributeStructureSustainabilityGroup groupFareResult
0:*
Fare result choice element.
→siri:Extensions
0:1
→siri:Extensions
OJPPlaceInformationRequest
| +OJPPlaceInformationRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
OJPPlaceInformationRequestStructure
| |||||
OJPLocationInformationRequest
| +OJPLocationInformationRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
OJPLocationInformationRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
| PlaceInformationRequest | a |
| -1:1 | Initial input for the place information request. This input defines what is originally looked for. | |
b |
| -1:1 | Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here. | ||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
| LocationInformationRequest | a |
| -1:1 | Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs. | |
b |
| -1:1 | LOCATION / PLACE for further refinement. If a Place in a previous response was marked as not "complete" it can be refined by putting it here. If Places are organised hierarchically it may be reasonable to identify the Place in a top-down approach with several steps of refining a Place on each level of hierarchy. Following this approach an initial request retrieves a first list of top-level Places (e.g. streets) which are to be refined in a subsequent request to the next level (e.g. house number intervals). The objects of the current level are presented to the user for selection. The object reference of the selected object is then sent in the next request for further refinement. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
| 0:1 | →siri:Extensions | |||
| 0:1 | →siri:Extensions | |||
OJPPlaceInformationDelivery
| +OJPPlaceInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
OJPPlaceInformationDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
OJPLocationInformationDelivery
| +OJPLocationInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
OJPLocationInformationDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
The element contains a sequence of the following elements: | |||||
0:1 | |||||
The element contains a sequence of the following elements: | |||||
0:1 | |||||
| ServiceResponseContext |
| 0:1 | siri:DataFrameRefStructure | identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems. | |
| 0:1 | Calculation time. | |||
| 0:* | OJP generic problem for the whole delivery. | |||
| PlaceInformationResponse |
| 0:1 | Context to hold response objects that occur frequently. | ||
| LocationInformationResponse |
| 0:1 | Context to hold response objects that occur frequently. | ||
| 0:1 | xs:nonNegativeInteger | If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. | ||
| 0:* | ||||
| 0:1 | →siri:Extensions | |||
| 0:* | The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best. | |||
| 0:1 | →siri:Extensions | |||
OJPExchangePointsRequest
| +OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
OJPExchangePointsRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| ExchangePointsRequest |
| 0:1 | Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
| ExchangePointsRequest |
| 0:1 | Location/Place for which exchange points to other "neighbour" systems are to be searched. This location/place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned. | ||
| 0:1 | E.g. location/place types (stops, addresses, POIs) or specific location/place attributes | |||
| 0:1 | →siri:Extensions | |||
OJPExchangePointsDelivery
| +OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
OJPExchangePointsDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
| 0:1 | Calculation time. | |||
| 0:* | OJP generic problem for the whole delivery. | |||
| ExchangePointsResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| ExchangePointsResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:1 | xs:nonNegativeInteger | If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. | ||
| 0:* | ||||
| 0:* | The exchange points found by the service. | |||
| 0:1 | →siri:Extensions | |||
OJPStopEventRequest
| +OJPStopEventRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
OJPStopEventRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| StopEventRequest |
| 1:1 | Place for which to obtain stop event information. | ||
| StopEventRequest |
| 1:1 | LOCATION / PLACE for which to obtain stop event information. | ||
| 0:1 | Request parameter | |||
| 0:1 | →siri:Extensions | |||
| DatedJourneyRef | a | 1:1 | Reference to a Journey | ||
a | 1:1 | Reference to an Operating Day | |||
| TimedVehicleRef | b |
| 1:1 | →siri:VehicleRef | |
| TimedVehicleRef | b |
| 1:1 | →siri:VehicleRef | Reference to vehicle. |
b |
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | |
| TripInfoRequest |
| 0:1 | Request parameter. | ||
Then, the element contains one of the following elements: | |||||
| AvailabilityRequest | a |
| -1:1 | Definition of the journey leg to be covered by public transport. Other mobility services can be added later. | |
| 1:* | Passenger(s) for whom the service needs to be booked, one MobilityUser per passenger. | |||
| MinMaxTimeBand |
| 0:1 | xs:dateTime | ||
| 0:1 | xs:dateTime | |||
| MinMaxTimeBand |
| 0:1 | xs:dateTime | Earliest possible departure time from start location. | |
| 0:1 | xs:dateTime | Latest possible arrival time at destination location. | ||
| AvailabilityRequest |
| 0:1 | xs:anyType | ||
| 0:1 | →siri:Extensions | |||
| 0:1 | Calculation time. | |||
| 0:* | OJP generic problem for the whole delivery. | |||
| AvailabilityResponse |
| 0:1 | Indication of the availability of the requested service. | ||
| AvailabilityResponse |
| 0:1 | Context to hold availability response objects that occur frequently. | ||
| 0:1 | Indication of the availability of the requested service. | |||
| 0:1 | xs:anyType | |||
| 0:1 | →siri:Extensions | |||
| ServiceResponseContext |
| 0:1 | siri:DataFrameRefStructure | identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems. | |
| 0:1 | Calculation time. | |||
| 0:* | OJP generic problem for the whole delivery. | |||
SubscriptionRequestContextGroup group
| Generic context for all subscription requests. | ||||
| SubscriptionRequestContext |
| 0:1 | siri:DataFrameRefStructure | identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems. | |
| 0:* | xs:language | Preferred language in which to return text values. | ||
| MessageIntegrityProperties |
| 0:1 | Authorisation signature (data for transmission of message signatures (public key cryptography), used to prove Message Integrity). | ||
| 0:1 | form of identification that can be used as a Message Integrity Property (public key cryptography) | |||
| SubscriptionRequestContext |
| 0:1 | xs:anyType | ||
AbstractOJPServiceRequestStructure
| siri:AbstractFunctionalServiceRequestStructure | Basic request structure common for all OJP service requests. | |||
AbstractOJPServiceRequestStructure
| siri:AbstractFunctionalServiceRequestStructure | Basic request structure common for all OJP service requests. | |||
| ServiceRequestContext |
| 0:1 | siri:DataFrameRefStructure | identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems. | |
| 0:1 | xs:anyType | |||
AbstractOJPSubscriptionRequestStructure
| siri:AbstractSubscriptionRequestStructure | Basic structure common for all OJP subscription requests. | |||
| SubscriptionRequestContext |
| 0:1 | siri:DataFrameRefStructure | identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems. | |
| 0:* | xs:language | Preferred language in which to return text values. | ||
| MessageIntegrityProperties |
| 0:1 | Authorisation signature (data for transmission of message signatures (public key cryptography), used to prove Message Integrity). | ||
| 0:1 | form of identification that can be used as a Message Integrity Property (public key cryptography) | |||
| SubscriptionRequestContext |
| 0:1 | xs:anyType | ||
DeliveryRequestGroup group
| Wrapper for SIRI delivery request group. | ||||
| |||||
StatusRequestGroup group
| Wrapper for SIRI status request group. | ||||
| |||||
TerminateSubscriptionRequest
| siri:TerminateSubscriptionRequestStructure | Request element for terminating subscriptions (from SIRI). | |||
ServiceResponseGroup group
| Wrapper for SIRI service response group. | ||||
| |||||
PlacesStructure
| Structure providing a collection of places. | ||||
The element contains only one element: | |||||
| 1:* | ||||
Operators_RelStructure
| Structure providing a collection of operators. | ||||
The element contains only one element: | |||||
| 1:* | siri:AffectedOperatorStructure | Operator of the service. | ||
ResponseContextStructure
| Structure providing response contexts related to journeys, containing collections of places and situations. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Container for OPERATOR objects. Only operator objects that are referenced in the response should be put into the container. | |||
| 0:1 | Container for place objects. Only place objects that are referenced in the response should be put into the container. | |||
| 0:1 | Container for SIRI SX situation objects. Only situations that are referenced in the response should be put into the container. | |||
OJPGenericProblemStructure
| Problem that may be returned in case of generic problems with the request. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the generic problem. | |||
PlacesStructure
| Structure providing a collection of places. | ||||
The element contains only one element: | |||||
| 1:* | ||||
Operators_RelStructure
| Structure providing a collection of operators. | ||||
The element contains only one element: | |||||
| 1:* | siri:AffectedOperatorStructure | Operator of the service. | ||
ResponseContextStructure
| Structure providing response contexts related to journeys, containing collections of places and situations. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Container for OPERATOR objects. Only operator objects that are referenced in the response should be put into the container. | |||
| 0:1 | Container for place objects. Only place objects that are referenced in the response should be put into the container. | |||
| 0:1 | Container for SIRI SX situation objects. Only situations that are referenced in the response should be put into the container. | |||
OJPGenericProblemStructure
| Problem that may be returned in case of generic problems with the request. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the generic problem. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
| Fare request structure. | ||||
The element contains one of the following elements: | |||||
| FareRequest | a |
| -1:1 | A request to calculate aggregated Fare information of multiple single trips | |
b |
| -1:1 | A request for general/static Fare information. | ||
c |
| -1:1 | A request for stop-related Fare information. | ||
d |
| -1:1 | A request to calculate the Fare information of a single trip | ||
| 0:1 | Parameter to filter the response contents. | |||
StopFareRequestStructure
| Sub-request: stop-related fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | →siri:StopPointRef | |||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
StaticFareRequestStructure
| General Fare information. May depend on date. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
0:* | Reference to a FareProduct. | ||||
TripFareRequestStructure
| Structure of a Single Trip Fare Request. | ||||
The element contains only one element: | |||||
| 1:1 | +Trip | A complete trip from origin to destination | ||
MultiTripFareRequestStructure
| Structure of a Multi Trip Fare Request. | ||||
The element contains only one element: | |||||
| 1:* | +Trip | Multiple complete trips from multiple origins and multiple destination | ||
FareResponseGroup group
| |||||
StopFareRequestStructure
| Sub-request: stop-related fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | →siri:StopPointRef | Reference to the stop point. | ||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
StaticFareRequestStructure
| General Fare information. May depend on date. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
0:* | Reference to a FareProduct. | ||||
TripFareRequestStructure
| Structure of a Single Trip Fare Request. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Context to hold trip related objects that occur frequently. Especially necessary, when the system answering the fare request is not the same as the one that did the trip request. | |||
| 1:1 | +Trip | A complete trip from origin to destination | ||
MultiTripFareRequestStructure
| Structure of a Multi Trip Fare Request. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Context to hold trip related objects that occur frequently. | |||
| 1:* | +Trip | Multiple complete trips from multiple origins and multiple destination | ||
FareResponseGroup group
| |||||
| FareResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | Fare result choice element. | |||
FareResultStructure
| Wrapper element for Fare results. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | ID of this result. | ||
| 0:* | Problems related to this FARE result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Fare and FareProducts for multiple trips. | ||
b |
| -1:1 | Static Fare information. | ||
c |
| -1:1 | Stop-related Fare information. | ||
d |
| -1:* | Fare and FareProducts for a given trip. | ||
StopFareResultStructure
| Stop-related Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | One or more lists of Fare zones that belong to a Fare authority/area. | |||
| 0:1 | xs:anyType | |||
StaticFareResultStructure
| General Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information. | |||
| 0:* | URL to information page on the web. | |||
| 0:1 | xs:anyType | |||
TripFareProductReferenceStructure
| Element that connects FareProducts to trips. A TripFareProduct is a FAREPRODUCT covering a part or the whole of a TRIP from boarding the first public transport vehicle to alighting from the last public transport vehicle (corresponds to a package of PREASSIGNED FARE PRODUCTs) | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to a FareProduct. | ||||
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid from" tripLeg. If missing, then valid from the first leg. | ||
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid to" tripLeg. If missing, then valid to the last leg. | ||
MultiTripFareResultStructure
| Structure of a Multi Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | Non-empty list of trip references in the corresponding MultiTripFareRequestStructure | |||
| 0:* | Zero, one or more FareProducts that are valid for the referenced trips / part of trips. | |||
| 0:1 | The set of passed zones. | |||
| 0:* | URL to Fare information pages on the web. | |||
FareResultStructure
| Wrapper element for Fare results. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this result. | |||
| 0:* | Problems related to this FARE result. | |||
| 0:1 | xs:boolean | Whether the fare is only estimated by the service. Estimated can mean different things: For example, the fare may vary depending on age, PassengerCategory, TravelClass, EntitlementProducts. It can also mean that the fare structure used by the service is not entirely accurate or that other factors, such as the time a shared vehicle is used, need to be factored into the price. As a rule, the price should then be given as an approximate and probably lower limit of the actual price. Default is TRUE. | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Fare and FareProducts for multiple trips. | ||
b |
| -1:1 | Static Fare information. | ||
c |
| -1:1 | Stop-related Fare information. | ||
d |
| -1:* | Fare and FareProducts for a given trip. | ||
StopFareResultStructure
| Stop-related Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | One or more lists of Fare zones that belong to a Fare authority/area. | |||
| 0:1 | xs:anyType | |||
StaticFareResultStructure
| General Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information. | |||
| 0:* | URL to information page on the web. | |||
| 0:1 | xs:anyType | |||
TripFareProductReferenceStructure
| Element that connects FareProducts to trips. A TripFareProduct is a FAREPRODUCT covering a part or the whole of a TRIP from boarding the first public transport vehicle to alighting from the last public transport vehicle (corresponds to a package of PREASSIGNED FARE PRODUCTs) | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to a FareProduct. | ||||
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid from" LEG. If missing, then valid from the first LEG. | ||
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid to" LEG. If missing, then valid to the last LEG. | ||
MultiTripFareResultStructure
| Structure of a Multi Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | Non-empty list of trip references in the corresponding MultiTripFareRequestStructure | |||
| 0:* | Zero, one or more FareProducts that are valid for the referenced trips / part of trips. | |||
| 0:1 | The set of passed zones. | |||
| 0:* | URL to Fare information pages on the web. | |||
| public | authorisedPublic | staff | other | Allowed values for Booking Access. |
| callDriver | callOffice | online | other | phoneAtStop | text | mobileApp | atOffice | none | Allowed values for Flexible Booking method. |
| xs:normalizedString | Allowed values for Booking Process UIC 7037 Code list. |
| any | information | reservations | lostProperty | publicRelations | complaints | emergency | other | Allowed values for CONTACT role. |
| xs:normalizedString | Email address type a@b. |
| xs:NMTOKEN | Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority. |
| xs:NMTOKEN | Identifier of a Fare Authority. |
| FARE_OUTOFAREA | FARE_JOURNEYNOTPERMITTED | FARE_ADDITIONALCHARGES | FARE_ADDITIONALTICKETS | FARE_ROUTENOTFEASIBLE | FARE_ALREADYCOVERED | FARE_DATEOUTOFRANGE | FARE_STOPPOINTUNKNOWN | FARE_OTHER | Types of problems that may be returned in responses to FARE requests. |
| xs:NMTOKEN | Identifier of a FareProduct |
| xs:normalizedString | Allowed values for Group Booking. |
| Adult | Child | Senior | Youth | Disabled | [a simplified and specialised view of USER PROFILE in TM and NeTEx] classification of passengers by age or other factors that may determine the fare they will need to pay. |
| xs:decimal | A percentage value between 0 and 100 |
| xs:normalizedString | Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc. |
| xs:normalizedString | Allowed values for Purchase Moment. |
| xs:normalizedString | Allowed values for Purchase when. |
| xs:NMTOKEN | Identifier of a fare zone. |
| all | first | second | third | business | economy | classes of travel available on a particular service which will affect the price to be paid |
FareAuthorityRefStructure
| Reference to a Fare Authority ([a specialisation of an ORGANISATION in TMv6] ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs). | ||||
FareAuthorityRef
| Reference to a Fare Authority. | ||||
FareAuthorityGroup group
| Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs | ||||
| FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
TariffZoneRef
| Reference to a fare zone. | ||||
TariffZoneStructure
| [a more clearly defined equivalent of TARIFF ZONE in TM and NeTEx] A ZONE used to define a zonal fare structure in a zone-counting or zone-matrix system. | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to a fare zone. | ||||
| 1:1 | xs:string | Text describing the fare zone. Passengers will recognize the fare zone by this text. Often published on Fare Zone Maps. | ||
TariffZoneListInAreaStructure
| List of fare zones within the area of a Fare Authority. | ||||
The element contains a sequence of the following elements: | |||||
| FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
| 1:* | Fare zone in area. | |||
TariffZoneRefListStructure
| List of fare zones references within the area of a Fare Authority. | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to a Fare Authority. | ||||
1:* | Reference to a fare zone. | ||||
ContactDetailsStructure
| Type for contact details. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Name of contact person. | |||
| 0:1 | The email address of the contact. | |||
| 0:1 | Contact telephone number. | |||
| 0:1 | Contact fax number. | |||
| 0:1 | The web site address of the contact. | |||
| 0:1 | Further details about contact process. | |||
BookingMethodListOfEnumerations
| List of values for Flexible Booking values. | ||||
The element contains only one element: | |||||
| 1:* | ||||
PurchaseMomentListOfEnumerations
| List of Purchase Moment values. | ||||
The element contains only one element: | |||||
| 1:* | ||||
BookingProcessListOfEnumerations
| List of Booking Process values. | ||||
The element contains only one element: | |||||
| 1:* | ||||
GroupBookingListOfEnumerations
| List of Group Booking values. | ||||
The element contains only one element: | |||||
| 1:* | ||||
BookingArrangementsStructure
| Type for BOOKING ARRANGEMENTs modified from NeTEx. | ||||
BookingArrangementsGroup group
| Elements for BOOKING ARRANGEMENTs. | ||||
| 1:* | Fare zone in area. | |||
TariffZoneRefListStructure
| List of fare zones references within the area of a Fare Authority. | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to a Fare Authority. | ||||
1:* | Reference to a fare zone. | ||||
ContactDetailsStructure
| Type for contact details. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Name of contact person. | |||
| 0:1 | The email address of the contact. | |||
| 0:1 | Contact telephone number. | |||
| 0:1 | Contact fax number. | |||
| 0:1 | The web site address of the contact. | |||
| 0:1 | Further details about contact process. | |||
BookingMethodListOfEnumerations
| List of values for Flexible Booking values. | ||||
The element contains only one element: | |||||
| 1:* | Flexible booking methods. | |||
PurchaseMomentListOfEnumerations
| List of Purchase Moment values. | ||||
The element contains only one element: | |||||
| 1:* | Possibilities when to pay. | |||
BookingProcessListOfEnumerations
| List of Booking Process values. | ||||
The element contains only one element: | |||||
| 1:* | Ways how to book (UIC 7037 codes). | |||
GroupBookingListOfEnumerations
| Possibilites and restrictions for group booking. | ||||
The element contains only one element: | |||||
| 1:* | Group booking policies. | |||
BookingArrangementsStructure
| Type for BOOKING ARRANGEMENTs modified from NeTEx. | ||||
BookingArrangementsGroup group
| Elements for BOOKING ARRANGEMENTs. | ||||
| BookingArrangements |
| 0:1 | Contact for Booking. | ||
| 0:1 | Allowed Ways of Making a BOOKING. | |||
| 0:1 | Who can make a booking. Default is public. | |||
| FareProductBooking |
| 0:* | URL to information for this FareProduct | ||
| 0:* | URL to buy the FareProduct online. | |||
| 0:* | ||||
| 0:* | Multiple sets of multiple booking arrangements for different legs of a journey. | |||
| 0:1 | xs:anyType | |||
FareProductPriceGroup group
| [related to FARE PRODUCT PRICE in TM and NeTEx] price at which a FARE PRODUCT can be purchased. | ||||
| FareProductPrice |
| 0:1 | xs:decimal | FareProduct price as decimal number. | |
| 0:1 | xs:decimal | Net FareProduct price as decimal number for accounting purposes. | ||
FareProductBookingGroup group
| [aggregation of DISTRIBUTION CHANNEL and BOOKING ARRANGEMENT in TM and NeTEx] Group of information elements related to information to support the process of booking a FARE PRODUCT. | ||||
| FareProductBooking |
| 0:* | URL to information for this FareProduct | ||
| 0:* | URL to buy the FareProduct online. | |||
| 0:* | ||||
TripLegRangeGroup group
| Range of trip legs (from - to) for which a Fare result (ticket) is valid. | ||||
| TripLegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip leg. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip leg. | ||
TripFareResultStructure
| Structure of a Single Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages. | |||
| TripLegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip leg. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip leg. | ||
| 0:1 | The sequence of passed fare zones. | |||
| 0:* | One ore more FareProducts that are valid for this part of the trip. | |||
| 0:* | URL to static information page on the web. | |||
FarePassengerStructure
| [a specialised form of USER PROFILE in TM and NeTEx] attributes of a passenger that influence the price to be paid by that passenger for a FARE PRODUCT. | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | xs:nonNegativeInteger | Age of the passenger on the day of travel. | |
b |
| -1:1 | sequence of all passenger categories, for which this FareProduct is valid | ||
| 0:1 | A list of ENTITLEMENT PRODUCTs. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it. | ||
b |
| -1:1 | Fare zones for which the passenger already has a valid FareProduct. | ||
FareDataFilterGroup group
| Data filter group for Fare request. | ||||
| 0:* | Multiple sets of multiple booking arrangements for different legs of a journey. | |||
LegRangeGroup group
| Range of LEGs (from - to) for which a Fare result (ticket) is valid. | ||||
| LegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" LEG. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" LEG. | ||
TripFareResultStructure
| Structure of a Single Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages. | |||
| LegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" LEG. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" LEG. | ||
| 0:1 | The sequence of passed fare zones. | |||
| 0:* | One ore more FareProducts that are valid for this part of the trip. | |||
| 0:* | URL to static information page on the web. | |||
FarePassengerStructure
| [a specialised form of USER PROFILE in TM and NeTEx] attributes of a passenger that influence the price to be paid by that passenger for a FARE PRODUCT. | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | xs:nonNegativeInteger | Age of the passenger on the day of travel. | |
b |
| -1:1 | sequence of all passenger categories, for which this FareProduct is valid | ||
| 0:1 | A list of ENTITLEMENT PRODUCTs. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it. | ||
b |
| -1:1 | Fare zones for which the passenger already has a valid FareProduct. | ||
FareDataFilterGroup group
| Data filter group for Fare request. | ||||
| FareDataFilter |
| 0:* | Fare authority for which to retrieve Fare information. | ||
| 0:* | sequence of all passenger categories, for which this FareProduct is valid | |||
| 0:1 | Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). | |||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
LineInformationResponseGroup group
| Line Information response group. | ||||
| LINEINFORMATION_LINEUNKNOWN | LINEINFORMATION_OTHER | Types of problems that may be returned in responses to LINE INFORMATION requests. |
LineInformationResponseGroup group
| Line Information response group. | ||||
| LineInformationResponse |
| 0:* | |||
LineResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LineRefStructure | Reference to the LINE. | ||
| 0:1 | →siri:PublishedLineName | |||
| 0:1 | siri:DirectionRefStructure | DIRECTION of LINE. | ||
| 0:* | The LINE's route geometry. A line can have multiple ROUTEs and each has its own geometry. The first should be the "main" geometry. | |||
| 0:* | +Mode | List of transport modes that are supported by this line. | ||
| stop | address | poi | coord | location | topographicPlace | |
| origin | via | destination |
PlaceInformationRequestGroup group
| |||||
The element contains one of the following elements: | |||||
| PlaceInformationRequest | a |
| -1:1 | Initial input for the place information request. This input defines what is originally looked for. | |
b |
| -1:1 | Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here. | ||
LineResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this Line result. | |||
| 1:1 | siri:LineRefStructure | Reference to the LINE. | ||
| 0:1 | →siri:PublishedLineName | Name or Number by which the LINE is known to the public. | ||
| 0:1 | siri:DirectionRefStructure | DIRECTION of LINE. | ||
| 0:* | The LINE's route geometry. A line can have multiple ROUTEs and each has its own geometry. The first should be the "main" geometry. | |||
| 0:* | +Mode | List of transport modes that are supported by this line. | ||
LineInformationProblemStructure
| Problem that may be returned in responses to LINE information requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the LINE information problem. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
| stop | address | poi | coord | location | topographicPlace | |
| origin | via | destination |
LocationInformationRequestGroup group
| |||||
The element contains one of the following elements: | |||||
| LocationInformationRequest | a |
| -1:1 | Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs. | |
b |
| -1:1 | LOCATION / PLACE for further refinement. If a Place in a previous response was marked as not "complete" it can be refined by putting it here. If Places are organised hierarchically it may be reasonable to identify the Place in a top-down approach with several steps of refining a Place on each level of hierarchy. Following this approach an initial request retrieves a first list of top-level Places (e.g. streets) which are to be refined in a subsequent request to the next level (e.g. house number intervals). The objects of the current level are presented to the user for selection. The object reference of the selected object is then sent in the next request for further refinement. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
PlaceInformationResponseGroup group
| |||||
| PlaceInformationResponse |
| 0:1 | Context to hold response objects that occur frequently. | ||
LocationInformationResponseGroup group
| |||||
| LocationInformationResponse |
| 0:1 | Context to hold response objects that occur frequently. | ||
| 0:1 | xs:nonNegativeInteger | If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. | ||
| 0:* | ||||
InitialPlaceInputStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:string | Name of the place object which is looked after. This is usually the user's input. If not given, the name of the resulting place objects is not relevant. | ||
| 0:1 | siri:LocationStructure | Coordinate where to look for places. If given, the result should prefer place objects near to this GeoPosition. | ||
| 0:1 | Restricts the resulting place objects to the given geographical area. | |||
| 0:* | siri:ParticipantRefStructure | Used in distributed environments. e.g. EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
PlaceParamStructure
| |||||
The element contains a sequence of the following elements: | |||||
| PlaceDataFilter |
| 0:* | Allowed place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether place objects for origin, via, or destination are searched. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops. | |||
| 0:1 | Filter for places that are operated by certain organisations. | |||
| 0:* | If at least one is set, only place objects within the given localities are allowed. | |||
| 0:* | The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best. | |||
InitialLocationInputStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:string | Name of the LOCATION object which is looked for. This is usually the user's input. If not given, the name of the resulting location objects is not relevant. | ||
| 0:1 | siri:LocationStructure | Coordinate where to look for locations/places. If given, the result should prefer locations/place objects near to this GeoPosition. | ||
| 0:1 | Restricts the resulting location/place objects to the given geographical area. | |||
| 0:* | siri:ParticipantRefStructure | Used in distributed environments. e.g. EU-Spirit. If none is given, the location/place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the location/place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
PlaceParamStructure
| |||||
The element contains a sequence of the following elements: | |||||
| PlaceDataFilter |
| 0:* | Allowed location/place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether location/place objects for origin, via, or destination are searched. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops. | |||
| 0:1 | Filter for locations/places that are operated by certain organisations. | |||
| 0:* | If at least one is set, only location/place objects within the given localities are allowed. | |||
| 0:1 | Filter to narrow down POI searches. | |||
| 0:1 | xs:anyType | |||
| PlacePolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g.: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The place information service is expected to support a response volume of at least 500 objects within one single response. | ||
| PlaceSorting |
| 0:1 | xs:string | If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore use with care. | |
| 0:1 | siri:LocationStructure | WGS84 coordinates position. Locations closer to this GeoPosition are preferred. | ||
| 0:1 | xs:float | Ignore locations with a lower probability. | ||
GeoRestrictionsStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Area is defined by a polyline | ||
b |
| -1:1 | |||
c |
| -1:1 | |||
GeoCircleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:DistanceType | Radius in metres. | ||
GeoRectangleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:LocationStructure | |||
GeoAreaStructure
| [specialisation of ZONE in TMv6] a LINK SEQUENCE (one-dimensional) forming the boundary of a ZONE - | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | |||
PlaceResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this LOCATION result. | |||
| 1:1 | ||||
| 1:1 | xs:boolean | States whether the included place is complete or needs further refinement. Only complete places are fully resolved and can be used in e.g. trip requests. Incomplete places have to be refined entering them once again into a PlaceInformationRequest. | ||
| 0:1 | Probability, that this result is the one meant by the user's input. Value should be between 0 and 1. | |||
GeoRestrictionsStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Area defined by a polyline. | ||
b |
| -1:1 | Area defined by a circle. | ||
c |
| -1:1 | Area defined by a rectangle. | ||
GeoCircleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | Centre position of the circle. | ||
| 1:1 | siri:DistanceType | Radius in metres. | ||
GeoRectangleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | Upper-left (north-west) corner of the rectangle. | ||
| 1:1 | siri:LocationStructure | Lower-right (south-east) corner of the rectangle. | ||
GeoAreaStructure
| [specialisation of ZONE in TMv6] a LINK SEQUENCE (one-dimensional) forming the boundary of a ZONE + | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | Vertices of a polyline defining an area. | ||
PlaceResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this LOCATION result. | |||
| 1:1 | The Place / Location object. | |||
| 1:1 | xs:boolean | States whether the included location/place is complete or needs further refinement. Only complete locations/places are fully resolved and can be used in e.g. trip requests. Incomplete locations/places have to be refined entering them once again into a LocationInformationRequest. | ||
| 0:1 | Probability, that this result is the one meant by the user's input. Value should be between 0 and 1. | |||
| 0:1 | xs:boolean | Tells the service to include the available public transport modes at returned stops. | ||
| 0:1 | xs:boolean | Tells the service to include the available operators at returned stops. | ||
PlaceDataFilterGroup group
| |||||
| PlaceDataFilter |
| 0:* | Allowed place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether place objects for origin, via, or destination are searched. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops. | |||
| 0:1 | Filter for places that are operated by certain organisations. | |||
| 0:* | If at least one is set, only place objects within the given localities are allowed. | |||
| PlaceDataFilter |
| 0:* | Allowed location/place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether location/place objects for origin, via, or destination are searched. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops. | |||
| 0:1 | Filter for locations/places that are operated by certain organisations. | |||
| 0:* | If at least one is set, only location/place objects within the given localities are allowed. | |||
| 0:1 | Filter to narrow down POI searches. | |||
| 0:1 | xs:anyType | |||
PlaceSortingGroup group
| |||||
| PlaceSorting |
| 0:1 | xs:string | If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore use with care. | |
| 0:1 | siri:LocationStructure | WGS84 coordinates position. Locations closer to this GeoPosition are preferred. | ||
| 0:1 | xs:float | Ignore locations with a lower probability. | ||
ExchangePointsRequestGroup group
| |||||
| ExchangePointsRequest |
| 0:1 | Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
| ExchangePointsRequest |
| 0:1 | Location/Place for which exchange points to other "neighbour" systems are to be searched. This location/place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned. | ||
| 0:1 | E.g. location/place types (stops, addresses, POIs) or specific location/place attributes | |||
ExchangePointsParamStructure
| |||||
The element contains a sequence of the following elements: | |||||
| ExchangePointsDataFilter |
| 0:* | Allowed place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops. | |||
| 0:1 | Filter for places that are operated by certain organisations. | |||
| 0:* | If at least one is set, only place objects within the given localities are allowed. | |||
| ExchangePointsDataFilter |
| 0:* | Allowed location/place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether the location/place object of this request acts as origin, via or destination point of the passenger journey. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops. | |||
| 0:1 | Filter for locations/places that are operated by certain organisations. | |||
| 0:* | If at least one is set, only location/place objects within the given localities are allowed. | |||
| 0:1 | siri:ParticipantRefStructure | Reference to system in which the destination (or origin) of the passenger is located. | ||
| 0:* | siri:ParticipantRefStructure | One or more adjacent systems to which the exchange points should be retrieved. | ||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | |||
| 0:1 | xs:positiveInteger | Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g. in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response. | ||
| 0:1 | xs:nonNegativeInteger | Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response. | ||
ExchangePointsDataFilterGroup group
| |||||
| ExchangePointsDataFilter |
| 0:* | Allowed place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops. | |||
| 0:1 | Filter for places that are operated by certain organisations. | |||
| 0:* | If at least one is set, only place objects within the given localities are allowed. | |||
| ExchangePointsDataFilter |
| 0:* | Allowed location/place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether the location/place object of this request acts as origin, via or destination point of the passenger journey. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops. | |||
| 0:1 | Filter for locations/places that are operated by certain organisations. | |||
| 0:* | If at least one is set, only location/place objects within the given localities are allowed. | |||
| 0:1 | siri:ParticipantRefStructure | Reference to system in which the destination (or origin) of the passenger is located. | ||
| 0:* | siri:ParticipantRefStructure | One or more adjacent systems to which the exchange points should be retrieved. | ||
ExchangePointsPolicyGroup group
| |||||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | |||
| 0:1 | xs:positiveInteger | Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g. in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response. | ||
| 0:1 | xs:nonNegativeInteger | Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response. | ||
ExchangePointsResponseGroup group
| |||||
| ExchangePointsResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| ExchangePointsResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:1 | xs:nonNegativeInteger | If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. | ||
| 0:* | ||||
ExchangePointsResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this EXCHANGE POINTS result. | |||
| 1:1 | Place object that describes this exchange point. | |||
| 0:1 | xs:duration | Rough estimate of the travel duration from the specified reference place to this exchange point. | ||
| 0:1 | xs:duration | Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it has to take care, that feeding arrival and fetching departure are at least this duration apart. | ||
| 0:1 | xs:boolean | Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE. | ||
| 0:* | +Mode | List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. | ||
| 0:1 | The priority of the exchange point. 100 is the maximum. | |||
| xs:normalizedString | Identifier of an Address |
| EXCHANGEPOINTS_NORESULTS | EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM | EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM | EXCHANGEPOINTS_OTHER | Types of problems that may be returned in responses to EXCHANGE POINTS requests |
| LOCATION_NORESULTS | LOCATION_UNSUPPORTEDTYPE | LOCATION_UNSUPPORTEDCOMBINATION | LOCATION_NOREFINEMENT | LOCATION_USAGEIGNORED | LOCATION_UNSUPPORTEDPTMODES | LOCATION_UNSUPPORTEDLOCALITY | LOCATION_UNSUPPORTEDSORTINGMETHOD | LOCATION_OTHER | Types of problems that may be returned in responses to LOCATION requests. |
| xs:normalizedString | Identifier of a Point of Interest |
| xs:normalizedString | Identifier of a Stop Place |
| xs:normalizedString | Identifier of a TopographicPlace |
StopPointGroup group
| A stop point with id and name | ||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| 0:* | The exchange points found by the service. | |||
ExchangePointsResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this EXCHANGE POINTS result. | |||
| 1:1 | Place object that describes this exchange point. | |||
| 0:1 | xs:duration | Rough estimate of the travel duration from the specified reference location/place to this exchange point. | ||
| 0:1 | xs:duration | Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it has to take care, that feeding arrival and fetching departure are at least this duration apart. | ||
| 0:1 | xs:boolean | Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE. | ||
| 0:* | +Mode | List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. | ||
| 0:1 | The priority of the exchange point. 100 is the maximum. | |||
| xs:normalizedString | Identifier of an Address |
| EXCHANGEPOINTS_NORESULTS | EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM | EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM | EXCHANGEPOINTS_OTHER | Types of problems that may be returned in responses to EXCHANGE POINTS requests |
| LOCATION_NORESULTS | LOCATION_UNSUPPORTEDTYPE | LOCATION_UNSUPPORTEDCOMBINATION | LOCATION_NOREFINEMENT | LOCATION_USAGEIGNORED | LOCATION_UNSUPPORTEDPTMODES | LOCATION_UNSUPPORTEDLOCALITY | LOCATION_UNSUPPORTEDSORTINGMETHOD | LOCATION_OTHER | Types of problems that may be returned in responses to LOCATION requests. |
| xs:normalizedString | Identifier of a Point of Interest |
| xs:normalizedString | Identifier of a Stop Place |
| xs:normalizedString | Identifier of a TopographicPlace |
StopPointGroup group
| A stop point with id and name | ||||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest realtime status. | |||
StopPointStructure
| [an extended view of SCHEDULED STOP POINT in TMv6] a SCHEDULED STOP POINT extended by ACCESSIBILITY LIMITATION attributes and with identifier and name where passengers can board or alight from vehicles | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. As to the latest realtime status. | |||
| 0:* | Code of this stop point in private/foreign/proprietary coding schemes. | |||
| 0:1 | Reference to the stop place to which this stop point belongs. | |||
0:1 | If at least one is set, only place objects within the given localities are allowed.If at least one is set, only place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| 0:* | Code of this stop point in private/foreign/proprietary coding schemes. | |||
| 0:1 | Reference to the stop place to which this stop point belongs. | |||
0:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| StopAttributes |
| 0:1 | xs:boolean | Whether this stop is accessible for wheelchair users. | |
| 0:1 | xs:boolean | Whether this stop is lit. | ||
| 0:1 | xs:boolean | Whether this stop offers protection from weather conditions like rain, snow, storm etc. | ||
| StopPlace | 1:1 | Reference to a Stop Place | |||
| 1:1 | Name of this stop place for use in passenger information. | |||
| 0:1 | Additional description of the stop place that may be appended to the name if enough space is available. F.e. "Exhibition Center". | |||
| 0:* | Code of this stop place in private/foreign/proprietary coding schemes. | |||
0:1 | If at least one is set, only place objects within the given localities are allowed.If at least one is set, only place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| 0:* | Code of this stop place in private/foreign/proprietary coding schemes. | |||
0:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| StopAttributes |
| 0:1 | xs:boolean | Whether this stop is accessible for wheelchair users. | |
| 0:1 | xs:boolean | Whether this stop is lit. | ||
| 0:1 | xs:boolean | Whether this stop offers protection from weather conditions like rain, snow, storm etc. | ||
| StopAttributes |
| 0:1 | xs:boolean | Whether this stop is accessible for wheelchair users. | |
| 0:1 | xs:boolean | Whether this stop is lit. | ||
| 0:1 | xs:boolean | Whether this stop offers protection from weather conditions like rain, snow, storm etc. | ||
TopographicPlaceRefStructureTopographicPlaceRef
| Reference to a TopographicPlace | ||||
TopographicPlaceStructure
| [TMv6] A type of PLACE providing the topographical context when searching for or presenting travel information, for example as the origin or destination of a trip. It may be of any size (e.g. County,City, Town, Village) and of different specificity (e.g. Greater London, London, West End, Westminster, St James's). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | TopographicPlace ID. | |||
| 1:1 | Name or description of TopographicPlace for use in passenger information. | |||
| 0:* | Code of this TopographicPlace in private/foreign/proprietary coding schemes. | |||
| 0:1 | Reference to a parent TopographicPlace. | |||
| 0:1 | siri:ParticipantRefStructure | Used in distributed environments (e.g. EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in an distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
| 0:1 | +Area | Area covered by the locality described as a polygon. | ||
PointOfInterestRefStructure
| Reference to a Point of Interest | ||||
PointOfInterestRef
| Reference to a Point of Interest | ||||
PointOfInterestStructure
| [corresponds to POINT OF INTEREST in TMv6 with related information] type of PLACE to or through which passengers may wish to navigate as part of their journey and which is modelled in detail by journey planners. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this Point of Interest. | |||
| 1:1 | Name or description of point of interest for use in passenger information. | |||
| 0:1 | Additional description of the point of interest that may be appended to the name if enough space is available. F.e. "Exhibition Center". | |||
| 0:* | Categories this POI is associated with. Order indicates descending relevance. | |||
| 0:* | Code of this point of interest in private/foreign/proprietary coding schemes. | |||
0:1 | If at least one is set, only place objects within the given localities are allowed.If at least one is set, only place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
PointOfInterestCategoryStructure
| [a view of POINT OF INTEREST CLASSIFICATION in TMv6] categorisation of POINTs OF INTEREST in respect of the activities undertaken at them (defined by key-value-pairs). | ||||
The element contains one of the following elements: | |||||
a |
| -1:* | Open Street Map tag structure (key-value) | ||
b |
| -1:* | xs:string | Classification of the POI (when it is not from OSM). The codification of the classification Id may include de codification source (for example "IGN:[classificationCode]") | |
OsmTagStructure
| Structure of an Open Street Map tag. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Name of Open Street Map tag (amenity, leisure, tourism, bike, ...) | ||
| 1:1 | xs:NMTOKEN | Value for Open Street Map tag (charging_station, hostel, yes, ...) | ||
PointOfInterestFilterStructure
| Filter POIs by category. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether categories in list are to include or exclude from search. Default is FALSE. | ||
| 0:* | These POI categories can be used to filter POIs. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE). | |||
AddressRefStructure
| Reference to an Address | ||||
AddressRef
| Reference to an Address | ||||
AddressDetailGroup group
| An address with its name entities | ||||
TopographicPlaceRefStructureTopographicPlaceRef
| Reference to a TopographicPlace | ||||
TopographicPlaceStructure
| [TMv6] A type of PLACE providing the topographical context when searching for or presenting travel information, for example as the origin or destination of a trip. It may be of any size (e.g. County,City, Town, Village) and of different specificity (e.g. Greater London, London, West End, Westminster, St James's). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | TopographicPlace ID. | |||
| 1:1 | Name or description of TopographicPlace for use in passenger information. | |||
| 0:* | Code of this TopographicPlace in private/foreign/proprietary coding schemes. | |||
| 0:1 | Reference to a parent TopographicPlace. | |||
| 0:1 | siri:ParticipantRefStructure | Used in distributed environments (e.g. EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in an distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
| 0:1 | +Area | Area covered by the locality described as a polygon. | ||
PointOfInterestRefStructure
| Reference to a Point of Interest | ||||
PointOfInterestRef
| Reference to a Point of Interest | ||||
PointOfInterestStructure
| [corresponds to POINT OF INTEREST in TMv6 with related information] type of PLACE to or through which passengers may wish to navigate as part of their journey and which is modelled in detail by journey planners. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this Point of Interest. | |||
| 1:1 | Name or description of point of interest for use in passenger information. | |||
| 0:1 | Additional description of the point of interest that may be appended to the name if enough space is available. F.e. "Exhibition Center". | |||
| 0:* | Categories this POI is associated with. Order indicates descending relevance. | |||
| 0:* | Code of this point of interest in private/foreign/proprietary coding schemes. | |||
0:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| 0:1 | Additional information for this POI (e.g. information on available parking slots, charging infrastructure, sharing vehicles). | |||
PointOfInterestCategoryStructure
| [a view of POINT OF INTEREST CLASSIFICATION in TMv6] categorisation of POINTs OF INTEREST in respect of the activities undertaken at them (defined by key-value-pairs). | ||||
The element contains one of the following elements: | |||||
a |
| -1:* | Open Street Map tag structure (key-value) | ||
b |
| -1:* | xs:string | Classification of the POI (when it is not from OSM). The codification of the classification Id may include de codification source (for example "IGN:[classificationCode]") | |
PointOfInterestAdditionalInformationStructure
| Generic structure for additional information on POIs. | ||||
The element contains only one element: | |||||
| 1:* | POI additional information is a set of key/value pairs that are associated with defined categories. | |||
CategoryKeyValueType
| Category Key Value triplets. Category can be empty. Several such elements form the information necessary for a given category. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:string | |||
| 1:1 | xs:string | |||
| 1:1 | xs:string | |||
OsmTagStructure
| Structure of an Open Street Map tag. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Name of Open Street Map tag (amenity, leisure, tourism, bike, ...) | ||
| 1:1 | xs:NMTOKEN | Value for Open Street Map tag (charging_station, hostel, yes, ...) | ||
PointOfInterestFilterStructure
| Filter POIs by category. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether categories in list are to include or exclude from search. Default is FALSE. | ||
| 0:* | These POI categories can be used to filter POIs. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE). | |||
AddressRefStructure
| Reference to an Address | ||||
AddressRef
| Reference to an Address | ||||
AddressDetailGroup group
| An address with its name entities | ||||
| AddressDetail |
| 0:1 | xs:string | Country of the address. | |
| 0:1 | xs:string | Postal code of the address. | ||
| 0:1 | xs:string | TopographicPlace name of the address. If set it should at least contain the city name. | ||
0:1 | If at least one is set, only place objects within the given localities are allowed.If at least one is set, only place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
0:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| 0:1 | xs:string | Street name of the address. | ||
| 0:1 | xs:string | House number of the address. If none is given, either a crossing street can be given, or the whole street is meant. | ||
| 0:1 | xs:string | Crossing. This can be used to be more specific without using house numbers. | ||
AddressStructure
| descriptive data associated with a PLACE that can be used to describe the unique geographical context of a PLACE for the purposes of identifying it. May be refined as either a ROAD ADDRESS, a POSTAL ADDRESS or both | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this address. | |||
| 0:* | Code of this address in private/foreign/proprietary coding schemes. | |||
| 1:1 | Name or description of address for use in passenger information. | |||
| 0:1 | Additional description of the address that may be appended to the name if enough space is available. F.e. "Crossing with Peterstraße". | |||
AddressStructure
| descriptive data associated with a PLACE that can be used to describe the unique geographical context of a PLACE for the purposes of identifying it. May be refined as either a ROAD ADDRESS, a POSTAL ADDRESS or both | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this address. | |||
| 0:* | Code of this address in private/foreign/proprietary coding schemes. | |||
| 1:1 | Name or description of address for use in passenger information. | |||
| 0:1 | Additional description of the address that may be appended to the name if enough space is available. F.e. "Crossing with Peterstraße". | |||
| AddressDetail |
| 0:1 | xs:string | Country of the address. | |
| 0:1 | xs:string | Postal code of the address. | ||
| 0:1 | xs:string | TopographicPlace name of the address. If set it should at least contain the city name. | ||
0:1 | If at least one is set, only place objects within the given localities are allowed.If at least one is set, only place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
0:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | ||||
| 0:1 | xs:string | Street name of the address. | ||
| 0:1 | xs:string | House number of the address. If none is given, either a crossing street can be given, or the whole street is meant. | ||
| 0:1 | xs:string | Crossing. This can be used to be more specific without using house numbers. | ||
PlaceStructure
| geographic PLACE of any type which may be specified as the origin or destination of a trip | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Model of an address | ||
b |
| -1:1 | Model of a POI | ||
c |
| -1:1 | Model of a stop place | ||
d |
| -1:1 | Model of a stop point | ||
e |
| -1:1 | TopographicPlace. Region, village, or city. | ||
| 1:1 | Public name of the place. | |||
| 1:1 | siri:LocationStructure | |||
| 0:1 | SITUATION reference. Mostly used for STOP PLACE, SCHEDULED STOP POINT (StopPoint). However, in future a situation reference may occur on many geographic elements (e.g. roads) as well. | |||
| 0:* | Attribute associated with this place. | |||
| 0:1 | xs:anyType | |||
PlaceRefStructure
| Reference to a geographic PLACE of any type which may be specified as the origin or destination of a trip | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | ||
b | -1:1 | Reference to a Stop Place | |||
c | -1:1 | If at least one is set, only place objects within the given localities are allowed.If at least one is set, only place objects within the given localities are allowed.Reference to a TopographicPlace | |||
d | -1:1 | Reference to a Point of Interest | |||
e | -1:1 | Reference to an Address | |||
f |
| -1:1 | siri:LocationStructure | WGS84 coordinates position. | |
| 1:1 | Public name of the place. | |||
| 0:* | xs:normalizedString | Used in distributed environments. e.g. EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
LocationProblemStructure
| Problem that may be returned in responses to LOCATION requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the LOCATION problem. | |||
PlaceStructure
| geographic PLACE of any type which may be specified as the origin or destination of a trip | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Model of an address | ||
b |
| -1:1 | Model of a POI | ||
c |
| -1:1 | Model of a stop place | ||
d |
| -1:1 | Model of a stop point | ||
e |
| -1:1 | TopographicPlace. Region, village, or city. | ||
| 1:1 | Public name of the place. | |||
| 1:1 | siri:LocationStructure | Position using WGS84/EPSG:4326 coordinates. | ||
| 0:1 | SITUATION reference. Mostly used for STOP PLACE, SCHEDULED STOP POINT (StopPoint). However, in future a situation reference may occur on many geographic elements (e.g. roads) as well. | |||
| 0:* | Attribute associated with this place. | |||
| 0:1 | xs:anyType | |||
PlaceRefStructure
| Reference to a geographic PLACE of any type which may be specified as the origin or destination of a trip | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | Reference to a stop point. | |
b | -1:1 | Reference to a Stop Place | |||
c | -1:1 | If at least one is set, only location/place objects within the given localities are allowed.If at least one is set, only location/place objects within the given localities are allowed.Reference to a TopographicPlace | |||
d | -1:1 | Reference to a Point of Interest | |||
e | -1:1 | Reference to an Address | |||
f |
| -1:1 | siri:LocationStructure | WGS84 coordinates position. | |
| 1:1 | Public name of the place. | |||
| 0:* | xs:normalizedString | Used in distributed environments. e.g. EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ | ||
LocationProblemStructure
| Problem that may be returned in responses to LOCATION requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the LOCATION problem. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
ExchangePointProblemStructure
| Problem that may be returned in responses to EXCHANGE POINTS requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the EXCHANGE POINTS problem. | |||
ExchangePointsProblemStructure
| Problem that may be returned in responses to EXCHANGE POINTS requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the EXCHANGE POINTS problem. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
| STOPEVENT_NOEVENTFOUND | STOPEVENT_LOCATIONUNSERVED | STOPEVENT_LOCATIONUNKNOWN | STOPEVENT_DATEOUTOFRANGE | STOPEVENT_LASTSERVICEOFTHISLINE | STOPEVENT_NOREALTIME | STOPEVENT_OTHER | Types of problems that may be returned in responses to STOPEVENT requests. | |||
| departure | arrival | both | Departure or arrival events or both | |||
StopEventRequestGroup group
| Request structure for departure and arrival events at stops | ||||
| StopEventRequest |
| 1:1 | Place for which to obtain stop event information. | ||
| StopEventRequest |
| 1:1 | LOCATION / PLACE for which to obtain stop event information. | ||
| 0:1 | Request parameter | |||
StopEventParamStructure
| Request specific parameters (parameters which define what is to be included in a Stop Event result) | ||||
The element contains a sequence of the following elements: | |||||
| StopEventDataFilter |
| 0:1 | Modes (VEHICLE MODE) to be excluded or included in stop events. | ||
StopEventResponseGroup group
| Response structure for departure and arrival events at stops | ||||
| StopEventResponse |
| 0:1 | Container for data that is referenced multiple times. | ||
| 0:* | Enclosing element for stop event data. | |||
StopEventResultStructure
| Wrapper element for a single stop event result. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | ID of this result. | ||
| 0:* | Problems related to this STOPEVENT result. | |||
| 1:1 | Stop event data element. | |||
StopEventStructure
| Stop event structure. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Calls at stops that happen before this stop event (service pattern of this vehicle journey before this stop event). | |||
| 1:1 | The call of this vehicle journey at this stop. | |||
| 0:* | Calls at stops that happen after this stop event (rest of the service pattern of the vehicle journey). | |||
| 1:1 | Service that calls at this stop. | |||
StopEventResultStructure
| Wrapper element for a single stop event result. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this result. | |||
| 0:* | Problems related to this STOPEVENT result. | |||
| 1:1 | Stop event data element. | |||
StopEventStructure
| Stop event structure. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Calls at stops that happen before this stop event (service pattern of this vehicle journey before this stop event). | |||
| 1:1 | The call of this vehicle journey at this stop. | |||
| 0:* | Calls at stops that happen after this stop event (rest of the service pattern of the vehicle journey). | |||
| 1:1 | Service that calls at this stop. | |||
| OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
| 0:1 | For SITUATIONs that affect the whole StopEvent. Otherwise References for SITUATIONs can be added at the different CALL elements | |||
| 0:1 | xs:anyType | |||
CallAtNearStopStructure
| indication of the walk distance and time to a nearby stop where relevant. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | [same as CALL in SIRI] the meeting of a VEHICLE JOURNEY with a specific SCHEDULED STOP POINT . | |||
| 0:1 | siri:DistanceType | Distance from request place (f.e. address) to this stop in metres. | ||
| 0:1 | xs:duration | Walking duration from request place (f.e. address) to this stop. All user options taken into account (f.e. walk speed). | ||
StopEventProblemStructure
| Problem that may be returned in responses to STOPEVENT requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the STOPEVENT problem. | |||
| 0:1 | For SITUATIONs that affect the whole StopEvent. Otherwise References for SITUATIONs can be added at the different CALL elements | |||
| 0:1 | xs:anyType | |||
CallAtNearStopStructure
| indication of the walk distance and time to a nearby stop where relevant. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | [same as CALL in SIRI] the meeting of a VEHICLE JOURNEY with a specific SCHEDULED STOP POINT . | |||
| 0:1 | siri:DistanceType | Distance from request LOCATION / PLACE (f.e. address) to this stop in metres. | ||
| 0:1 | xs:duration | Walking duration from request LOCATION / PLACE (f.e. address) to this stop. All user options taken into account (f.e. walk speed). | ||
StopEventProblemStructure
| Problem that may be returned in responses to STOPEVENT requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the STOPEVENT problem. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
| DatedJourneyRef | a | 1:1 | Reference to a Journey | ||
a | 1:1 | Reference to an Operating Day | |||
| TimedVehicleRef | b |
| 1:1 | →siri:VehicleRef | |
| TimedVehicleRef | b |
| 1:1 | →siri:VehicleRef | Reference to vehicle. |
b |
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | |
| TripInfoRequest |
| 0:1 | Request parameter. | ||
Then, the element contains one of the following elements: | |||||
| NumberOfResults | a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (f.e. because the user is already on the way) instead of finding the latest possible start opportunity. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | ||
b |
| -0:1 | The types of algorithm that should be used in the calculation of the trip. | ||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, walk). Default is FALSE. | ||
| TripPolicy |
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | |
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | |||
b |
| -0:1 | The types of algorithm that can be used for planning a journey (fastest, least walking, etc.) | ||
| 0:* | For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | |||
| 0:1 | xs:boolean | Trip calculation takes elevation data into account (bike, walk) | ||
| TripPolicy |
| 0:* | For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | ||
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include turn-by-turn instructions for each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include accessibility information. | ||
| 0:1 | xs:boolean | Whether the result should include the access features (stairs, elevator, etc.) on each path link. | ||
| 0:1 | xs:boolean | Whether the result should include real time status of access features to indicate broken equipment. | ||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired). | |||
| 0:1 | xs:boolean | Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true. | ||
| 0:1 | xs:boolean | Wheter the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true | ||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. | ||
| 0:1 | ||||
| 0:1 | xs:anyType | |||
TripDataFilterGroup group
| Data to be included/excluded from search, f.e. modes, operators. | ||||
| 0:1 | Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). | |||
| 0:1 | xs:anyType | |||
TripDataFilterGroup group
| Data to be included/excluded from search, f.e. modes, operators. | ||||
| TripDataFilter |
| 0:1 | Modes (VEHICLE MODE) to be excluded or included in trip calculation. | ||
| 0:1 | Lines/Directions to include/exclude. | |||
| 0:1 | Transport operators to include/exclude. | |||
The element contains one of the following elements: | |||||
| NumberOfResults | a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (f.e. because the user is already on the way) instead of finding the latest possible start opportunity. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
The element contains one of the following elements: | |||||
a |
| -1:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | ||
b |
| -0:1 | The types of algorithm that should be used in the calculation of the trip. | ||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, walk). Default is FALSE. | ||
| TripPolicy |
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | |
The element contains one of the following elements: | |||||
a |
| -1:1 | |||
b |
| -0:1 | The types of algorithm that can be used for planning a journey (fastest, least walking, etc.) | ||
| 0:* | For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | |||
| 0:1 | xs:boolean | Trip calculation takes elevation data into account (bike, walk) | ||
| TripPolicy |
| 0:* | For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | ||
TripMobilityFilterGroup group
| Parameters the user can set to restrict the mobility options - particularly for interchanging. | ||||
| BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to climb one step. | |
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport). | ||
TripContentFilterGroup group
| Parameters that control the level of detail of the trip results. | ||||
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include turn-by-turn instructions for each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include accessibility information. | ||
| 0:1 | xs:boolean | Whether the result should include the access features (stairs, elevator, etc.) on each path link. | ||
| 0:1 | xs:boolean | Whether the result should include real time status of access features to indicate broken equipment. | ||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired). | |||
| 0:1 | xs:boolean | Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true. | ||
| 0:1 | xs:boolean | Wheter the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true | ||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. | ||
OptimisationMethodList
| List of OptimisationMethods. The order of precedence - if used at all - is high to low. In single criteria optimisers the optimisation methods may be used in parallel and not truly used to score the results. | ||||
The element contains only one element: | |||||
| 1:* | ||||
NotViaStructure
| NNot-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | ||
b | -1:1 | Reference to a Stop Place | |||
NoChangeAtStructure
| no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | ||
b | -1:1 | Reference to a Stop Place | |||
TariffzoneFilterStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether to include or exclude given tariff zones in the list from the search. Default is to include. | ||
| 1:1 | ||||
TripResponseGroup group
| Trip response structure. | ||||
OptimisationMethodList
| List of OptimisationMethods. The order of precedence - if used at all - is high to low. In single criteria optimisers the optimisation methods may be used in parallel and not truly used to score the results. | ||||
The element contains only one element: | |||||
| 1:* | ||||
NotViaStructure
| Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | Reference to a not-via stop point. | |
b | -1:1 | Reference to a not-via stop place. | |||
NoChangeAtStructure
| No-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | Reference to a no-change stop point. | |
b | -1:1 | Reference to a no-change stop place. | |||
TariffzoneFilterStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether to include or exclude given tariff zones in the list from the search. Default is to include. | ||
| 1:1 | List of fare zones to include or exclude. | |||
TripResponseGroup group
| Trip response structure. | ||||
| TripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. | |||
TripResultStructure
| Structure for a single trip result and associated problems. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip result for referencing purposes. Unique within trip response. | ||
| 0:* | Problems related to this Trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Detailed information on trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| 0:* | ||||
TripSummaryStructure
| Structure for trip overview information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 0:1 | Describes the origin situation of this trip. | |||
| 0:1 | Describes the arrival situation of this trip. | |||
| 0:1 | xs:duration | Overall duration of the trip. | ||
| 0:1 | xs:dateTime | Departure time at origin. | ||
| 0:1 | xs:dateTime | Arrival time at destination. | ||
| 0:1 | xs:nonNegativeInteger | Number of public transport trip legs. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
TripResultStructure
| Structure for a single trip result and associated problems. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip result for referencing purposes. Unique within trip response. | |||
| 0:* | Problems related to this Trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Detailed information on trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| 0:* | Fare and fare product information for this trip as a whole or parts of it. | |||
| 0:1 | xs:boolean | When the result is an alternative option from IncludeAlternativeOptions, then the flag should be set to true. If it is an alternative option this means that the server decided to add this result for its own reasons: e.g. to push a certain trip leg, because it believes that it might better suit at least some possible customers. Such options are not an optimal fit to the criteria that were in the request. The client may therefore disregard such results depending on the use case. | ||
TripSummaryStructure
| Structure for trip overview information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip for referencing purposes. Unique within trip response. | |||
| 0:1 | Describes the origin situation of this trip. | |||
| 0:1 | Describes the arrival situation of this trip. | |||
| 0:1 | xs:duration | Overall duration of the trip. | ||
| 0:1 | xs:dateTime | Departure time at origin. | ||
| 0:1 | xs:dateTime | Arrival time at destination. | ||
| 0:1 | xs:nonNegativeInteger | Number of public transport legs. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
| OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
TripStructure
| [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 1:1 | xs:duration | Overall duration of the trip. | ||
| 1:1 | xs:dateTime | Departure time at origin. | ||
| 1:1 | xs:dateTime | Arrival time at destination. | ||
| 1:1 | xs:nonNegativeInteger | Number of interchanges. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
| 1:* | Legs of the trip | |||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
TripStructure
| [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more LEGs | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip for referencing purposes. Unique within trip response. | |||
| 1:1 | xs:duration | Overall duration of the trip. | ||
| 1:1 | xs:dateTime | Departure time at origin. | ||
| 1:1 | xs:dateTime | Arrival time at destination. | ||
| 1:1 | xs:nonNegativeInteger | Number of interchanges. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
| 1:* | +Leg | Legs of the trip | ||
| OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip is delayed. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false. | ||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
TripLegStructure
| a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange) | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip leg. Unique within trip result. | ||
| 0:1 | siri:ParticipantRefStructure | [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s) | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | |||
b |
| -1:1 | |||
c |
| -1:1 | |||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
LegStructure
| a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange) | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this leg. Unique within trip result. | |||
| 0:1 | siri:ParticipantRefStructure | [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s) | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Leg by a continuously available service or mode of transport. | ||
b |
| -1:1 | Timetabled Leg. | ||
c |
| -1:1 | Leg to connect between different services or modes of transport (interchanges). | ||
| Sustainability |
| 0:1 | |||
The element contains a sequence of the following elements: | |||||
| 1:1 | Kilogram by person and by kilometer of CO2 emission. | |||
| 0:1 | Confidence level of the emission value in percent. | |||
TimedLegStructure
| passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Stop/Station where boarding is done | |||
| 0:* | information about the intermediate passed stop points. | |||
| 1:1 | Stop/Station to alight | |||
| 1:1 | Service that is used for this trip leg. | |||
| 0:* | Attributes that are not valid on the whole service, but only on parts of the journey leg. | |||
TimedLegStructure
| passenger LEG with timetabled schedule. Corresponds to a RIDE. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Stop/Station where boarding is done | |||
| 0:* | information about the intermediate passed stop points. | |||
| 1:1 | Stop/Station to alight | |||
| 1:1 | Service that is used for this leg. | |||
| 0:* | Attributes that are not valid on the whole service, but only on parts of the journey leg. | |||
| OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
| 0:1 | Geographic embedding of this leg. | |||
| 0:1 | Confidence level of the emission value in percent. | |||
| 0:1 | xs:anyType | |||
LegBoardStructure
| Describes the the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information. | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
| 0:1 | xs:boolean | Boarding will not be allowed at this stop of this journey. | ||
| 0:1 | xs:boolean | Alighting will not be allowed at this stop of this journey. | ||
LegAlightStructure
| Describes the situation at a stop or station at which the passenger alights from a Leg of a trip including time-related information | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
| 0:1 | xs:boolean | Boarding will not be allowed at this stop of this journey. | ||
| 0:1 | xs:boolean | Alighting will not be allowed at this stop of this journey. | ||
LegIntermediateStructure
| Describes the situation at a stop or station that lies between the LegBoard and LegAlight stop or station including time-related information. | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
Then, the element contains one of the following elements: | |||||
| NumberOfResults | a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (f.e. because the user is already on the way) instead of finding the latest possible start opportunity. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | ||
b |
| -0:1 | The types of algorithm that should be used in the calculation of the trip. | ||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, walk). Default is FALSE. | ||
| MultiPointTripPolicy |
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | |
| 0:1 | The types of algorithm that can be used for planning a journey (fastest, least walking, etc.) | |||
| 0:1 | If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found. | |||
| MultiPointTripPolicy |
| 0:1 | If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found. | ||
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include turn-by-turn instructions for each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include accessibility information. | ||
| 0:1 | xs:boolean | Whether the result should include the access features (stairs, elevator, etc.) on each path link. | ||
| 0:1 | xs:boolean | Whether the result should include real time status of access features to indicate broken equipment. | ||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired). | |||
| 0:1 | xs:boolean | Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true. | ||
| 0:1 | xs:boolean | Wheter the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true | ||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. | ||
| 0:1 | ||||
| 0:1 | xs:anyType | |||
MultiPointTripPolicyGroup group
| Policies that control the multi-point trip search behaviour. | ||||
| 0:1 | Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). | |||
| 0:1 | xs:anyType | |||
MultiPointTripPolicyGroup group
| Policies that control the multipoint trip search behaviour. | ||||
The element contains one of the following elements: | |||||
| NumberOfResults | a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (f.e. because the user is already on the way) instead of finding the latest possible start opportunity. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
The element contains one of the following elements: | |||||
a |
| -1:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | ||
b |
| -0:1 | The types of algorithm that should be used in the calculation of the trip. | ||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, walk). Default is FALSE. | ||
| MultiPointTripPolicy |
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | |
| 0:1 | The types of algorithm that can be used for planning a journey (fastest, least walking, etc.) | |||
| 0:1 | If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found. | |||
| MultiPointTripPolicy |
| 0:1 | If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found. | ||
MultiPointTripResponseGroup group
| Multi-point trip response structure. | ||||
| MultiPointTripResponse |
| 0:1 | The MultiPointType should be returned, because it may differ from the one asked. Many systems will support only a subset of the MultiPointTypes and it is important to know, what the result is based on. | ||
| 0:1 | Context to hold trip response objects that occur frequently. | |||
| 0:* | The trip results found by the server. | |||
MultiPointTripResultStructure
| Structure for a multipoint trip result and associated problems | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip result for referencing purposes. Unique within multipoint-trip response. | ||
| 0:* | Problems related to this trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Information on the trip. | |
b |
| -1:1 | |||
MultiPointTripResultStructure
| Structure for a multipoint trip result and associated problems | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Id of this trip result for referencing purposes. Unique within multipoint-trip response. | |||
| 0:* | Problems related to this trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Information on the trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| MultiPointWaitTime |
| 0:1 | xs:duration | Additional wait time at origin of this trip. | |
| 0:1 | xs:duration | Additional wait time at destination of this trip. | ||
| 0:* | ||||
MultiPointWaitTimeGroup group
| Group for wait times at origin/destination. | ||||
| 0:* | Fare and fare product information for this trip as a whole or parts of it. | |||
MultiPointWaitTimeGroup group
| Group for wait times at origin/destination. | ||||
| MultiPointWaitTime |
| 0:1 | xs:duration | Additional wait time at origin of this trip. | |
| 0:1 | xs:duration | Additional wait time at destination of this trip. | ||
TripStatusGroup group
| Parameters which describe the current status of a TRIP | ||||
| 0:1 | Context to hold objects, which are referenced within the response. | |||
TripRefinementDataFilterGroup group
| Request data filters for Refinement | ||||
| TripRefinementDataFilter |
| 0:1 | Transport operators to include/exclude. | ||
TripRefineParamStructure
| Trip refinement request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | If true, then the request may contain object references from another system. Default is FALSE. | ||
| 0:* | xs:NMTOKEN | Refers to the legs to be refined by the server. If none is given, then all legs are open for refinement (depending if the relevant system can refine them). | ||
TripRefineParamStructure
| Trip refinement request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | If true, then the request may contain object references from another system. Default is FALSE. | ||
| 0:* | xs:NMTOKEN | Refers to the legs to be refined by the server. If none is given, then all legs are open for refinement (depending if the relevant system can refine them). | ||
| 0:1 | xs:normalizedString | System reference to use for the refinement. If not specified the origin system of each leg are used for the refinement. | ||
| 0:1 | Usage of real-time data in refinement. Default is "full". | |||
| TripRefinementDataFilter |
| 0:1 | Transport operators to include/exclude. | ||
| 0:1 | xs:boolean | Shall the legs be kept or can neighbours be recalculated in one go and changed. | ||
| 0:1 | xs:boolean | With refit, the leg is/legs are recalculated from the end point of the adjascent legs. If necessary new foot paths are added. | ||
| 0:1 | xs:boolean | Checks the availability of relevant legs depending on the mode/submode. Operators or system references must be set to do this (uses OJPAvailabilityRequest indirectly) | ||
| 0:1 | xs:normalizedString | System reference to use for the refinement. If not specified the origin system of each leg are used for the refinement. | ||
| 0:1 | Usage of real-time data in refinement. Default is "full". | |||
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include turn-by-turn instructions for each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include accessibility information. | ||
| 0:1 | xs:boolean | Whether the result should include the access features (stairs, elevator, etc.) on each path link. | ||
| 0:1 | xs:boolean | Whether the result should include real time status of access features to indicate broken equipment. | ||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired). | |||
| 0:1 | xs:boolean | Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true. | ||
| 0:1 | xs:boolean | Wheter the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
| none | service | stop | Possible types of reservation needed for services. |
| full | explanatory | none | |
| Not yet operated | Operation finished | At stop | Between stops | Vehicle progress relative to timetable service pattern. |
ServiceViaPointStructure
| [a specialisation of VIA in TMv6] STOP PLACE or SCHEDULED STOP POINT as a VIA for a particular SERVICE PATTERN. Specialisation of a VIA. | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| visualImpairment | auditoryImpairment | mobilityImpairment | bicycle | general | Allowed values for AccessibilityDetails. |
| none | service | stop | Possible types of reservation needed for services. |
| full | explanatory | none | |
| Not yet operated | Operation finished | At stop | Between stops | Vehicle progress relative to timetable service pattern. |
ServiceViaPointStructure
| [a specialisation of VIA in TMv6] STOP PLACE or SCHEDULED STOP POINT as a VIA for a particular SERVICE PATTERN. Specialisation of a VIA. | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
RouteDescriptionGroup group
| Descriptive text for a route, f.e. "Airport via City Centre" | ||||
| RouteDescription |
| 1:1 | |||
DatedJourneyGroup group
| Vehicle journey that runs at a specific date. | ||||
| DatedJourney | 1:1 | Reference to an Operating Day | |||
| 0:1 | →siri:VehicleRef | |||
| DatedJourney | 1:1 | Reference to an Operating Day. | |||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
| ScheduledJourney | 1:1 | Reference to a Journey | |||
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | ||
| 0:1 | siri:OperatorRefStructure | |||
| 0:1 | Link to web page providing more details on service. | |||
DatedJourneyStructure
| [equivalent to DATED VEHICLE JOURNEY in TMv6] passenger carrying VEHICLE JOURNEY for one specified DAY TYPE for which the pattern of working is in principle defined by a SERVICE JOURNEY PATTERN. DatedJourney details of a service include its operating days. | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
| DatedJourney | a | 1:1 | Reference to an Operating Day | ||
a |
| 0:1 | →siri:VehicleRef | ||
| DatedJourney | a | 1:1 | Reference to an Operating Day. | ||
a |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
| ScheduledJourney | a | 1:1 | Reference to a Journey | ||
a |
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | |
| 0:1 | xs:boolean | Whether this trip is cancelled and will not be run. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 0:1 | siri:OccupancyEnumeration | [equivalent to OCCUPANCY in SIRI] passenger load status of a VEHICLE. If omitted, not known. | ||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | Indicates whether this service needs some kind of reservation or booking to run. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
TripPlaceStructure
| A trip place represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip requests from within this service. A trip place does not(!) describe the relative position of a traveller within a vehicle, e.g. the seat. | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to an Operating Day | ||||
1:1 | Reference to a Journey | ||||
| |||||
TimeWindowGroup group
| The window of opportunity that the traveller has to perform this leg of the journey. | ||||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | Indicates whether this service needs some kind of reservation or booking to run. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
TripLocationStructure
| A trip location represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip requests from within this service. A trip location does not(!) describe the relative position of a traveller within a vehicle, e.g. the seat. | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to an Operating Day | ||||
1:1 | Reference to a Journey | ||||
| |||||
TimeWindowGroup group
| The window of opportunity that the traveller has to perform this leg of the journey. | ||||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
ServiceTimeGroup group
| Contains at least scheduled time, but can contain real time and estimated times | ||||
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
CallAtStopStructure
| [same as CALL in SIRI] the meeting of a VEHICLE JOURNEY with a specific SCHEDULED STOP POINT | ||||
The element contains a sequence of the following elements: | |||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| StopPoint |
| 1:1 | →siri:StopPointRef | Reference to a stop point. | |
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||
| 0:1 | Name of the bay where to board/alight from the vehicle. According to planned timetable. | |||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 0:1 | siri:OccupancyEnumeration | [equivalent to OCCUPANCY in SIRI] passenger load status of a VEHICLE. If omitted, not known. | ||
ContinuousServiceStructure
| [a special form of SERVICE JOURNEY in TMv6] a vehicle movement on a continuous, non-timetabled service. | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Continuous transport options. | ||
b |
| -1:1 | Individual transport options. | ||
Then, the element contains one of the following elements: | |||||
| DatedJourney | a | 1:1 | Reference to an Operating Day | ||
a |
| 0:1 | →siri:VehicleRef | ||
| DatedJourney | a | 1:1 | Reference to an Operating Day. | ||
a |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
| ScheduledJourney | a | 1:1 | Reference to a Journey | ||
a |
| 0:1 | xs:normalizedString | Public code of the SERVICE JOURNEY (same meaning as in NeTEx). Examples: "512", "S8" or "Circle Line" or "ICE 488". | |
a |
| 0:* | Note or service attribute. | ||
b |
| -0:1 | |||
b |
| -0:1 | Shared mobility offer. | ||
| ServiceOrigin |
| 0:1 | siri:StopPointRefStructure | First stop of the vehicle journey; origin stop point. | |
| 1:1 | Label for first stop. | |||
| ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 1:1 | Label for last stop. | |||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
VehiclePositionStructure
| Geographical and logical position of a vehicle. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | siri:LocationStructure | Geographic position of vehicle. | ||
| 0:1 | Logical progress of vehicle relative to service pattern. | |||
| 0:1 | siri:AbsoluteBearingType | Bearing in compass degrees in which vehicle is heading. | ||
| 0:1 | siri:ProgressBetweenStopsStructure | Provides information about the progress of the vehicle along its current link, that is link from previous visited top to current position. | ||
PlaceContextStructure
| [a view of PLACE in TMv6] a PLACE and access to it by individual transport | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Static place. | ||
b |
| -1:1 | Place within a (moving) vehicle. | ||
Then, the element contains one of the following elements: | |||||
a |
| -0:1 | xs:dateTime | Time when departure/arrival from/to place is required. | |
b |
| -0:1 | xs:duration | Extra time needed before reaching/after leaving this place. | |
| 0:* | Options how to access/leave the place by individual transport. | |||
NumberOfResultsGroup group
| parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set | ||||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
VehiclePositionStructure
| Geographical and logical position of a vehicle. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | siri:LocationStructure | Geographic position of vehicle. | ||
| 0:1 | Logical progress of vehicle relative to service pattern. | |||
| 0:1 | siri:AbsoluteBearingType | Bearing in compass degrees in which vehicle is heading. | ||
| 0:1 | siri:ProgressBetweenStopsStructure | Provides information about the progress of the vehicle along its current link, that is link from previous visited top to current position. | ||
PlaceContextStructure
| [a view of PLACE in TMv6] a PLACE and access to it by individual transport | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Static place. | ||
b |
| -1:1 | Location within a (moving) vehicle. | ||
Then, the element contains one of the following elements: | |||||
a |
| -0:1 | xs:dateTime | Time when departure/arrival from/to location is required. | |
b |
| -0:1 | xs:duration | Extra time needed before reaching/after leaving this location. | |
| 0:* | Options how to access/leave the place by individual transport. | |||
NumberOfResultsGroup group
| parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set | ||||
| NumberOfResults |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). | |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | ||
BaseTripPolicyGroup group
| Policies that control the trip search behaviour for both public and individual transport. | ||||
The element contains one of the following elements: | |||||
| NumberOfResults | a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). |
a |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). | |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| BaseTripPolicy | b |
| -0:1 | xs:positiveInteger | The number of trip results that the user wants to see at least. |
| 0:1 | The way real-time data should be used in the calculation of the trip. | |||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (f.e. because the user is already on the way) instead of finding the latest possible start opportunity. | ||
| 0:1 | xs:boolean | Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE. | ||
| 0:1 | xs:nonNegativeInteger | The maximum number of interchanges the user will accept per trip. | ||
The element contains one of the following elements: | |||||
a |
| -1:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | ||
b |
| -0:1 | The types of algorithm that should be used in the calculation of the trip. | ||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, walk). Default is FALSE. | ||
BaseTripMobilityFilterGroup group
| Base mobility options to be applied for both public and individual transport. | ||||
| BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to climb one step. | |
| 0:1 | xs:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to use an ramp. | ||
| 0:1 | xs:boolean | The user is not able to see. | ||
BaseTripContentFilterGroup group
| Parameters to control the level of detail of both public and individual transport journey results. | ||||
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include turn-by-turn instructions for each journey leg. | ||
| 0:1 | xs:boolean | Whether the result should include accessibility information. | ||
| 0:1 | xs:boolean | Whether the result should include the access features (stairs, elevator, etc.) on each path link. | ||
| 0:1 | xs:boolean | Whether the result should include real time status of access features to indicate broken equipment. | ||
| 0:* | Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired). | |||
| 0:1 | xs:boolean | Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true. | ||
| 0:1 | xs:boolean | Wheter the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true | ||
LegAttributeStructure
| Attributes that are not valid on the whole service, but only on section of a TRIP made on a single MODE without interchange between boarding and alighting (facilities available on a specified (part of a) Leg of a VEHICLE JOURNEY) | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:positiveInteger | The attribute is valid from the stop point with this sequence number within the leg. If missing it is valid from the beginning of the leg. | ||
| 0:1 | xs:positiveInteger | The attribute is valid to the stop point (inclusively) with this sequence number within the leg. If missing it is valid to the end of the leg. | ||
LegTrackStructure
| The LINK PROJECTION of a Leg onto the topography of the route being followed. | ||||
The element contains only one element: | |||||
| 1:* | LINK PROJECTION on the infrastructure network of the trip leg section together with time information. | |||
TrackSectionStructure
| LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Start place of this track. | |||
| 0:1 | End place of this track. | |||
| 0:1 | An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. | |||
| 0:1 | xs:string | Name of the road this track section is attached to. | ||
| 0:1 | xs:duration | Duration the passenger needs to travel through this track section. | ||
| 0:1 | siri:DistanceType | Length of this track section. | ||
| 0:1 | xs:anyType | |||
| AVAILIBILITY_NOSERIVCEFOUND | AVAILABILITY_LOCATIONUNSERVED | AVAILABILITY_LOCATIONUNKNOWN | AVAILABILITY_OUTSIDERULES | AVAILABILITY_SERVICEDISRUPTED | AVAILABILITY_UNAVAILABLE | AVAILABILITY_OTHER | Types of problems that may be returned in responses to AVAILABILITY requests. |
| wheelchair | motorisedWheelchair | foldableWheelchair | walkingFrame | pram | heavyLuggage | childSeatTakenAlong | childSeatSupplied | babyCarrierTakenAlong | babyCarrierSupplied | seatBoosterSupplied | bicycle | guideDog | dog | boardingAssistance | alightingAssistance | onboardAssistance | unassistedMinorAssistance | Types of bookable service items. |
AvailabilityRequestGroup group
| Availability request. Used to check the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY or SINGLE JOURNEY. Be aware that usually after the response arrives, the rest of the TRIP must be recalculated. As especially pickup and setdown locations may have shifted from where they were in the previously calculated TRIP. | ||||
LegTrackStructure
| The LINK PROJECTION of a Leg onto the topography of the route being followed. | ||||
The element contains only one element: | |||||
| 1:* | LINK PROJECTION on the infrastructure network of the leg section together with time information. | |||
TrackSectionStructure
| LINK PROJECTION on the infrastructure network of the LEG together with time information | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Start place of this track. | |||
| 0:1 | End place of this track. | |||
| 0:1 | An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. | |||
| 0:1 | xs:string | Name of the road this track section is attached to. | ||
| 0:1 | xs:duration | Duration the passenger needs to travel through this track section. | ||
| 0:1 | siri:DistanceType | Length of this track section. | ||
| 0:1 | xs:anyType | |||
| AVAILABILITY_NOSERVICEFOUND | AVAILABILITY_LOCATIONUNSERVED | AVAILABILITY_LOCATIONUNKNOWN | AVAILABILITY_OUTSIDERULES | AVAILABILITY_SERVICEDISRUPTED | AVAILABILITY_UNAVAILABLE | AVAILABILITY_OTHER | Types of problems that may be returned in responses to AVAILABILITY requests. |
| wheelchair | motorisedWheelchair | foldableWheelchair | walkingFrame | pram | heavyLuggage | childSeatTakenAlong | childSeatSupplied | babyCarrierTakenAlong | babyCarrierSupplied | seatBoosterSupplied | bicycle | guideDog | dog | boardingAssistance | alightingAssistance | onboardAssistance | unassistedMinorAssistance | Types of bookable service items. |
AvailabilityRequestGroup group
| Availability request. Used to check the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY or SINGLE JOURNEY. Be aware that usually after the response arrives, the rest of the TRIP must be recalculated. As especially pickup and setdown locations may have shifted from where they were in the previously calculated TRIP. | ||||
The element contains one of the following elements: | |||||
| AvailabilityRequest | a |
| -1:1 | Definition of the journey leg to be covered by public transport. Other mobility services can be added later. | |
| 1:* | Passenger(s) for whom the service needs to be booked, one MobilityUser per passenger. | |||
| MinMaxTimeBand |
| 0:1 | xs:dateTime | ||
| 0:1 | xs:dateTime | |||
| MinMaxTimeBand |
| 0:1 | xs:dateTime | Earliest possible departure time from start location. | |
| 0:1 | xs:dateTime | Latest possible arrival time at destination location. | ||
| AvailabilityRequest |
| 0:1 | xs:anyType | ||
BookingPTLegStructure
| Journey leg by public transport. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Location where passenger intends to enter the service. | |||
| 1:1 | Location where passenger intends to leave the service. | |||
| 0:1 | xs:boolean | Boarding will not be allowed at this stop of this journey. | ||
| 0:1 | xs:boolean | Alighting will not be allowed at this stop of this journey. | ||
MinMaxTimeBandGroup group
| Earliest possible departure time from a start location and latest possible arrival at a different destination location. | ||||
| MinMaxTimeBand |
| 0:1 | xs:dateTime | ||
| 0:1 | xs:dateTime | |||
| MinMaxTimeBand |
| 0:1 | xs:dateTime | Earliest possible departure time from start location. | |
| 0:1 | xs:dateTime | Latest possible arrival time at destination location. | ||
PassengerProfileGroup group
| Profile of the passenger's abilities. | ||||
| PassengerProfile |
| 0:1 | xs:boolean | Passenger uses a wheelchair. Default is FALSE. | |
| 0:1 | xs:boolean | Passenger uses a walking frame. Default is FALSE. | ||
| DriverAssistance |
| 0:1 | xs:boolean | Whether assistance is required for boarding. Could be offered by the driver or station staff. Default is FALSE. | |
| 0:1 | xs:boolean | Whether assistance is required for alighting. Could be offered by the driver or station staff. Default is FALSE. | ||
AvailabilityResponseGroup group
| Availability response. | ||||
| AvailabilityResponse |
| 0:1 | Indication of the availability of the requested service. | ||
| AvailabilityResponse |
| 0:1 | Context to hold availability response objects that occur frequently. | ||
| 0:1 | Indication of the availability of the requested service. | |||
| 0:1 | xs:anyType | |||
AvailabilityResultStructure
| Availability result structure. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this AVAILABILITY result. | |||
b |
| -1:1 | Definition of the journey leg that should be made by public transport. Other mobility services may be added later. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
| xs:NMTOKEN | Identifier of a Journey |
| xs:NMTOKEN | Identifier of an Operating Day |
| xs:NMTOKEN | identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE |
| xs:NMTOKEN | Type for identifier of an product category code. |
| singleStationBased | multipleStationBased | nonStationBased | Sharing service loan and return scheme. |
| Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | PublicHoliday | [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays |
ProblemDetailGroup group
| Detailed description of the problem. | ||||
| xs:NMTOKEN | Identifier of a Journey |
| xs:normalizedString | Type for identifier of a NeTEx Object. |
| xs:NMTOKEN | Identifier of an Operating Day |
| xs:NMTOKEN | identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE |
| xs:NMTOKEN | Type for identifier of an product category code. |
| singleStationBased | multipleStationBased | nonStationBased | Sharing service loan and return scheme. |
| Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | PublicHoliday | [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays |
ProblemDetailGroup group
| Detailed description of the problem. | ||||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
| DatedJourneyRef | 1:1 | Reference to a Journey | |||
1:1 | Reference to an Operating Day | ||||
TimedVehicleRefGroup group
| Reference to a vehicle for a specific point in time. | ||||
| TimedVehicleRef |
| 1:1 | →siri:VehicleRef | ||
| TimedVehicleRef |
| 1:1 | →siri:VehicleRef | Reference to vehicle. | |
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | ||
VehicleFilterStructure
| Filter for Vehicles | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether to include or exclude given VehicleRefs and TRAIN NUMBERS in the list from the search. Default is exclude. | ||
| 0:* | siri:VehicleRefStructure | Reference to VEHICLE | ||
| 0:* | xs:normalizedString | TRAIN NUMBERs | ||
SharingServiceUsageGroup group
| Usage parameters of a sharing service. | ||||
| SharingServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
ServiceFacilityGroup group
| Wrapper for SIRI service facilities. | ||||
| |||||
| walk | demandResponsive | replacementService | Types of cmodes that run at any time without a timetable. |
| walk | cycle | taxi | self-drive-car | others-drive-car | motorcycle | truck | scooter | ride-pool-car | car-sharing | cycle-sharing | scooter-sharing | modes which an individual powers themselves (such as walk, cycle) |
| carPooling | [a category of MODE in TMv6] MODEs offered by private individuals |
| walk | parkAndRide | bikeAndRide | carHire | bikeHire | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut | MODEs dedicated to peform TRANSFERs |
IndividualTransportOptionsStructure
| Individual modes and their usage limits as stated by the passenger | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Mode of individual transport. When mode self-drive-car is used the connection to another mode will need a parking space for the car. Thus, this mode is a generalisation of all park and ride use cases. The mode others-drive-car, however, only needs a place to let a person be set down from a car. | |||
| 0:1 | siri:DistanceType | Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Maximum duration. If given, it restricts the maximum time of routes with the given mode. | ||
| 0:1 | siri:DistanceType | Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Minimum duration. If given, it restricts the minimum time of routes with the given mode. | ||
| 0:1 | Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100). | |||
| 0:1 | xs:duration | Additional time added to the actual traveling time needed to use a specific mode. | ||
ModeStructure
| [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | ||||
The element contains a sequence of the following elements: | |||||
| walk | demandResponsive | replacementService | Types of cmodes that run at any time without a timetable. |
| walk | cycle | taxi | self-drive-car | others-drive-car | motorcycle | truck | scooter | ride-pool-car | car-sharing | cycle-sharing | scooter-sharing | park-ride-car | modes which an individual powers themselves (such as walk, cycle) |
| carPooling | [a category of MODE in TMv6] MODEs offered by private individuals |
| walk | parkAndRide | bikeAndRide | carHire | bikeHire | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut | MODEs dedicated to peform TRANSFERs |
IndividualTransportOptionsStructure
| Individual modes and their usage limits as stated by the passenger | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Mode of individual transport. When mode self-drive-car is used the connection to another mode will need a parking space for the car. Thus, this mode is a generalisation of all park and ride use cases. The mode others-drive-car, however, only needs a place to let a person be set down from a car. | |||
| 0:1 | siri:DistanceType | Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Maximum duration. If given, it restricts the maximum time of routes with the given mode. | ||
| 0:1 | siri:DistanceType | Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Minimum duration. If given, it restricts the minimum time of routes with the given mode. | ||
| 0:1 | Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100). | |||
| 0:1 | xs:duration | Additional time added to the actual traveling time needed to use a specific mode. | ||
ModeStructure
| [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | ||||
The element contains a sequence of the following elements: | |||||
| Mode |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of mode | |
| |||||
| 0:1 | Name of the mode. | |||
| 0:1 | Short name or acronym of the mode. | |||
| 0:1 | Additional text that further describes the mode. | |||
ModeGroup group
| Elements for a Transport Mode | ||||
| Mode |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of mode | |
| |||||
PtModeFilterStructure
| List of public transport modes ([from SIRI] mode of public transport service, corresponds to VEHICLE MODE) to exclude or include. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether VEHICLE MODEs in list are to be excluded or included from search. Default is to exclude. | ||
| 0:* | siri:VehicleModesOfTransportEnumeration | List of PT Transport modes to include/exclude. | ||
| |||||
PrivateModeFilterStructure
| List of private mobility offers to include or exclude. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether modes in list are to include or exclude from search. Default is exclude. | ||
| 0:* | List of private mobility offers to include/exclude. | |||
SituationsStructure
| Wrapper type for SIRI PtSituationsElementStructure | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | siri:PtSituationElementStructure | SIRI situation details. | ||
| 0:* | siri:RoadSituationElementStructure | |||
SituationFullRef
| Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
SituationFullRefStructure
| siri:SituationFullRefStructure | Reference structure for situation message. Situation details might be found in response context or through other communication channels. | |||
| Wrapper type for SIRI PtSituationsElementStructure | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | siri:PtSituationElementStructure | SIRI situation details in public transport, see CEN/TS 15531-5. | ||
| 0:* | siri:RoadSituationElementStructure | SIRI situation details in individual transport, see CEN/TS 15531-5. | ||
SituationFullRef
| Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
SituationFullRefStructure
| siri:SituationFullRefStructure | Reference structure for situation message. Situation details might be found in response context or through other communication channels. | |||
SituationRefList
| List of references to SITUATIONs. | ||||
The element contains only one element: | |||||
1:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| xs:normalizedString | Type definition for e-mail addresses. |
| xs:nonNegativeInteger | Data type for lengths, in meters. |
| xs:nonNegativeInteger | Percent value as integer, no upper limit. |
| xs:nonNegativeInteger | Percent value as integer, limited to max value 100. |
| xs:normalizedString | Type definition for phone numbers |
| xs:nonNegativeInteger | Data type for priority values, from 1 (highest) to 5 (lowest). |
| xs:string | sequence of bits (values 0 or 1) coded as a text string and representing days |
InternationalTextStructure
| [a restricted view of ALTERNATIVE NAME in TMv6] alternative identified text to be used in specified languages. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | siri:NaturalLanguageStringStructure | Text content. | ||
| 0:1 | xs:NMTOKEN | Id of this text. May be used for matching to pre-recorded audio files. | ||
WebLinkGroup group
| URL of a web resource including type of resource. | ||||