1. OJP.xsd - OJP messages as extension of SIRI
1.1. The toplevel element OJP
| Root element for OJP messages based on SIRI message exchange protocol. | ||||
| 1:1 | xs:NMTOKEN | Fixed value: "1.1-dev" | ||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a | -1:1 | OJP Request - Groups individual functional requests. | |||
b | -1:1 | OJP Request - Groups individual functional responses. | |||
0:1 | |||||
1.2. The toplevel element OJPRequest
| OJP Request - Groups individual functional requests. | ||||
1.3. The complex type OJPRequestStructure
| Type for OJP Request - Groups individual functional requests. | ||||
The element contains only one element: | |||||
1.4. The toplevel element OJPResponse
| OJP Request - Groups individual functional responses. | ||||
1.5. The complex type OJPResponseStructure
| Type for OJP Response - Groups individual functional responses. | ||||
The element contains only one element: | |||||
2. OJP/OJP_Common.xsd - Supporting definitions of common structures
2.1. Simple type definitions
| 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 |
2.2. The ProblemDetailGroup group
| Detailed description of the problem. | ||||
| +OJPFareRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.2. The complex type OJPFareRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
Then, 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. | |||
| 0:1 | →siri:Extensions | |||
2.3. The toplevel element OJPFareDelivery
| +OJPFareDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.4. The complex type OJPFareDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
The element contains a sequence of the following elements: | |||||
| 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. | |||
| FareResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | Fare result choice element. | |||
| 0:1 | →siri:Extensions | |||
2.5. The toplevel element OJPPlaceInformationRequest
| +OJPPlaceInformationRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.6. The complex type OJPPlaceInformationRequestStructure
| |||||
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. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
| 0:1 | →siri:Extensions | |||
2.7. The toplevel element OJPPlaceInformationDelivery
| +OJPPlaceInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.8. The complex type OJPPlaceInformationDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | ||
| 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 | |||
2.9. The toplevel element OJPExchangePointsRequest
| +OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.10. The complex type 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 | |||
| 0:1 | →siri:Extensions | |||
2.11. The toplevel element OJPExchangePointsDelivery
| +OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.12. The complex type OJPExchangePointsDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| 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:1 | →siri:Extensions | |||
2.13. The toplevel element OJPStopEventRequest
| +OJPStopEventRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.14. The complex type OJPStopEventRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| StopEventRequest |
| 1:1 | Place for which to obtain stop event information. | ||
| 0:1 | Request parameter | |||
| 0:1 | →siri:Extensions | |||
2.15. The toplevel element OJPStopEventDelivery
| +OJPStopEventDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.16. The complex type OJPStopEventDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| StopEventResponse |
| 0:1 | Container for data that is referenced multiple times. | ||
| 0:* | Enclosing element for stop event data. | |||
| 0:1 | →siri:Extensions | |||
2.17. The toplevel element OJPTripInfoRequest
| +OJPTripInfoRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.18. The complex type OJPTripInfoRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
| DatedJourneyRef | a | 1:1 | Reference to a Journey | ||
a | 1:1 | Reference to an Operating Day | |||
| TimedVehicleRef | b |
| 1:1 | →siri:VehicleRef | |
b |
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | |
| TripInfoRequest |
| 0:1 | Request parameter. | ||
| 0:1 | →siri:Extensions | |||
2.19. The toplevel element OJPTripInfoDelivery
| +OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.20. The complex type OJPTripInfoDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| TripInfoResponse |
| 0:1 | Response context. | ||
| 0:1 | Result structure. | |||
| 0:1 | →siri:Extensions | |||
2.21. The toplevel element OJPTripRequest
| +OJPTripRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.22. The complex type OJPTripRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| TripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
| 0:1 | →siri:Extensions | |||
2.23. The toplevel element OJPTripDelivery
| +OJPTripDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.24. The complex type OJPTripDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| TripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. | |||
| 0:1 | →siri:Extensions | |||
2.25. The toplevel element OJPMultiPointTripRequest
| +OJPMultiPointTripRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.26. The complex type OJPMultiPointTripRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| MultiPointTripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
| 0:1 | →siri:Extensions | |||
2.27. The toplevel element OJPMultiPointTripDelivery
| +OJPMultiPointTripDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.28. The complex type OJPMultiPointTripDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| MultiPointTripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. | |||
| 0:1 | →siri:Extensions | |||
2.29. The toplevel element OJPTripRefineRequest
| +OJPTripRefineRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.30. The complex type OJPTripRefineRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| TripRefineRequest |
| 0:1 | Options to control the refine | ||
| 1:1 | The trip result to be refined by the server. | |||
| 0:1 | Context to hold objects, which are referenced within the response. | |||
| 0:1 | →siri:Extensions | |||
2.31. The toplevel element OJPTripRefineDelivery
| +OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.32. The complex type OJPTripRefineDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| TripRefineResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | xs:NMTOKEN | Refers to a leg that was not found in the data of the server. If the to be refined TripResult could not be found or unequivocally determined, all RefineLegRefs are returned as UnknownLegRefs. | ||
| 0:* | The trip results refined by the server. | |||
| 0:1 | →siri:Extensions | |||
2.33. The toplevel element OJPAvailabilityRequest
| +OJPAvailabilityRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.34. The complex type OJPAvailabilityRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
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 | |||
| AvailabilityRequest |
| 0:1 | xs:anyType | ||
| 0:1 | →siri:Extensions | |||
2.35. The toplevel element OJPAvailabilityDelivery
| +OJPAvailabilityDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.36. The complex type OJPAvailabilityDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
The element contains a sequence of the following elements: | |||||
| 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. | |||
| AvailabilityResponse |
| 0:1 | Indication of the availability of the requested service. | ||
| 0:1 | xs:anyType | |||
| 0:1 | →siri:Extensions | |||
2.37. The toplevel element OJPLineInformationRequest
| +OJPLineInformationRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.38. The complex type OJPLineInformationRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | ||||
| 0:1 | →siri:Extensions | |||
2.39. The toplevel element OJPLineInformationDelivery
| +OJPLineInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
2.40. The complex type OJPLineInformationDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
The element contains a sequence of the following elements: | |||||
0:1 | |||||
| LineInformationResponse |
| 0:* | |||
| 0:1 | →siri:Extensions | |||
3. OJP/OJP_RequestSupport.xsd - Supporting definitions for OJP service requests and their responses
3.1. Simple type definitions
| xs:integer | Type definition for calculation time in milliseconds. |
| xs:NMTOKEN | Type definition for the form of identification that can be used as a Message Integrity Property (public key cryptography) |
| OJPGENERIC_REQUESTNOTSUPPORTED | OJPGENERIC_FEATURENOTSUPPORTED | OJPGENERIC_LANGUAGENOTSUPPORTED | OJPGENERIC_EXCEPTIONFROMREQUESTEDLANGUAGE | OJPGENERIC_DATAFRAMEREFNOTAVAILABLE | OJPGENERIC_OTHER | Types of problems that may be returned in case of generic problems with the request. |
| xs:string | data for transmission of message signatures (public key cryptography), used to prove Message Integrity |
3.2. The MessageIntegrityPropertiesGroup group
| Properties that allow checks for message integrity. | ||||
| 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) | |||
3.3. The ServiceRequestContextGroup group
| Generic context for all request messages. | ||||
| 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 | |||
3.4. The ServiceResponseContextGroup group
| Generic context for all response messages. | ||||
| 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. | |||
3.5. The complex type 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 | |||
3.6. The complex type PlacesStructure
| Structure providing a collection of places. | ||||
The element contains only one element: | |||||
| 1:* | ||||
3.7. The complex type 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 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. | |||
3.8. The complex type 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. | ||
2.3. The complex type PrivateCodeStructure
| Code within scope of a private referential system | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Code of the foreign referential system. | ||
| 1:1 | xs:NMTOKEN | Object code within this private/foreign system. | ||
2.4. The complex type LinkProjectionStructure
| An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. | ||||
The element contains only one element: | |||||
| 2:* | siri:LocationStructure | Ordered list of locations representing the geogemtry of the link. | ||
2.5. The complex type AreaStructure
| Area described as a polygon. | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | Ordered list of geographic locations describing the polygon of the area. | ||
2.6. The toplevel element ParticipantRef
| siri:ParticipantRefStructure | Reference to a Participant ([equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)) | |||
2.7. The toplevel element OperatorRef
| siri:OperatorRefStructure | Reference to an Operator ([TMv6] company providing public transport services.) | |||
2.8. The complex type OperatorFilterStructure
| Filter for in/exclusion of transport operators. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether operators in list are to include or exclude from search. Default is exclude. | ||
| 0:* | siri:OperatorRefStructure | Reference to transport operator | ||
2.9. The complex type ProductCategoryRefStructure
| Reference to a product category. As defined in NeTEx and SIRI, a product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products, e.g. to identify boats that run with steam in Switzerland ("BAV") | ||||
2.10. The toplevel element ProductCategoryRef
| siri:ProductCategoryRefStructure | Reference to a product category. Product categories should be defined once and used uniformly in all channels (e.g. NeTEx, SIRI, OJP) | |||
2.11. The complex type LineDirectionFilterStructure
| Filter for in/exclusion of lines (and directions). | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | siri:LineDirectionStructure | Reference a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables.. | ||
| 0:1 | xs:boolean | Whether lines in list are to include or exclude from search. Default is exclude. | ||
2.12. The complex type JourneyRefStructure
| Reference to a Journey | ||||
2.13. The toplevel element JourneyRef
| Reference to a Journey | ||||
2.14. The DatedJourneyRefGroup group
| Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day) | ||||
| DatedJourneyRef | 1:1 | Reference to a Journey | |||
1:1 | Reference to an Operating Day | ||||
2.15. The TimedVehicleRefGroup group
| Reference to a vehicle for a specific point in time. | ||||
| TimedVehicleRef |
| 1:1 | →siri:VehicleRef | ||
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | ||
2.16. The complex type 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 | ||
2.17. The 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. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. | ||
2.18. The complex type SharingServiceStructure
| Service that provides shared vehicles. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:OperatorRefStructure | Identifier of the operator of the sharing service | ||
| 0:1 | xs:string | Public name of the service. | ||
| 0:1 | Type of the sharing scheme. | |||
| SharingServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. | ||
| 0:1 | Link to web page providing more details on service. | |||
2.19. The complex type OwnerRefStructure
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
2.20. The toplevel element OwnerRef
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
2.21. The complex type OperatingDayRefStructure
| Reference to an Operating Day | ||||
2.22. The toplevel element OperatingDayRef
| Reference to an Operating Day | ||||
2.23. The complex type OperatingDaysStructure
| [TMv6] day of public transport operation of which the characteristics are defined in a specific SERVICE CALENDAR and which may last more than 24 hours. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:date | Start date of period. | ||
| 1:1 | xs:date | End date of period. | ||
| 1:1 | Bit pattern for operating days between start date and end date. The length of the pattern is equal to the number of days from start date to end date. A bit value of "1" indicates that an event actually happens on the day that is represented by the bit position. | |||
2.24. The OperatingDaysGroup group
| Coded as bit pattern | ||||
| 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". | |||
2.25. The complex type WeekdayTimePeriodStructure
| [a specialisation of TIME BAND in TMv6] aggregation of TIME BAND and DAY OF WEEK (Time period on a weekday). | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays | |||
| 1:1 | xs:time | Start time of period. | ||
| 1:1 | xs:duration | Time duration of period. | ||
2.26. The complex type GeneralAttributeStructure
| Structured attribute classification with associated text. If URL is given, it refers to the whole attribute text. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Text of the attribute to be shown to the user. | |||
| 1:1 | xs:NMTOKEN | Internal code of the attribute. Can be used for detection of double occurrences. | ||
| |||||
| 0:1 | xs:boolean | Defines whether the attribute has to be shown to the user. | ||
| 0:1 | Importance of the attribute. | |||
| WebLink |
| 1:1 | xs:anyURI | URL to resource on web. | |
| 0:1 | xs:normalizedString | MIME type of the referenced resource. To which kind of resource does the URL point to? | ||
| 0:1 | xs:boolean | Is the referenced resource meant to be embedded as a webview in a surrounding context, e.g. app or web page? If yes, the resource has to be fully responsive. Default is false. | ||
3. OJP/OJP_FacilitySupport.xsd - Supporting definitions for facilities containing wrappers for SIRI
3.1. The AllFacilitiesGroup group
| Wrapper for SIRI facilities. | ||||
| |||||
3.2. The StopFacilityGroup group
| Wrapper for SIRI stop facilities. | ||||
| |||||
3.3. The ServiceFacilityGroup group
| Wrapper for SIRI service facilities. | ||||
| |||||
4. OJP/OJP_Fare.xsd - Request and response definitions for general, stop-specific and trip-specific fare information
4.1. The FareRequestGroup group
| 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. | |||
| FareResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | Fare result choice element. | |||
4.7. The complex type 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. | ||
4.8. The complex type 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 | |||
4.9. The complex type 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 | |||
4.10. The complex type 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. | ||
4.11. The complex type 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. | |||
5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
5.1. Simple type definitions
| 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 |
| 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: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 |
5.2. The complex type 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). | ||||
5.3. The toplevel element FareAuthorityRef
| Reference to a Fare Authority. | ||||
5.4. The FareAuthorityGroup group
| Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 |
| 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: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 |
5.2. The complex type 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). | ||||
5.3. The toplevel element FareAuthorityRef
| Reference to a Fare Authority. | ||||
5.4. The 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. | ||
5.6. The toplevel element TariffZoneRef
| Reference to a fare zone. | ||||
5.7. The complex type 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. | ||
5.8. The complex type 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. | |||
5.9. The complex type 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. | ||||
5.10. The complex type BookingArrangementStructure
| [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Name of the booking agency (contractual partner). | |||
| 0:1 | URL to online booking service. | |||
| 0:1 | URL to information page. | |||
| 0:1 | Phone number for booking. | |||
| 0:1 | xs:duration | Minimum duration bookings must be completed before trip starts. | ||
| 0:1 | xs:anyType | |||
5.11. The complex type BookingArrangementsContainerStructure
| Container for multiple booking arrangements. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey. | |||
| 0:1 | xs:anyType | |||
5.12. The complex type FareProductRefStructure
| Reference to a FareProduct. | ||||
5.13. The toplevel element FareProductRef
| Reference to a FareProduct. | ||||
5.14. The complex type EntitlementProductListStructure
| A list of ENTITLEMENT PRODUCTs | ||||
The element contains only one element: | |||||
| 1:* | [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | |||
5.15. The complex type EntitlementProductStructure
| [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to the fare authority that issued the ENTITLEMENT PRODUCT | ||||
| 1:1 | Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...) | |||
| 0:1 | siri:HalfOpenTimestampOutputRangeStructure | Validity period of the ENTITLEMENT PRODUCT | ||
| 1:1 | xs:string | Name of the ENTITLEMENT PRODUCT | ||
5.16. The complex type FareProductStructure
| [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Unique Id of the FareProduct. | |||
| 1:1 | xs:string | printable FareProduct name | ||
| 1:* | Fare zone in area. | |||
5.9. The complex type 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. | ||||
5.10. The complex type BookingArrangementStructure
| [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Name of the booking agency (contractual partner). | |||
| 0:1 | URL to online booking service. | |||
| 0:1 | URL to information page. | |||
| 0:1 | Phone number for booking. | |||
| 0:1 | xs:duration | Minimum duration bookings must be completed before trip starts. | ||
| 0:1 | xs:anyType | |||
5.11. The complex type BookingArrangementsContainerStructure
| Container for multiple booking arrangements. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey. | |||
| 0:1 | xs:anyType | |||
5.12. The complex type FareProductRefStructure
| Reference to a FareProduct. | ||||
5.13. The toplevel element FareProductRef
| Reference to a FareProduct. | ||||
5.14. The complex type EntitlementProductListStructure
| A list of ENTITLEMENT PRODUCTs | ||||
The element contains only one element: | |||||
| 1:* | [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | |||
5.15. The complex type EntitlementProductStructure
| [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to the fare authority that issued the ENTITLEMENT PRODUCT | ||||
| 1:1 | Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...) | |||
| 0:1 | siri:HalfOpenTimestampOutputRangeStructure | Validity period of the ENTITLEMENT PRODUCT | ||
| 1:1 | xs:string | Name of the ENTITLEMENT PRODUCT | ||
5.16. The complex type FareProductStructure
| [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Identifier of a FareProduct | |||
| 1:1 | xs:string | Printable FareProduct name | ||
| FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
| 0:1 | xs:boolean | Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/ | ||
| 0:1 | xs:boolean | Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/ | ||
| FareProductPrice |
| 0:1 | xs:decimal | FareProduct price as decimal number. | |
| 0:1 | xs:decimal | Net FareProduct price as decimal number for accounting purposes. | ||
| 0:1 | xs:NMTOKEN | iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
6. OJP/OJP_JourneySupport.xsd - Supporting definitions for journeys on public transport vehicles
6.1. Simple type definitions
| none | service | stop | Possible types of reservation needed for services. |
| Not yet operated | Operation finished | At stop | Between stops | Vehicle progress relative to timetable service pattern. |
6.2. The complex type 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: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Line Information response group. | ||||
| LineInformationResponse |
| 0:* | |||
6.2. The complex type 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. | ||
7. OJP/OJP_Places.xsd - Request and response definitions for place information
7.1. Simple type definitions
| stop | address | poi | coord | location | topographicPlace | |
| origin | via | destination |
7.2. The 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. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
7.3. The PlaceInformationResponseGroup group
| |||||
| PlaceInformationResponse |
| 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:* | ||||
7.4. The complex type 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:* | 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/ | ||
7.5. The complex type 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:1 | Filter to narrow down POI searches. | |||
| 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. | ||
| 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. | ||
| 0:1 | xs:boolean | Tells the service to include the available public transport modes at returned stops. | ||
7.6. The complex type GeoRestrictionsStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Area is defined by a polyline | ||
b |
| -1:1 | |||
c |
| -1:1 | |||
7.7. The complex type GeoCircleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:DistanceType | Radius in metres. | ||
7.8. The complex type GeoRectangleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:LocationStructure | |||
7.9. The complex type 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 | |||
7.10. The complex type 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. | |||
| 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. | ||
7.11. The PlacePolicyGroup group
| |||||
| 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. | ||
| 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. | ||
| 0:1 | xs:boolean | Tells the service to include the available public transport modes at returned stops. | ||
7.12. The 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. | |||
| 0:1 | Filter to narrow down POI searches. | |||
7.13. The 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 | |||
7.14. The complex type 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. | |||
| 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: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. | ||
7.15. The 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. | |||
| 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. | ||
7.16. The ExchangePointsPolicyGroup group
| |||||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | |||
| 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. | ||
7.17. The ExchangePointsResponseGroup group
| |||||
| 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:* | ||||
7.18. The complex type 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. | ||
8. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information
8.1. Simple type definitions
| 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_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 |
8.2. The StopPointGroup group
| A stop point with id and name | ||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| 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:1 | Priority of this via point to be displayed when space is limited. | |||
6.3. The complex type ProductCategoryStructure
| Product category based on NeTEx/SIRI. A product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Full name of this product category, e.g. "Autoreisezug" in Switzerland or "Dampfschiff" | |||
| 0:1 | Short name or acronym of the product category, likely to be published, e.g. "BAV", "ARZ", "TGV". The product category is more important for publication in Switzerland than Mode / Submode. | |||
0:1 | A reference to the product category. This is the internal code used within the reference frameworks (NeTEx, SIRI). It is usually not displayed, but interpreted by the technical system, e.g. "ch:1:TypeOfProductCategory:ARZ" (Autoreisezug in Switzerland) or "ch:1:TypeOfProductCategory:BAV". | ||||
6.4. The complex type TripViaStructure
| VIA restrictions for a TRIP. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Reference to specify the via place. | |||
| 0:1 | xs:duration | Duration the passenger wants to stay at the via place. Default is 0. | ||
6.5. The ScheduledJourneyGroup group
| Vehicle journey (not dated). | ||||
| 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". | ||
| |||||
| Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
6.6. The ServiceGroup group
| Properties of a service (line and direction): attributes of Continuous Journey Structure or Dated Journey Structure. | ||||
| |||||
| Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
6.7. The ServiceOriginGroup group
| First serviced stop of a vehicle journey. | ||||
| ServiceOrigin |
| 0:1 | siri:StopPointRefStructure | First stop of the vehicle journey; origin stop point. | |
| 1:1 | Label for first stop. | |||
6.8. The ServiceDestinationGroup group
| Last serviced stop of a vehicle journey. | ||||
| ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 1:1 | Label for last stop. | |||
6.9. The RouteDescriptionGroup group
| Descriptive text for a route, f.e. "Airport via City Centre" | ||||
| RouteDescription |
| 1:1 | |||
6.10. The DatedJourneyGroup group
| Vehicle journey that runs at a specific date. | ||||
| DatedJourney | 1:1 | Reference to an Operating Day | |||
| 0:1 | →siri:VehicleRef | |||
| 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". | ||
| |||||
| Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
6.11. The PrivateServiceGroup group
| specific service operated by a Private Mode | ||||
| PrivateService | 0:1 | Reference to a Journey | |||
| 1:1 | [a category of MODE in TMv6] MODEs offered by private individuals | |||
| 0:1 | siri:OperatorRefStructure | |||
| 0:1 | Link to web page providing more details on service. | |||
6.12. The complex type 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 | ||
| 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". | |
| |||||
| Service | a |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs |
a |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | ||
a |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | |
a |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
| PrivateService | b | 0:1 | Reference to a Journey | ||
b |
| 1:1 | [a category of MODE in TMv6] MODEs offered by private individuals | ||
b |
| 0:1 | siri:OperatorRefStructure | ||
b |
| 0:1 | Link to web page providing more details on service. | ||
| 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. | |||
| ServiceStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
6.13. The complex type 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 | ||||
| |||||
6.14. The 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. | ||
6.15. The ServiceTimeGroup group
| Contains at least scheduled time, but can contain real time and estimated times | ||||
| ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
| EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
6.16. The EstimatedTimeBandGroup group
| Range for estimated time. | ||||
| EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
6.17. The complex type ServiceArrivalStructure
| Arrival times of a service at a stop (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | ||||
The element contains only one element: | |||||
| ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
| EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
6.18. The complex type ServiceDepartureStructure
| Departure times of a service at a stop (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | ||||
The element contains only one element: | |||||
| ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
| EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
6.19. The complex type 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 | ||
| 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:1 | Arrival times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | |||
| 0:1 | Departure times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | |||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
6.20. The StopCallStatusGroup group
| Status properties for the vehicle call at this stop. | ||||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
6.21. The ServiceStatusGroup group
| parameters which describe the current status of a DATED VEHICLE JOURNEY | ||||
| ServiceStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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. | ||
6.22. The complex type 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 | ||
| 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". | |
| |||||
| Service | a |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs |
a |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | ||
a |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | |
a |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
b |
| -0:1 | |||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
6.23. The complex type 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. | ||
6.24. The complex type 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. | |||
6.25. The 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). | ||
6.26. The 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
6.27. The 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 escalator. | ||
| 0:1 | xs:boolean | The user is not able to use an elevator. | ||
| 0:1 | xs:boolean | The user is not able to use an ramp. | ||
| 0:1 | xs:boolean | The user is not able to see. | ||
6.28. The 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. | |
| 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 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 | ||
6.29. The complex type 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. | ||
6.30. The complex type 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. | |||
6.31. The complex type 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 | |||
7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport
7.1. Simple type definitions
| 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 |
7.2. The complex type 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. | ||
7.3. The complex type 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. | |||
7.4. The ModeGroup group
| Elements for a Transport Mode | ||||
| Mode |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of mode | |
| |||||
7.5. The complex type 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. | ||
| |||||
7.6. The complex type 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. | |||
8. OJP/OJP_Places.xsd - Request and response definitions for place information
8.1. Simple type definitions
| stop | address | poi | coord | location | topographicPlace | |
| origin | via | destination |
8.2. The 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. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
8.3. The PlaceInformationResponseGroup group
| |||||
| PlaceInformationResponse |
| 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:* | ||||
8.4. The complex type 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:* | 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/ | ||
8.5. The complex type 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:1 | Filter to narrow down POI searches. | |||
| 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. | ||
| 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. | ||
| 0:1 | xs:boolean | Tells the service to include the available public transport modes at returned stops. | ||
8.6. The complex type GeoRestrictionsStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Area is defined by a polyline | ||
b |
| -1:1 | |||
c |
| -1:1 | |||
8.7. The complex type GeoCircleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:DistanceType | Radius in metres. | ||
8.8. The complex type GeoRectangleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:LocationStructure | |||
8.9. The complex type 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 | |||
8.10. The complex type 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. | |||
| 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. | ||
8.11. The PlacePolicyGroup group
| |||||
| 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. | ||
| 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. | ||
| 0:1 | xs:boolean | Tells the service to include the available public transport modes at returned stops. | ||
8.12. The 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. | |||
| 0:1 | Filter to narrow down POI searches. | |||
8.13. The 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 | |||
8.14. The complex type 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. | |||
| 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: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. | ||
8.15. The 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. | |||
| 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. | ||
8.16. The ExchangePointsPolicyGroup group
| |||||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | |||
| 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. | ||
8.17. The ExchangePointsResponseGroup group
| |||||
| 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:* | ||||
8.18. The complex type 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. | ||
9. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information
9.1. Simple type definitions
| 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_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 |
9.2. The StopPointGroup group
| A stop point with id and name | ||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| 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. | |||
9.3. The complex type 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: | |||||
8.3. The complex type 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 | ||
| 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". | |||
| 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. | ||
9.4. The complex type StopPlaceRefStructure
| Reference to a Stop Place | ||||
9.5. The toplevel element StopPlaceRef
| Reference to a Stop Place | ||||
9.6. The StopPlaceGroup group
| A stop place with id and name | ||||
8.4. The complex type StopPlaceRefStructure
| Reference to a Stop Place | ||||
8.5. The toplevel element StopPlaceRef
| Reference to a Stop Place | ||||
8.6. The StopPlaceGroup group
| A stop place with id and name | ||||
| 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". | |||
9.7. The complex type StopPlaceStructure
| [an extended view of STOP PLACE in TMv6] a PLACE extended by ACCESSIBILITY LIMITATION properties and some attributes of the associated equipment, comprising one or more locations where vehicles may stop and where passengers may board or leave vehicles or prepare their trip, and which will usually have one or more wellknown names | ||||
The element contains a sequence of the following elements: | |||||
8.7. The complex type StopPlaceStructure
| [an extended view of STOP PLACE in TMv6] a PLACE extended by ACCESSIBILITY LIMITATION properties and some attributes of the associated equipment, comprising one or more locations where vehicles may stop and where passengers may board or leave vehicles or prepare their trip, and which will usually have one or more wellknown names | ||||
The element contains a sequence of the following elements: | |||||
| 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". | |||
| 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. | ||
9.8. The StopAttributesGroup group
| [properties of a SCHEDULED STOP POINT or STOP PLACE in TMv6] selection of attributes of ACCESSIBIITY LIMITATION related to a SCHEDULED STOP POINT extended by attributes referring to some equipment. | ||||
8.8. The StopAttributesGroup group
| [properties of a SCHEDULED STOP POINT or STOP PLACE in TMv6] selection of attributes of ACCESSIBIITY LIMITATION related to a SCHEDULED STOP POINT extended by attributes referring to some equipment. | ||||
| 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. | ||
9.9. The complex type TopographicPlaceRefStructure
9.10. The toplevel element TopographicPlaceRef
| Reference to a TopographicPlace | ||||
9.11. The complex type 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 | xs:normalizedString | 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. | ||
9.12. The complex type PointOfInterestRefStructure
| Reference to a Point of Interest | ||||
9.13. The toplevel element PointOfInterestRef
| Reference to a Point of Interest | ||||
9.14. The complex type 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 | ||||
9.15. The complex type 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]") | |
9.16. The complex type 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, ...) | ||
9.17. The complex type 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). | |||
9.18. The complex type AddressRefStructure
| Reference to an Address | ||||
9.19. The toplevel element AddressRef
| Reference to an Address | ||||
9.20. The AddressDetailGroup group
| An address with its name entities | ||||
8.9. The complex type TopographicPlaceRefStructure
8.10. The toplevel element TopographicPlaceRef
| Reference to a TopographicPlace | ||||
8.11. The complex type 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 | xs:normalizedString | 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. | ||
8.12. The complex type PointOfInterestRefStructure
| Reference to a Point of Interest | ||||
8.13. The toplevel element PointOfInterestRef
| Reference to a Point of Interest | ||||
8.14. The complex type 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 | ||||
8.15. The complex type 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]") | |
8.16. The complex type 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, ...) | ||
8.17. The complex type 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). | |||
8.18. The complex type AddressRefStructure
| Reference to an Address | ||||
8.19. The toplevel element AddressRef
| Reference to an Address | ||||
8.20. The 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 | 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. | ||
9.21. The complex type 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". | |||
8.21. The complex type 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 | 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. | ||
9.22. The complex type 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:* | Attribute associated with this place. | |||
| 0:1 | xs:anyType | |||
9.23. The complex type 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/ | ||
9.24. The complex type 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. | |||
8.22. The complex type 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:* | Attribute associated with this place. | |||
| 0:1 | xs:anyType | |||
8.23. The complex type 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/ | ||
8.24. The complex type 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. | ||
9.25. The complex type 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. | |||
8.25. The complex type 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. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
10. OJP/OJP_Requests.xsd - OJP service requests and responses
10.1. The toplevel element OJPFareRequest
| +OJPFareRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
10.2. The complex type OJPFareRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
Then, 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. | |||
| 0:1 | →siri:Extensions | |||
10.3. The toplevel element OJPFareDelivery
| +OJPFareDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
10.4. The complex type OJPFareDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
The element contains a sequence of the following elements: | |||||
| 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. | |||
| FareResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | Fare result choice element. | |||
| 0:1 | →siri:Extensions | |||
10.5. The toplevel element OJPPlaceInformationRequest
| +OJPPlaceInformationRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
10.6. The complex type OJPPlaceInformationRequestStructure
| |||||
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. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
| 0:1 | →siri:Extensions | |||
10.7. The toplevel element OJPPlaceInformationDelivery
| +OJPPlaceInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
10.8. The complex type OJPPlaceInformationDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | ||
| 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 | |||
10.9. The toplevel element OJPExchangePointsRequest
| +OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
10.10. The complex type 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 | |||
| 0:1 | →siri:Extensions | |||
10.11. The toplevel element OJPExchangePointsDelivery
| +OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
10.12. The complex type OJPExchangePointsDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| 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:1 | →siri:Extensions | |||
10.13. The toplevel element OJPStopEventRequest
| +OJPStopEventRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
10.14. The complex type OJPStopEventRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| StopEventRequest |
| 1:1 | Place for which to obtain stop event information. | ||
| 0:1 | Request parameter | |||
| 0:1 | →siri:Extensions | |||
10.15. The toplevel element OJPStopEventDelivery
| +OJPStopEventDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
10.16. The complex type OJPStopEventDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| StopEventResponse |
| 0:1 | Container for data that is referenced multiple times. | ||
| 0:* | Enclosing element for stop event data. | |||
| 0:1 | →siri:Extensions | |||
10.17. The toplevel element OJPTripInfoRequest
| +OJPTripInfoRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
10.18. The complex type OJPTripInfoRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
| DatedJourneyRef | a | 1:1 | Reference to a Journey | ||
a | 1:1 | Reference to an Operating Day | |||
| TimedVehicleRef | b |
| 1:1 | →siri:VehicleRef | |
b |
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | |
| TripInfoRequest |
| 0:1 | Request parameter. | ||
| 0:1 | →siri:Extensions | |||
10.19. The toplevel element OJPTripInfoDelivery
| +OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
10.20. The complex type OJPTripInfoDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| TripInfoResponse |
| 0:1 | Response context. | ||
| 0:1 | Result structure. | |||
| 0:1 | →siri:Extensions | |||
10.21. The toplevel element OJPTripRequest
| +OJPTripRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
10.22. The complex type OJPTripRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| TripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
| 0:1 | →siri:Extensions | |||
10.23. The toplevel element OJPTripDelivery
| +OJPTripDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
10.24. The complex type OJPTripDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| TripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. | |||
| 0:1 | →siri:Extensions | |||
10.25. The toplevel element OJPMultiPointTripRequest
| +OJPMultiPointTripRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
10.26. The complex type OJPMultiPointTripRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| MultiPointTripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
| 0:1 | →siri:Extensions | |||
10.27. The toplevel element OJPMultiPointTripDelivery
| +OJPMultiPointTripDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
10.28. The complex type OJPMultiPointTripDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| MultiPointTripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. | |||
| 0:1 | →siri:Extensions | |||
10.29. The toplevel element OJPTripRefineRequest
| +OJPTripRefineRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
10.30. The complex type OJPTripRefineRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| TripRefineRequest |
| 0:1 | Options to control the refine | ||
| 1:1 | The trip result to be refined by the server. | |||
| 0:1 | Context to hold objects, which are referenced within the response. | |||
| 0:1 | →siri:Extensions | |||
10.31. The toplevel element OJPTripRefineDelivery
| +OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery) | ||||
10.32. The complex type OJPTripRefineDeliveryStructure
| siri:AbstractServiceDeliveryStructure | ||||
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. | |||
| TripRefineResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | xs:NMTOKEN | Refers to a leg that was not found in the data of the server. If the to be refined TripResult could not be found or unequivocally determined, all RefineLegRefs are returned as UnknownLegRefs. | ||
| 0:* | The trip results refined by the server. | |||
| 0:1 | →siri:Extensions | |||
11. OJP/OJP_RequestSupport.xsd - Supporting definitions for OJP service requests and their responses
11.1. Simple type definitions
| xs:integer | Type definition for calculation time in milliseconds. |
| xs:NMTOKEN | Type definition for the form of identification that can be used as a Message Integrity Property (public key cryptography) |
| OJPGENERIC_REQUESTNOTSUPPORTED | OJPGENERIC_FEATURENOTSUPPORTED | OJPGENERIC_LANGUAGENOTSUPPORTED | OJPGENERIC_EXCEPTIONFROMREQUESTEDLANGUAGE | OJPGENERIC_DATAFRAMEREFNOTAVAILABLE | OJPGENERIC_OTHER | Types of problems that may be returned in case of generic problems with the request. |
| xs:string | data for transmission of message signatures (public key cryptography), used to prove Message Integrity |
11.2. The MessageIntegrityPropertiesGroup group
| Properties that allow checks for message integrity. | ||||
| 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) | |||
11.3. The ServiceRequestContextGroup group
| Generic context for all request messages. | ||||
| 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 | |||
11.4. The ServiceResponseContextGroup group
| Generic context for all response messages. | ||||
| 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. | |||
11.5. The complex type 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 | |||
11.6. The complex type PlacesStructure
| Structure providing a collection of places. | ||||
The element contains only one element: | |||||
| 1:* | ||||
11.7. The complex type 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 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. | |||
11.8. The complex type 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. | ||
12. OJP/OJP_SituationSupport.xsd - Supporting definitions for situations containing wrappers for SIRI Situation Exchange service (SIRI SX)
12.1. The complex type SituationsStructure
| Wrapper type for SIRI PtSituationsElementStructure | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | siri:PtSituationElementStructure | SIRI situation details. | ||
| 0:* | siri:RoadSituationElementStructure | |||
12.2. The toplevel element SituationFullRef
| Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
12.3. The complex type SituationFullRefStructure
| siri:SituationFullRefStructure | Reference structure for situation message. Situation details might be found in response context or through other communication channels. | |||
13. OJP/OJP_StopEvents.xsd - Request and response definitions for arrivals and departures of public transport services at stops
13.1. Simple type definitions
| local | no | down | all | + 9. OJP/OJP_StopEvents.xsd - Request and response definitions for arrivals and departures of public transport services at stops9.1. Simple type definitions
13.2. The | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request structure for departure and arrival events at stops | ||||
| 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 | |||
9.2. The StopEventRequestGroup group
| Request structure for departure and arrival events at stops | ||||
| StopEventRequest |
| 1:1 | Place for which to obtain stop event information. | ||
| 0:1 | Request parameter | |||
13.3. The complex type 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: | |||||
9.3. The complex type 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. | ||
| 0:1 | Lines/Directions to include/exclude. | |||
| 0:1 | Transport operators to include/exclude. | |||
13.4. The StopEventDataFilterGroup group
| Request data filters | ||||
9.4. The StopEventDataFilterGroup group
| Request data filters | ||||
| StopEventDataFilter |
| 0:1 | Modes (VEHICLE MODE) to be excluded or included in stop events. | ||
| 0:1 | Lines/Directions to include/exclude. | |||
| 0:1 | Transport operators to include/exclude. | |||
13.5. The StopEventPolicyGroup group
| Request policies | ||||
9.5. The StopEventPolicyGroup group
| Request policies | ||||
| StopEventPolicy |
| 0:1 | xs:positiveInteger | 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 | xs:duration | Time window events should lie within. Starting from time given in PlaceContext. | ||
| 0:1 | Only departures or arrivals or both. | |||
13.6. The StopEventContentFilterGroup group
| Content filters which data is expected in the response | ||||
9.6. The StopEventContentFilterGroup group
| Content filters which data is expected in the response | ||||
| StopEventContentFilter |
| 0:1 | xs:boolean | Whether the previous calls of each vehicle journey should be included in the response. | |
| 0:1 | xs:boolean | Whether the onward calls of each vehicle journey should be included in the response. | ||
| 0:1 | xs:boolean | Whether operating day information of this stop event should be included in the response. | ||
13.7. The StopEventResponseGroup group
| Response structure for departure and arrival events at stops | ||||
9.7. The 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. | |||
13.8. The complex type 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. | |||
13.9. The complex type 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. | |||
9.8. The complex type 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. | |||
9.9. The complex type 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 | xs:anyType | |||
13.10. The complex type 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). | ||
13.11. The complex type 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 | xs:anyType | |||
9.10. The complex type 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). | ||
9.11. The complex type 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. | ||
14. OJP/OJP_TripInfo.xsd - Request and response definitions for information on a single trip
14.1. Simple type definitions
| TRIPINFO_JOURNEYREFUNKNOWN | TRIPINFO_VEHICLEUNKNOWN | TRIPINFO_NOJOURNEYFOUND | TRIPINFO_NOGEOINFO | TRIPINFO_OTHER | Types of problems that may be returned in responses to TripInfo requests. |
14.2. The TripInfoRequestGroup group
| TripInfo request structure. | ||||||||||||||||||||||||||||||||||||||||||||
| TRIPINFO_JOURNEYREFUNKNOWN | TRIPINFO_VEHICLEUNKNOWN | TRIPINFO_NOJOURNEYFOUND | TRIPINFO_NOGEOINFO | TRIPINFO_OTHER | Types of problems that may be returned in responses to TripInfo requests. |
10.2. The TripInfoRequestGroup group
| TripInfo request structure. | ||||
The element contains one of the following elements: | |||||
| DatedJourneyRef | a | 1:1 | Reference to a Journey | ||
a | 1:1 | Reference to an Operating Day | |||
b |
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | |
| TripInfoRequest |
| 0:1 | Request parameter. | ||
14.3. The complex type TripInfoParamStructure
| TripInfo request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
10.3. The complex type TripInfoParamStructure
| TripInfo request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| TripInfoPolicy |
| 0:1 | xs:boolean | Do not show any realtime or incident data. Default is false. | |
| TripInfoContentFilter |
| 0:1 | xs:boolean | Whether call information is to be included. Default is true. | |
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of this vehicle journey. | ||
| 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 | Whether 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:anyType | |||
14.4. The TripInfoPolicyGroup group
| Parameters that control the response behaviour. | ||||
| 0:1 | xs:anyType | |||
10.4. The TripInfoPolicyGroup group
| Parameters that control the response behaviour. | ||||
| TripInfoPolicy |
| 0:1 | xs:boolean | Do not show any realtime or incident data. Default is false. | |
14.5. The TripInfoContentFilterGroup group
| Parameters that control the level of detail to be returned in the results. | ||||
10.5. The TripInfoContentFilterGroup group
| Parameters that control the level of detail to be returned in the results. | ||||
| TripInfoContentFilter |
| 0:1 | xs:boolean | Whether call information is to be included. Default is true. | |
| 0:1 | xs:boolean | Whether current position is to be included. Default is true. | ||
| 0:1 | xs:boolean | Whether service information is to be included. Default is true. | ||
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of this vehicle journey. | ||
| 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 | Whether 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 | ||
14.6. The TripInfoResponseGroup group
| TripInfo response structure. | ||||
10.6. The TripInfoResponseGroup group
| TripInfo response structure. | ||||
| TripInfoResponse |
| 0:1 | Response context. | ||
| 0:1 | Result structure. | |||
14.7. The complex type TripInfoResultStructure
| TripInfo result structure containing the current status of a trip. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this TripInfo result. | |||
| 0:* | The stops this service already has called at. Including the current stop if service is currently at stop. | |||
| 0:1 | Current position of this service. | |||
| 0:* | The stops this service still has to call at. | |||
| 0:1 | Description of the service. | |||
10.7. The complex type TripInfoResultStructure
| TripInfo result structure containing the current status of a trip. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this TripInfo result. | |||
| 0:* | The stops this service already has called at. Including the current stop if service is currently at stop. | |||
| 0:1 | Current position of this service. | |||
| 0:* | The stops this service still has to call at. | |||
| 0:1 | Description of the service. | |||
| 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 journey. The entire journey is regarded as one leg. | |||
| 0:1 | xs:anyType | |||
14.8. The complex type TripInfoProblemStructure
| Problem that may be returned in responses to TripInfo requests. | ||||
The element contains only one element: | |||||
| 1:1 | Type of the TripInfo problem. | |||
15. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
15.1. Simple type definitions
| elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown | Allowed values for a AccessFeature. |
| lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator | Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to). |
| origin | destination | continue | keep | turn | leave | enter | various types of guidance advice given to travelle |
| anyPoint | eachOrigin | eachDestination | How the multiple origin/destination points should be considered |
| fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | the types of algorithm that can be used for planning a journey (fastest, least walking, etc). If multiple optimisation methods are needed, then several requests should be performed in parallel. |
| up | down | level | upAndDown | downAndUp | Transition types for interchanges. |
| TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | TRIP_OTHER | Types of problems that may be returned in responses to Trip requests. |
| sharp left | left | half left | straight on | half right | right | sharp right | uturn | the range of alternative turns that can be described |
15.2. The TripRequestGroup group
| Trip request structure. | ||||
| 0:1 | Geographic embedding of this journey. The entire journey is regarded as one leg. | |||
| 0:1 | xs:anyType | |||
10.8. The complex type TripInfoProblemStructure
| Problem that may be returned in responses to TripInfo requests. | ||||
The element contains only one element: | |||||
| 1:1 | Type of the TripInfo problem. | |||
11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
11.1. Simple type definitions
| elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown | Allowed values for a AccessFeature. |
| lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator | Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to). |
| origin | destination | continue | keep | turn | leave | enter | various types of guidance advice given to travelle |
| anyPoint | eachOrigin | eachDestination | How the multiple origin/destination points should be considered |
| fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | the types of algorithm that can be used for planning a journey (fastest, least walking, etc). If multiple optimisation methods are needed, then several requests should be performed in parallel. |
| up | down | level | upAndDown | downAndUp | Transition types for interchanges. |
| TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | TRIP_OTHER | Types of problems that may be returned in responses to Trip requests. |
| sharp left | left | half left | straight on | half right | right | sharp right | uturn | the range of alternative turns that can be described |
11.2. The TripRequestGroup group
| Trip request structure. | ||||
| TripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
15.3. The complex type TripParamStructure
| Trip request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
11.3. The complex type TripParamStructure
| Trip request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 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. | |||
| 0:1 | xs:boolean | The user is not able to use an elevator. | ||
| 0:1 | xs:boolean | The user is not able to use an ramp. | ||
| 0:1 | xs:boolean | The user is not able to see. | ||
| TripMobilityFilter |
| 0:1 | xs:boolean | The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access. | |
| 0:1 | xs:boolean | The user wants to carry a bike on public transport. | ||
| 0:1 | Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport). | ||
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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| TripPolicy |
| 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:* | 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) | ||
| TripMobilityFilter |
| 0:1 | xs:boolean | The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access. | |
| 0:1 | xs:boolean | The user wants to carry a bike on public transport. | ||
| 0:1 | Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport). | ||
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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| TripPolicy |
| 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:* | 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) | ||
| 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 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 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 | |||
11.4. The 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. | |||
| 0:1 | Private mobility options to include/exclude. | |||
| 0:1 | Filter for VEHICLE and TRAIN NUMBERs. | |||
| 0:1 | Filter for trips using only specific tariff zones. | |||
11.5. The TripPolicyGroup group
| Policies that control the 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| TripPolicy |
| 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:* | 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) | ||
11.6. The 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:boolean | The user is not able to walk up/down stairs. | ||
| 0:1 | xs:boolean | The user is not able to use an escalator. | ||
| 0:1 | xs:boolean | The user is not able to use an elevator. | ||
| 0:1 | xs:boolean | The user is not able to use an ramp. | ||
| 0:1 | xs:boolean | The user is not able to see. | ||
| TripMobilityFilter |
| 0:1 | xs:boolean | The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access. | |
| 0:1 | xs:boolean | The user wants to carry a bike on public transport. | ||
| 0:1 | Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport). | ||
11.7. The 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. | |
| 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 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. | ||
11.8. The complex type 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 | |||
11.9. The complex type 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 | |||
11.10. The complex type 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 | ||||
11.11. The 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. | |||
11.12. The complex type 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:* | ||||
11.13. The complex type 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. | ||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
11.14. The complex type 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 | |||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| TripStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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 | 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:1 | xs:anyType | |||
11.15. The complex type 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 | |||
11.16. The complex type 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. | |||
| 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 | xs:anyType | |||
11.17. The complex type TransferLegStructure
| [a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Mode that is used for this interchange between public services. | ||
b |
| -1:1 | Mode that is used for this interchange between public services. | ||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
| TransferDuration |
| 1:1 | xs:duration | Overall duration of this interchange. | |
| 0:1 | xs:duration | Walk time as part of the overall interchange duration. | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains. | ||
| 0:1 | Text that describes this interchange. | |||
| 0:1 | Length of this interchange path. | |||
| 0:* | Note or service attribute. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
11.18. The complex type ContinuousLegStructure
| [relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
| 1:1 | Service of this leg. May be "walk" in most cases, but also cycling or taxi etc. | |||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
| 1:1 | xs:duration | Duration of this leg according to user preferences like walk speed. | ||
| 0:1 | Title or summary of this leg for overview. | |||
| 0:1 | Length of the leg. | |||
| 0:1 | Detailed description of each element of this leg including geometric projection. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
11.19. The complex type 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 | ||
| 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:1 | describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 1:1 | describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:normalizedString | Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/ | ||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
11.20. The complex type 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 | ||
| 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. | |||
| 1:1 | describes the arrival situation at the leg alight stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | describes the departure situation at this leg alight stop point (empty for last leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:normalizedString | Interchange identifier of the feeding line/service at its alighting. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/ | ||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
11.21. The complex type 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 | ||
| 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. | |||
| 1:1 | describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 1:1 | describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
11.22. The complex type PathGuidanceStructure
| description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information | ||||
The element contains only one element: | |||||
| 1:* | one or more path guidance sections that build the trip Leg | |||
11.23. The complex type PathGuidanceSectionStructure
| [an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information | |||
| 0:1 | Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName. | |||
| 0:1 | various types of guidance advice given to travelle. | |||
| 0:1 | the range of alternative turns that can be described. | |||
| 0:1 | Textual direction hint for better understanding, e.g. "follow signs to Hamburg". | |||
| 0:1 | siri:AbsoluteBearingType | Absolute bearing after the described manoeuvre. | ||
| 0:1 | Description of the type of accessibility on this navigation section. | |||
| 0:* | ||||
11.24. The TransferDurationGroup group
| [an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time.. | ||||
| TransferDuration |
| 1:1 | xs:duration | Overall duration of this interchange. | |
| 0:1 | xs:duration | Walk time as part of the overall interchange duration. | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains. | ||
11.25. The complex type PathLinkStructure
| [TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs,BOARDING POSITIONs,, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Whether path is up down or level . | |||
| 0:1 | Type of physical feature of PATH LINK. | |||
| 0:1 | xs:positiveInteger | Number how often the access feature occurs in this PathLink | ||
| 0:* | Presence of an accessibility feature on the PathLink. | |||
| 0:1 | Designations of level and place where this PathLink starts. | |||
| 0:1 | Designations of level and place where this PathLink ends. | |||
11.26. The complex type PathLinkEndStructure
| Designations of a floor/level. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:normalizedString | Public identifier of the level as found on elevators and signs. | ||
| 0:1 | Official name of the level. | |||
| 0:1 | xs:normalizedString | Id of the element at this end of the PathLink (typically a PLACE, e.g. where the elevator is located). | ||
11.27. The MultiPointTripRequestGroup group
| Multi-point trip request structure. | ||||
| MultiPointTripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
11.28. The complex type MultiPointTripParamStructure
| Multi-point trip request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 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. | |||
| 0:1 | Private mobility options to include/exclude. | |||
| 0:1 | Filter for VEHICLE and TRAIN NUMBERs. | |||
| 0:1 | Filter for trips using only specific tariff zones. | |||
| 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 escalator. | ||
| 0:1 | xs:boolean | The user is not able to use an elevator. | ||
| 0:1 | xs:boolean | The user is not able to use an ramp. | ||
| 0:1 | xs:boolean | The user is not able to see. | ||
| TripMobilityFilter |
| 0:1 | xs:boolean | The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access. | |
| 0:1 | xs:boolean | The user wants to carry a bike on public transport. | ||
| 0:1 | Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport). | ||
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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| 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. | |||
| 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 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 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 | |||
11.29. The MultiPointTripPolicyGroup group
| Policies that control the multi-point 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| 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. | |||
11.30. The MultiPointTripResponseGroup group
| Multi-point trip response structure. | ||||
| MultiPointTripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. | |||
11.31. The complex type 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 | |||
| 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:* | ||||
11.32. The 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. | ||
11.33. The TripStatusGroup group
| Parameters which describe the current status of a TRIP | ||||
| TripStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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 | 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. | ||
11.34. The TripRefineRequestGroup group
| Trip refinement request structure. | ||||
| TripRefineRequest |
| 0:1 | Options to control the refine | ||
| 1:1 | The trip result to be refined by the server. | |||
| 0:1 | Context to hold objects, which are referenced within the response. | |||
11.35. The complex type 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. | ||
| 1:* | xs:NMTOKEN | Refers to a leg to be refined by the server. | ||
| 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 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. | ||
| 0:1 | Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). | |||
| 0:1 | xs:anyType | |||
11.36. The TripRefineResponseGroup group
| Trip refinement response structure. | ||||
| TripRefineResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | xs:NMTOKEN | Refers to a leg that was not found in the data of the server. If the to be refined TripResult could not be found or unequivocally determined, all RefineLegRefs are returned as UnknownLegRefs. | ||
| 0:* | The trip results refined by the server. | |||
11.37. The complex type TripProblemStructure
| Problem that may be returned in responses to trip requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the trip problem. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
12. OJP/OJP_JourneySupport.xsd - Supporting definitions for journeys on public transport vehicles
12.1. Simple type definitions
| none | service | stop | Possible types of reservation needed for services. |
| Not yet operated | Operation finished | At stop | Between stops | Vehicle progress relative to timetable service pattern. |
12.2. The complex type 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 | ||
| 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:1 | Priority of this via point to be displayed when space is limited. | |||
12.3. The complex type ProductCategoryStructure
| Product category based on NeTEx/SIRI. A product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Full name of this product category, e.g. "Autoreisezug" in Switzerland or "Dampfschiff" | |||
| 0:1 | Short name or acronym of the product category, likely to be published, e.g. "BAV", "ARZ", "TGV". The product category is more important for publication in Switzerland than Mode / Submode. | |||
0:1 | A reference to the product category. This is the internal code used within the reference frameworks (NeTEx, SIRI). It is usually not displayed, but interpreted by the technical system, e.g. "ch:1:TypeOfProductCategory:ARZ" (Autoreisezug in Switzerland) or "ch:1:TypeOfProductCategory:BAV". | ||||
12.4. The complex type TripViaStructure
| VIA restrictions for a TRIP. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Reference to specify the via place. | |||
| 0:1 | xs:duration | Duration the passenger wants to stay at the via place. Default is 0. | ||
12.5. The ScheduledJourneyGroup group
| Vehicle journey (not dated). | ||||
| 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". | ||
| |||||
| Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
12.6. The ServiceGroup group
| Properties of a service (line and direction): attributes of Continuous Journey Structure or Dated Journey Structure. | ||||
| |||||
| Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
12.7. The ServiceOriginGroup group
| First serviced stop of a vehicle journey. | ||||
| ServiceOrigin |
| 0:1 | siri:StopPointRefStructure | First stop of the vehicle journey; origin stop point. | |
| 1:1 | Label for first stop. | |||
12.8. The ServiceDestinationGroup group
| Last serviced stop of a vehicle journey. | ||||
| ServiceDestination |
| 0:1 | siri:StopPointRefStructure | Last stop of vehicle journey; destination stop point. | |
| 1:1 | Label for last stop. | |||
12.9. The RouteDescriptionGroup group
| Descriptive text for a route, f.e. "Airport via City Centre" | ||||
| RouteDescription |
| 1:1 | |||
12.10. The DatedJourneyGroup group
| Vehicle journey that runs at a specific date. | ||||
| DatedJourney | 1:1 | Reference to an Operating Day | |||
| 0:1 | →siri:VehicleRef | |||
| 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". | ||
| |||||
| Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
12.11. The PrivateServiceGroup group
| specific service operated by a Private Mode | ||||
| PrivateService | 0:1 | Reference to a Journey | |||
| 1:1 | [a category of MODE in TMv6] MODEs offered by private individuals | |||
| 0:1 | siri:OperatorRefStructure | |||
| 0:1 | Link to web page providing more details on service. | |||
12.12. The complex type 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 | ||
| 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". | |
| |||||
| Service | a |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs |
a |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | ||
a |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | |
a |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
| PrivateService | b | 0:1 | Reference to a Journey | ||
b |
| 1:1 | [a category of MODE in TMv6] MODEs offered by private individuals | ||
b |
| 0:1 | siri:OperatorRefStructure | ||
b |
| 0:1 | Link to web page providing more details on service. | ||
| 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. | |||
| ServiceStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
12.13. The complex type 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 | ||||
| |||||
12.14. The 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. | ||
12.15. The ServiceTimeGroup group
| Contains at least scheduled time, but can contain real time and estimated times | ||||
| ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
| EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
12.16. The EstimatedTimeBandGroup group
| Range for estimated time. | ||||
| EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
12.17. The complex type ServiceArrivalStructure
| Arrival times of a service at a stop (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | ||||
The element contains only one element: | |||||
| ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
| EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
12.18. The complex type ServiceDepartureStructure
| Departure times of a service at a stop (group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | ||||
The element contains only one element: | |||||
| ServiceTime |
| 1:1 | xs:dateTime | time at point as it is published | |
| 0:1 | xs:dateTime | time as it was recorded | ||
| 0:1 | xs:dateTime | estimated time (for prognosis) | ||
| EstimatedTimeBand |
| 0:1 | xs:dateTime | Estimated lower limit for time. | |
| 0:1 | xs:dateTime | Estimated upper limit for time. | ||
12.19. The complex type 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 | ||
| 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:1 | Arrival times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | |||
| 0:1 | Departure times of the service at this stop ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME). | |||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
12.20. The StopCallStatusGroup group
| Status properties for the vehicle call at this stop. | ||||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
12.21. The ServiceStatusGroup group
| parameters which describe the current status of a DATED VEHICLE JOURNEY | ||||
| ServiceStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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. | ||
12.22. The complex type 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 | ||
| 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". | |
| |||||
| Service | a |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs |
a |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | ||
a |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | |
a |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
b |
| -0:1 | |||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
12.23. The complex type 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. | ||
12.24. The complex type 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. | |||
12.25. The 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). | ||
12.26. The 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
12.27. The 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 escalator. | ||
| 0:1 | xs:boolean | The user is not able to use an elevator. | ||
| 0:1 | xs:boolean | The user is not able to use an ramp. | ||
| 0:1 | xs:boolean | The user is not able to see. | ||
12.28. The 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. | |
| 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 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 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 | |||
15.4. The 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. | |||
| 0:1 | Private mobility options to include/exclude. | |||
| 0:1 | Filter for VEHICLE and TRAIN NUMBERs. | |||
| 0:1 | Filter for trips using only specific tariff zones. | |||
15.5. The TripPolicyGroup group
| Policies that control the 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| TripPolicy |
| 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:* | 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) | ||
15.6. The TripMobilityFilterGroup group
| Parameters the user can set to restrict the mobility options - particularly for interchanging. | ||||
12.29. The complex type 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. | ||
12.30. The complex type 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. | |||
12.31. The complex type 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 | |||
13. OJP/OJP_Availability.xsd - Request and response definitions for availability of tickets and services on a journey leg.
13.1. Simple type definitions
| 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. |
13.2. The 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 | |||
| AvailabilityRequest |
| 0:1 | xs:anyType | ||
13.3. The complex type 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. | |||
| |||||
| Service |
| 1:1 | +Mode | [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | |
| 0:1 | A product category for the service. This is a classification defined in NeTEx/SIRI used to identify groups of journeys with some special properties for marketing and fare products, e.g. "TE2" for SNCF or a special panorama train "PE" in Switzerland. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
| 0:1 | xs:anyType | |||
13.4. The complex type BookingUserStructure
| Passenger(s) for whom the service needs to be booked. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:nonNegativeInteger | Age of the passenger on the day of travel. | ||
| PassengerProfile |
| 0:1 | xs:boolean | Passenger uses a wheelchair. Default is FALSE. | |
| 0:1 | xs:boolean | Passenger uses a walking frame. Default is FALSE. | ||
| 0:1 | xs:boolean | Passenger uses a walking stick. Default is FALSE. | ||
| 0:1 | xs:boolean | Passenger is (maybe temporarily) walking impaired. Default is FALSE. | ||
| 0:1 | xs:boolean | Passenger has a pram with him/her. Default is FALSE. | ||
| 0:1 | xs:boolean | Passenger has got heavy luggage. Default is FALSE. | ||
| 0:1 | xs:boolean | Passenger is visually impaired. | ||
| 0:1 | xs:boolean | Passenger is hearing impaired. | ||
| 0:1 | xs:boolean | Passenger is reading impaired. | ||
| 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 wants to carry a bike on public transport. | ||
| 0:1 | Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport). | ||
15.7. The 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. | |
| 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 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. | ||
15.8. The complex type 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 | |||
15.9. The complex type 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 | |||
15.10. The complex type 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 | ||||
15.11. The 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. | |||
15.12. The complex type 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:* | ||||
15.13. The complex type 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. | ||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
15.14. The complex type 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 | |||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| TripStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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 | 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:1 | xs:anyType | |||
15.15. The complex type 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 | |||
15.16. The complex type 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. | |||
| 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 | xs:anyType | |||
15.17. The complex type TransferLegStructure
| [a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Mode that is used for this interchange between public services. | ||
b |
| -1:1 | Mode that is used for this interchange between public services. | ||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
| TransferDuration |
| 1:1 | xs:duration | Overall duration of this interchange. | |
| 0:1 | xs:duration | Walk time as part of the overall interchange duration. | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains. | ||
| 0:1 | Text that describes this interchange. | |||
| 0:1 | Length of this interchange path. | |||
| 0:* | Note or service attribute. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
15.18. The complex type ContinuousLegStructure
| [relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
| 1:1 | Service of this leg. May be "walk" in most cases, but also cycling or taxi etc. | |||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
| 1:1 | xs:duration | Duration of this leg according to user preferences like walk speed. | ||
| 0:1 | Title or summary of this leg for overview. | |||
| 0:1 | Length of the leg. | |||
| 0:1 | Detailed description of each element of this leg including geometric projection. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
15.19. The complex type 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 | ||
| 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:1 | describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 1:1 | describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:normalizedString | Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/ | ||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
15.20. The complex type 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 | ||
| 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. | |||
| 1:1 | describes the arrival situation at the leg alight stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | describes the departure situation at this leg alight stop point (empty for last leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:normalizedString | Interchange identifier of the feeding line/service at its alighting. This is not a reference. This identifier is used to recognize in a distributed environment (e.g. EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scanario (aka "line ID"). See https://eu-spirit.eu/ | ||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
15.21. The complex type 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 | ||
| 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. | |||
| 1:1 | describes the arrival situation a this leg board stop point (empty for first leg) ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 1:1 | describes the departure situation at this leg board stop point ( group of attributes of TIMETABLED PASSING TIME, ESTIMATED PASSING TIME, OBSERVED PASSING TIME) | |||
| 0:1 | xs:boolean | This stop fulfils one of the via requirements stated in the request data. | ||
| 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. | ||
13.5. The complex type ProvisionedCallAtPlaceStructure
| Provisioned vehicle call at a general location. | ||||
The element contains a sequence of the following elements: | |||||
| DatedJourneyRef | 1:1 | Reference to a Journey | |||
1:1 | Reference to an Operating Day | ||||
| 1:1 | More general location for a call than stop points. May be used with flexible services or "Area Dial-A-Ride". | |||
| 0:1 | Arrival times of the service at this stop. | |||
| 0:1 | Departure times of the service at this stop. | |||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
15.22. The complex type PathGuidanceStructure
| description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information | ||||
The element contains only one element: | |||||
| 1:* | one or more path guidance sections that build the trip Leg | |||
15.23. The complex type PathGuidanceSectionStructure
| [an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information | |||
| 0:1 | Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName. | |||
| 0:1 | various types of guidance advice given to travelle. | |||
| 0:1 | the range of alternative turns that can be described. | |||
| 0:1 | Textual direction hint for better understanding, e.g. "follow signs to Hamburg". | |||
| 0:1 | siri:AbsoluteBearingType | Absolute bearing after the described manoeuvre. | ||
| 0:1 | Description of the type of accessibility on this navigation section. | |||
| 0:* | ||||
15.24. The TransferDurationGroup group
| [an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time.. | ||||
| TransferDuration |
| 1:1 | xs:duration | Overall duration of this interchange. | |
| 0:1 | xs:duration | Walk time as part of the overall interchange duration. | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains. | ||
15.25. The complex type PathLinkStructure
| [TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs,BOARDING POSITIONs,, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Whether path is up down or level . | |||
| 0:1 | Type of physical feature of PATH LINK. | |||
| 0:1 | xs:positiveInteger | Number how often the access feature occurs in this PathLink | ||
| 0:* | Presence of an accessibility feature on the PathLink. | |||
| 0:1 | Designations of level and place where this PathLink starts. | |||
| 0:1 | Designations of level and place where this PathLink ends. | |||
15.26. The complex type PathLinkEndStructure
| Designations of a floor/level. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:normalizedString | Public identifier of the level as found on elevators and signs. | ||
| 0:1 | Official name of the level. | |||
| 0:1 | xs:normalizedString | Id of the element at this end of the PathLink (typically a PLACE, e.g. where the elevator is located). | ||
15.27. The MultiPointTripRequestGroup group
| Multi-point trip request structure. | ||||
| MultiPointTripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
15.28. The complex type MultiPointTripParamStructure
| Multi-point trip request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 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. | |||
| 0:1 | Private mobility options to include/exclude. | |||
| 0:1 | Filter for VEHICLE and TRAIN NUMBERs. | |||
| 0:1 | Filter for trips using only specific tariff zones. | |||
13.6. The 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 | |||
13.7. The 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. | ||
| 0:1 | xs:boolean | Passenger uses a walking stick. Default is FALSE. | ||
| 0:1 | xs:boolean | Passenger is (maybe temporarily) walking impaired. Default is FALSE. | ||
| 0:1 | xs:boolean | Passenger has a pram with him/her. Default is FALSE. | ||
| 0:1 | xs:boolean | Passenger has got heavy luggage. Default is FALSE. | ||
| 0:1 | xs:boolean | Passenger is visually impaired. | ||
| 0:1 | xs:boolean | Passenger is hearing impaired. | ||
| 0:1 | xs:boolean | Passenger is reading impaired. | ||
13.8. The PassengerRequirementsGroup group
| Description of passenger's accessibility requirements | ||||
| 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 wants to carry a bike on public transport. | ||
| 0:1 | Deviation from average walk speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster. | |||
| 0:1 | xs:duration | Additional time added to all transfers (also to transfers between individual to public transport). | ||
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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| 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. | |||
| 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 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 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 | |||
15.29. The MultiPointTripPolicyGroup group
| Policies that control the multi-point 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| 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. | |||
15.30. The MultiPointTripResponseGroup group
| Multi-point trip response structure. | ||||
| MultiPointTripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. | |||
15.31. The complex type 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 | |||
| 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:* | ||||
15.32. The 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. | ||
15.33. The TripStatusGroup group
| Parameters which describe the current status of a TRIP | ||||
| TripStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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 | 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. | ||
15.34. The TripRefineRequestGroup group
| Trip refinement request structure. | ||||
| TripRefineRequest |
| 0:1 | Options to control the refine | ||
| 1:1 | The trip result to be refined by the server. | |||
| 0:1 | Context to hold objects, which are referenced within the response. | |||
15.35. The complex type 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. | ||
| 1:* | xs:NMTOKEN | Refers to a leg to be refined by the server. | ||
| 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 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. | ||
| 0:1 | Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). | |||
| 0:1 | xs:anyType | |||
15.36. The TripRefineResponseGroup group
| Trip refinement response structure. | ||||
| TripRefineResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | xs:NMTOKEN | Refers to a leg that was not found in the data of the server. If the to be refined TripResult could not be found or unequivocally determined, all RefineLegRefs are returned as UnknownLegRefs. | ||
| 0:* | The trip results refined by the server. | |||
15.37. The complex type TripProblemStructure
| Problem that may be returned in responses to trip requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the trip problem. | |||
| 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. | ||
13.9. The DriverAssistanceGroup group
| Requirements for the driver/staff to assist the passenger when boarding/alighting. | ||||
| 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. | ||
13.10. The AvailabilityResponseGroup group
| Availability response. | ||||
| AvailabilityResponse |
| 0:1 | Indication of the availability of the requested service. | ||
| 0:1 | xs:anyType | |||
13.11. The complex type 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. | ||
| BookableTicketAndServiceInformation |
| 0:* | Sequence of bookable tickets or surcharges for this part of the trip. If ticket price is zero: an already purchased/virtual ticket of this type presented to the driver would be accepted. | ||
| 0:* | Sequence of bookable service items for this part of the trip. | |||
| 0:1 | xs:anyType | |||
13.12. The BookableTicketAndServiceInformationGroup group
| Lists those tickets or surcharges and service characteristics such as the transportation of wheelchairs, prams, luggage etc. or the provision of required child seats or booster seats that are offered in the trips transport company to be booked for the trip. | ||||
| BookableTicketAndServiceInformation |
| 0:* | Sequence of bookable tickets or surcharges for this part of the trip. If ticket price is zero: an already purchased/virtual ticket of this type presented to the driver would be accepted. | ||
| 0:* | Sequence of bookable service items for this part of the trip. | |||
13.13. The complex type BookableServiceItemStructure
| Possible service items that can be booked in the actual booking system (defined by the traffic company of charge). Only those elements with value greater 0 are bookable. The indicated capacity corresponds to the maximum number that can be booked in one booking. This number does not have to be available for the specific booking and may result in booking failure. Caution: list can vary widely from one traffic company to another. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | The type of bookable service. | |||
| 1:1 | xs:nonNegativeInteger | Maximum number of service items that can be booked in one booking transaction. Default is 0. | ||
13.14. The complex type AvailabilityProblemStructure
| Problem that may be returned in responses to AVAILABILITY requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the AVAILABILITY problem. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
16. OJP/OJP_Utility.xsd - Support definitions not specifically related to the public transport domain
16.1. Simple type definitions
| 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 |
16.2. The complex type 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. | ||
16.3. The WebLinkGroup group
| URL of a web resource including type of resource. | ||||||||||||||||||||||||||||||||||||||||||||
| 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 |
14.2. The 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. | ||
14.3. The complex type PrivateCodeStructure
| Code within scope of a private referential system | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Code of the foreign referential system. | ||
| 1:1 | xs:NMTOKEN | Object code within this private/foreign system. | ||
14.4. The complex type LinearShapeStructure
| An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure. | ||||
The element contains only one element: | |||||
| 2:* | siri:LocationStructure | Ordered list of locations representing the geometry of the link or route. | ||
14.5. The complex type AreaStructure
| Area described as a polygon. | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | Ordered list of geographic locations describing the polygon of the area. | ||
14.6. The toplevel element ParticipantRef
| siri:ParticipantRefStructure | Reference to a Participant ([equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)) | |||
14.7. The toplevel element OperatorRef
| siri:OperatorRefStructure | Reference to an Operator ([TMv6] company providing public transport services.) | |||
14.8. The complex type OperatorFilterStructure
| Filter for in/exclusion of transport operators. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether operators in list are to include or exclude from search. Default is exclude. | ||
| 0:* | siri:OperatorRefStructure | Reference to transport operator | ||
14.9. The complex type ProductCategoryRefStructure
| Reference to a product category. As defined in NeTEx and SIRI, a product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products, e.g. to identify boats that run with steam in Switzerland ("BAV") | ||||
14.10. The toplevel element ProductCategoryRef
| siri:ProductCategoryRefStructure | Reference to a product category. Product categories should be defined once and used uniformly in all channels (e.g. NeTEx, SIRI, OJP) | |||
14.11. The complex type LineDirectionFilterStructure
| Filter for in/exclusion of lines (and directions). | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | siri:LineDirectionStructure | Reference a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables.. | ||
| 0:1 | xs:boolean | Whether lines in list are to include or exclude from search. Default is exclude. | ||
14.12. The complex type JourneyRefStructure
| Reference to a Journey | ||||
14.13. The toplevel element JourneyRef
| Reference to a Journey | ||||
14.14. The DatedJourneyRefGroup group
| Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day) | ||||
| DatedJourneyRef | 1:1 | Reference to a Journey | |||
1:1 | Reference to an Operating Day | ||||
14.15. The TimedVehicleRefGroup group
| Reference to a vehicle for a specific point in time. | ||||
| TimedVehicleRef |
| 1:1 | →siri:VehicleRef | ||
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | ||
14.16. The complex type 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 | ||
14.17. The 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. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. | ||
14.18. The complex type SharingServiceStructure
| Service that provides shared vehicles. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:OperatorRefStructure | Identifier of the operator of the sharing service | ||
| 0:1 | xs:string | Public name of the service. | ||
| 0:1 | Type of the sharing scheme. | |||
| SharingServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. | ||
| 0:1 | Link to web page providing more details on service. | |||
14.19. The complex type OwnerRefStructure
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
14.20. The toplevel element OwnerRef
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
14.21. The complex type OperatingDayRefStructure
| Reference to an Operating Day | ||||
14.22. The toplevel element OperatingDayRef
| Reference to an Operating Day | ||||
14.23. The complex type OperatingDaysStructure
| [TMv6] day of public transport operation of which the characteristics are defined in a specific SERVICE CALENDAR and which may last more than 24 hours. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:date | Start date of period. | ||
| 1:1 | xs:date | End date of period. | ||
| 1:1 | Bit pattern for operating days between start date and end date. The length of the pattern is equal to the number of days from start date to end date. A bit value of "1" indicates that an event actually happens on the day that is represented by the bit position. | |||
14.24. The OperatingDaysGroup group
| Coded as bit pattern | ||||
| 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". | |||
14.25. The complex type WeekdayTimePeriodStructure
| [a specialisation of TIME BAND in TMv6] aggregation of TIME BAND and DAY OF WEEK (Time period on a weekday). | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays | |||
| 1:1 | xs:time | Start time of period. | ||
| 1:1 | xs:duration | Time duration of period. | ||
14.26. The complex type GeneralAttributeStructure
| Structured attribute classification with associated text. If URL is given, it refers to the whole attribute text. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Text of the attribute to be shown to the user. | |||
| 1:1 | xs:NMTOKEN | Internal code of the attribute. Can be used for detection of double occurrences. | ||
| |||||
| 0:1 | xs:boolean | Defines whether the attribute has to be shown to the user. | ||
| 0:1 | Importance of the attribute. | |||
| WebLink |
| 1:1 | xs:anyURI | URL to resource on web. | |
| 0:1 | xs:normalizedString | MIME type of the referenced resource. To which kind of resource does the URL point to? | ||
| 0:1 | xs:boolean | Is the referenced resource meant to be embedded as a webview in a surrounding context, e.g. app or web page? If yes, the resource has to be fully responsive. Default is false. | ||
15. OJP/OJP_FacilitySupport.xsd - Supporting definitions for facilities containing wrappers for SIRI
15.1. The AllFacilitiesGroup group
| Wrapper for SIRI facilities. | ||||
| |||||
15.2. The StopFacilityGroup group
| Wrapper for SIRI stop facilities. | ||||
| |||||
15.3. The ServiceFacilityGroup group
| Wrapper for SIRI service facilities. | ||||
| |||||
16. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport
16.1. Simple type definitions
| 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 |
16.2. The complex type 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. | ||
16.3. The complex type 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. | |||
16.4. The ModeGroup group
| Elements for a Transport Mode | ||||
| Mode |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of mode | |
| |||||
16.5. The complex type 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. | ||
| |||||
16.6. The complex type 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. | |||
17. OJP/OJP_SituationSupport.xsd - Supporting definitions for situations containing wrappers for SIRI Situation Exchange service (SIRI SX)
17.1. The complex type SituationsStructure
| Wrapper type for SIRI PtSituationsElementStructure | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | siri:PtSituationElementStructure | SIRI situation details. | ||
| 0:* | siri:RoadSituationElementStructure | |||
17.2. The toplevel element SituationFullRef
| Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
17.3. The complex type SituationFullRefStructure
| siri:SituationFullRefStructure | Reference structure for situation message. Situation details might be found in response context or through other communication channels. | |||
18. OJP/OJP_Utility.xsd - Support definitions not specifically related to the public transport domain
18.1. Simple type definitions
| 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 |
18.2. The complex type 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. | ||
18.3. The WebLinkGroup group
| URL of a web resource including type of resource. | ||||
| WebLink |
| 1:1 | xs:anyURI | URL to resource on web. | |
| 0:1 | xs:normalizedString | MIME type of the referenced resource. To which kind of resource does the URL point to? | ||
| 0:1 | xs:boolean | Is the referenced resource meant to be embedded as a webview in a surrounding context, e.g. app or web page? If yes, the resource has to be fully responsive. Default is false. | ||
16.4. The complex type WebLinkStructure
| URL of a web resource with label. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Label for link description. | |||
18.4. The complex type WebLinkStructure
2.21. The toplevel element OJPTripRequest
| +OJPTripRequest (↔ siri:AbstractFunctionalServiceRequest) | ||||
2.22. The complex type OJPTripRequestStructure
| |||||
The element contains a sequence of the following elements: | |||||
| TripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| TripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. + Note: Systems may support only one. | |||
| 0:* | siri:ParticipantRefStructure | With this parameter a distributing system is asked to build a trip using a given System to pass through. This helps in selecting Exchange Points for this trip. ViaSystem is also used in sequence. + Note: Systems may support only one. | ||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
| 0:1 | Calculation time. | |||
| 0:* | OJP generic problem for the whole delivery. | |||
| MultiPointTripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 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. | |||
| 0:1 | →siri:Extensions | |||
| 0:1 | xs:anyType | |||
3.6. The complex type PlacesStructure
| Structure providing a collection of places. | ||||
The element contains only one element: | |||||
| 1:* | ||||
3.7. The complex type 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 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. | |||
3.8. The complex type 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. | |||
3.6. The complex type PlacesStructure
| Structure providing a collection of places. | ||||
The element contains only one element: | |||||
| 1:* | ||||
3.7. The complex type Operators_RelStructure
| Structure providing a collection of operators. | ||||
The element contains only one element: | |||||
| 1:* | siri:AffectedOperatorStructure | Operator of the service. | ||
3.8. The complex type 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. | |||
3.9. The complex type 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. | ||
| FareResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | Fare result choice element. | |||
4.7. The complex type 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. | ||
4.8. The complex type 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 | |||
4.9. The complex type 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 | |||
4.10. The complex type 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. | ||
4.11. The complex type 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. | |||
5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
5.1. Simple type definitions
| 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 |
| 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: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 |
5.2. The complex type 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). | ||||
5.3. The toplevel element FareAuthorityRef
| Reference to a Fare Authority. | ||||
5.4. The FareAuthorityGroup group
| Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs | ||||||||||||||||||||||||||||||||||||||||||||
| 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 |
5.2. The complex type 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). | ||||
5.3. The toplevel element FareAuthorityRef
| Reference to a Fare Authority. | ||||
5.4. The 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. | ||
5.6. The toplevel element TariffZoneRef
| Reference to a fare zone. | ||||
5.7. The complex type 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. | ||
5.8. The complex type 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. | |||
5.9. The complex type 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. | ||||
5.10. The complex type BookingArrangementStructure
| [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Name of the booking agency (contractual partner). | |||
| 0:1 | URL to online booking service. | |||
| 0:1 | URL to information page. | |||
| 0:1 | Phone number for booking. | |||
| 0:1 | xs:duration | Minimum duration bookings must be completed before trip starts. | ||
| 0:1 | xs:anyType | |||
5.11. The complex type BookingArrangementsContainerStructure
| Container for multiple booking arrangements. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey. | |||
| 0:1 | xs:anyType | |||
5.12. The complex type FareProductRefStructure
| Reference to a FareProduct. | ||||
5.13. The toplevel element FareProductRef
| Reference to a FareProduct. | ||||
5.14. The complex type EntitlementProductListStructure
| A list of ENTITLEMENT PRODUCTs | ||||
The element contains only one element: | |||||
| 1:* | [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | |||
5.15. The complex type EntitlementProductStructure
| [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to the fare authority that issued the ENTITLEMENT PRODUCT | ||||
| 1:1 | Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...) | |||
| 0:1 | siri:HalfOpenTimestampOutputRangeStructure | Validity period of the ENTITLEMENT PRODUCT | ||
| 1:1 | xs:string | Name of the ENTITLEMENT PRODUCT | ||
5.16. The complex type FareProductStructure
| [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Identifier of a FareProduct | |||
| 1:1 | xs:string | Printable FareProduct name | ||
| 1:* | Fare zone in area. | |||
5.9. The complex type 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. | ||||
5.10. The complex type 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. | |||
5.11. The complex type BookingMethodListOfEnumerations
| List of values for Flexible Booking values. | ||||
The element contains only one element: | |||||
| 1:* | ||||
5.12. The complex type PurchaseMomentListOfEnumerations
| List of Purchase Moment values. | ||||
The element contains only one element: | |||||
| 1:* | ||||
5.13. The complex type BookingProcessListOfEnumerations
| List of Booking Process values. | ||||
The element contains only one element: | |||||
| 1:* | ||||
5.14. The complex type GroupBookingListOfEnumerations
| List of Group Booking values. | ||||
The element contains only one element: | |||||
| 1:* | ||||
5.15. The complex type BookingArrangementsStructure
| Type for BOOKING ARRANGEMENTs modified from NeTEx. | ||||
5.16. The 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. | |||
| 0:1 | When Booking can be made. | |||
| 0:1 | When purchase can be made. | |||
| 0:1 | xs:time | Latest time that booking can be made. The exact meaning must be derived also from BookWhen and MinimumBookingPeriod. | ||
| 0:1 | xs:duration | Minimum interval in advance of departure day or time that Service may be ordered. | ||
| 0:1 | xs:duration | Maximum interval in advance of departure day or time that Service may be ordered. | ||
| 0:1 | URL for booking. | |||
| 0:1 | Note about booking the FLEXIBLE LINE. | |||
| 0:1 | xs:anyType | |||
5.17. The complex type BookingArrangementsContainerStructure
| Container for multiple booking arrangements. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey. | |||
| 0:1 | xs:anyType | |||
5.18. The complex type FareProductRefStructure
| Reference to a FareProduct. | ||||
5.19. The toplevel element FareProductRef
| Reference to a FareProduct. | ||||
5.20. The complex type EntitlementProductListStructure
| A list of ENTITLEMENT PRODUCTs | ||||
The element contains only one element: | |||||
| 1:* | [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | |||
5.21. The complex type EntitlementProductStructure
| [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to the fare authority that issued the ENTITLEMENT PRODUCT | ||||
| 1:1 | Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...) | |||
| 0:1 | siri:HalfOpenTimestampOutputRangeStructure | Validity period of the ENTITLEMENT PRODUCT | ||
| 1:1 | xs:string | Name of the ENTITLEMENT PRODUCT | ||
5.22. The complex type FareProductStructure
| [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Identifier of a FareProduct | |||
| 1:1 | xs:string | Printable FareProduct name | ||
| FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
| 0:1 | xs:boolean | Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/ | ||
| 0:1 | Textual description of spatial validity. | |||
| FareProductBooking |
| 0:* | URL to information for this FareProduct | ||
| 0:* | URL to buy the FareProduct online | |||
| 0:* | URL to buy the FareProduct online. | |||
| 0:* | ||||
| 0:1 | xs:anyType | |||
5.17. The FareProductPriceGroup group
| [related to FARE PRODUCT PRICE in TM and NeTEx] price at which a FARE PRODUCT can be purchased. | ||||
| 0:1 | xs:anyType | |||
5.23. The 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. | ||
| 0:1 | xs:NMTOKEN | iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Rate of value added tax. | |||
5.18. The FareProductValidityGroup group
| conditions of use for a particular FARE PRODUCT. | ||||
5.24. The FareProductValidityGroup group
| conditions of use for a particular FARE PRODUCT. | ||||
| FareProductValidity |
| 0:1 | Travel class for which the FareProduct is valid. | ||
| 0:* | One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn". | |||
| 0:* | Sequence of all passenger categories for which this FareProduct is valid. | |||
| 0:1 | Textual description of maximum validity duration. | |||
| 0:* | Spatial validity of FareProduct defined as list of fare zones. | |||
| 0:1 | Textual description of spatial validity. | |||
5.19. The 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. | ||||
5.25. The 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:* | URL to buy the FareProduct online. | |||
| 0:* | ||||
5.20. The TripLegRangeGroup group
| Range of trip legs (from - to) for which a Fare result (ticket) is valid. | ||||
5.26. The 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. | ||
5.21. The complex type TripFareResultStructure
| Structure of a Single Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
5.27. The complex type 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. | |||
5.22. The complex type 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. | ||
5.23. The FareDataFilterGroup group
| Data filter group for Fare request. | ||||
| 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. | |||
5.28. The complex type 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. | ||
5.29. The 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 | |||
5.24. The complex type FareParamStructure
| [related to the FARE parameter model in TM and NeTEx] parameters which are used to determine the price to be paid for a FARE PRODUCT by a specific passenger. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). | |||
5.30. The complex type FareParamStructure
| [related to the FARE parameter model in TM and NeTEx] parameters which are used to determine the price to be paid for a FARE PRODUCT by a specific passenger. | ||||
The element contains a sequence of the following elements: | |||||
| 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 | |||
| 0:* | Number of travellers that will make the journey and for which Fare information needs to be gathered. | |||
5.25. The complex type FareProblemStructure
| Problem that may be returned in responses to FARE requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the FARE problem. | |||
| 0:1 | Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). | |||
| 0:* | Number of travellers that will make the journey and for which Fare information needs to be gathered. | |||
5.31. The complex type FareProblemStructure
| Problem that may be returned in responses to FARE requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the FARE problem. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
| PlaceInformationResponse |
| 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:* | ||||
7.4. The complex type 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:* | 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/ | ||
7.5. The complex type PlaceParamStructure
| |||||
The element contains a sequence of the following elements: | |||||
7.4. The complex type 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/ | ||
7.5. The complex type 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:* | If at least one is set, only place objects within the given localities are allowed. | |||
| 0:1 | Filter to narrow down POI searches. | |||
| PlacePolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 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. | ||
| 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. | ||
| 0:1 | xs:boolean | Tells the service to include the available public transport modes at returned stops. | ||
7.6. The complex type GeoRestrictionsStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Area is defined by a polyline | ||
b |
| -1:1 | |||
c |
| -1:1 | |||
7.7. The complex type GeoCircleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:DistanceType | Radius in metres. | ||
7.8. The complex type GeoRectangleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:LocationStructure | |||
7.9. The complex type GeoAreaStructure
| [specialisation of ZONE in TMv6] a LINK SEQUENCE (one-dimensional) forming the boundary of a ZONE + | ||||
| 0:1 | xs:boolean | Tells the service to include the available operators at returned stops. | ||
| 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. | ||
7.6. The complex type GeoRestrictionsStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Area is defined by a polyline | ||
b |
| -1:1 | |||
c |
| -1:1 | |||
7.7. The complex type GeoCircleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:DistanceType | Radius in metres. | ||
7.8. The complex type GeoRectangleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:LocationStructure | |||
7.9. The complex type 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 | |||
7.10. The complex type 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. | |||
| 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. | ||
7.11. The PlacePolicyGroup group
| |||||
| PlacePolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 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 | siri:ParticipantRefStructure | Stores the system reference, where to ask for actual locations corresponding to this city name result. In order to get actual locations, a new location information request using the system ID of this result is needed. | ||
| 0:1 | List of operators operating at this place object. This list should only be filled if this is explicitly requested. | |||
7.11. The PlacePolicyGroup group
| |||||
| 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. | ||
| 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. | ||
| 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. | ||
7.12. The 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 | 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:1 | Filter to narrow down POI searches. | |||
7.13. The ExchangePointsRequestGroup group
| |||||
7.13. The 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. | ||
7.14. The 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 | |||
7.14. The complex type ExchangePointsParamStructure
| |||||
The element contains a sequence of the following elements: | |||||
7.15. The complex type 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. | |||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | |||
| 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. | ||
7.15. The ExchangePointsDataFilterGroup group
| |||||
7.16. The 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:* | If at least one is set, only 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. | ||
7.16. The ExchangePointsPolicyGroup group
| |||||
7.17. The ExchangePointsPolicyGroup group
| |||||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | |||
| 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. | ||
7.17. The ExchangePointsResponseGroup group
| |||||
7.18. The ExchangePointsResponseGroup group
| |||||
| 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:* | ||||
7.18. The complex type 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. | ||
8. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information
8.1. Simple type definitions
| 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_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 |
8.2. The StopPointGroup group
| A stop point with id and name | ||||
7.19. The complex type 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. | |||
8. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information
8.1. Simple type definitions
| 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 |
8.2. The StopPointGroup group
| A stop point with id and name | ||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| 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". | |||
| 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. | ||
8.9. The complex type TopographicPlaceRefStructure
8.10. The toplevel element TopographicPlaceRef
| Reference to a TopographicPlace | ||||
8.11. The complex type 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 | xs:normalizedString | 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. | ||
8.12. The complex type PointOfInterestRefStructure
| Reference to a Point of Interest | ||||
8.13. The toplevel element PointOfInterestRef
| Reference to a Point of Interest | ||||
8.14. The complex type 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 | ||||
8.15. The complex type 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]") | |
8.16. The complex type 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, ...) | ||
8.17. The complex type 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). | |||
8.18. The complex type AddressRefStructure
| Reference to an Address | ||||
8.19. The toplevel element AddressRef
| Reference to an Address | ||||
8.20. The AddressDetailGroup group
| An address with its name entities | ||||
8.9. The complex type TopographicPlaceRefStructure
8.10. The toplevel element TopographicPlaceRef
| Reference to a TopographicPlace | ||||
8.11. The complex type 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. | ||
8.12. The complex type PointOfInterestRefStructure
| Reference to a Point of Interest | ||||
8.13. The toplevel element PointOfInterestRef
| Reference to a Point of Interest | ||||
8.14. The complex type 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 | ||||
8.15. The complex type 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]") | |
8.16. The complex type 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, ...) | ||
8.17. The complex type 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). | |||
8.18. The complex type AddressRefStructure
| Reference to an Address | ||||
8.19. The toplevel element AddressRef
| Reference to an Address | ||||
8.20. The 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 | 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. | ||
8.22. The complex type 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:* | Attribute associated with this place. | |||
| 0:1 | xs:anyType | |||
8.23. The complex type 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/ | ||
8.24. The complex type 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. | |||
8.22. The complex type 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 | |||
8.23. The complex type 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/ | ||
8.24. The complex type 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. | ||||||||||||||||||||||||||||||||||||||||||
| StopEventContentFilter |
| 0:1 | xs:boolean | Whether the previous calls of each vehicle journey should be included in the response. | |||||||||||||||||||||||||||||||||||||||||
| 0:1 | xs:boolean | Whether the onward calls of each vehicle journey should be included in the response. | ||||||||||||||||||||||||||||||||||||||||||
| 0:1 | xs:boolean | Whether operating day information of this stop event should be included in the response. | ||||||||||||||||||||||||||||||||||||||||||
| 0:1 | xs:boolean | Whether realtime information of this stop event should be included in the response. | ||||||||||||||||||||||||||||||||||||||||||
| 0:1 | Whether real-time information of this stop event should be used in the response. Default is "full" | |||||||||||||||||||||||||||||||||||||||||||
| 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 | Indicates for which parts of the hierarchy of the StopPlace(s) stop events should @@ -545,7 +571,7 @@ OJP - Open API for distributed Journey StopEventContentFilter |
0:1 xs:boolean Whether the previous calls of each vehicle journey should be included in the response.
0:1 xs:boolean Whether the onward calls of each vehicle journey should be included in the response.
0:1 xs:boolean Whether operating day information of this stop event should be included in the response.
0:1 xs:boolean Whether realtime information of this stop event should be included in the response.
0:1 Whether real-time information of this stop event should be used in the response. Default is "full"
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 Indicates for which parts of the hierarchy of the StopPlace(s) stop events should @@ -563,12 +589,12 @@ OJP - Open API for distributed Journey | ||||||||||||||||||||||||||||||||||||||||||
9.8. The complex type 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. | |||
9.9. The complex type 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 | xs:anyType | |||
9.10. The complex type 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). | ||
9.11. The complex type 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 | |||
9.10. The complex type 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). | ||
9.11. The complex type 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. | ||
10. OJP/OJP_TripInfo.xsd - Request and response definitions for information on a single trip
10.1. Simple type definitions
| TRIPINFO_JOURNEYREFUNKNOWN | TRIPINFO_VEHICLEUNKNOWN | TRIPINFO_NOJOURNEYFOUND | TRIPINFO_NOGEOINFO | TRIPINFO_OTHER | Types of problems that may be returned in responses to TripInfo requests. |
10.2. The TripInfoRequestGroup group
| TripInfo request structure. | ||||
| TRIPINFO_JOURNEYREFUNKNOWN | TRIPINFO_VEHICLEUNKNOWN | TRIPINFO_NOJOURNEYFOUND | TRIPINFO_NOGEOINFO | TRIPINFO_NOREALTIME | TRIPINFO_OTHER | Types of problems that may be returned in responses to TripInfo requests. |
10.2. The TripInfoRequestGroup group
| TripInfo request structure. | ||||
The element contains one of the following elements: | |||||
| DatedJourneyRef | a | 1:1 | Reference to a Journey | ||
a | 1:1 | Reference to an Operating Day | |||
| TripInfoRequest |
| 0:1 | Request parameter. | ||
10.3. The complex type TripInfoParamStructure
| TripInfo request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| TripInfoPolicy |
| 0:1 | xs:boolean | Do not show any realtime or incident data. Default is false. | |
| TripInfoPolicy |
| 0:1 | Use real-time data. Default is "full" | ||
| TripInfoContentFilter |
| 0:1 | xs:boolean | Whether call information is to be included. Default is true. | |
| 0:1 | xs:boolean | Whether current position is to be included. Default is true. | ||
| 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 | Whether 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:anyType | |||
10.4. The TripInfoPolicyGroup group
| Parameters that control the response behaviour. | ||||
| TripInfoPolicy |
| 0:1 | xs:boolean | Do not show any realtime or incident data. Default is false. | |
| TripInfoPolicy |
| 0:1 | Use real-time data. Default is "full" | ||
10.5. The TripInfoContentFilterGroup group
| Parameters that control the level of detail to be returned in the results. | ||||
| TripInfoContentFilter |
| 0:1 | xs:boolean | Whether call information is to be included. Default is true. | |
| 0:1 | xs:boolean | Whether current position is to be included. Default is true. | ||
| |||||
| 0:1 | Geographic embedding of this journey. The entire journey is regarded as one leg. | |||
| 0:1 | xs:anyType | |||
10.8. The complex type TripInfoProblemStructure
| Problem that may be returned in responses to TripInfo requests. | ||||
The element contains only one element: | |||||
| 1:1 | Type of the TripInfo problem. | |||
11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
11.1. Simple type definitions
| elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown | Allowed values for a AccessFeature. |
| lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator | Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to). |
| origin | destination | continue | keep | turn | leave | enter | various types of guidance advice given to travelle |
| anyPoint | eachOrigin | eachDestination | How the multiple origin/destination points should be considered |
| fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | the types of algorithm that can be used for planning a journey (fastest, least walking, etc). If multiple optimisation methods are needed, then several requests should be performed in parallel. |
| up | down | level | upAndDown | downAndUp | Transition types for interchanges. |
| TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | TRIP_OTHER | Types of problems that may be returned in responses to Trip requests. |
| sharp left | left | half left | straight on | half right | right | sharp right | uturn | the range of alternative turns that can be described |
11.2. The TripRequestGroup group
| Trip request structure. | ||||
| TripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| unknown | available | partiallyAvailable | notAvailable | Allowed values for status of the access feature. |
| elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown | Allowed values for a AccessFeature. |
| lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator | Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to). |
| allAccessFeaturesAvailable | accessFeatureNotAvailable | accessFeaturePartiallyAvailable | accessFeatureWithUnknownAvailability | seeSituations | Allowed values for the feasibility of a TRIP or part of a TRIP. |
| origin | destination | continue | keep | turn | leave | enter | enter_roundabout | stay_in_roundabout | leave_roundabout | enter_builtup_area | leave_builtup_area | freewayAccessRamp | unknown_lane_choice | left_lane | middle_lane | right_lane | unknown_turning_kind | Various types of guidance advice given to traveller. Suitable values may differ by MODE (e.g. a car driver needs different advice than a person walking for a transfer. |
| anyPoint | eachOrigin | eachDestination | eachOriginDestination | somePoints | How the multiple origin/destination points should be considered. + Note: Unfortunately this element was underdefined before and this resulted in different implementations. + Note: MultiPointType trumps the number of results. If the algorithm thinks it necessary to provide more results, it should. + |
| fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | environmentalSafety | extraSafe | extraReliable | scenic | quietTravel | The types of algorithm that can be used for planning a journey (fastest, least walking, etc.). If multiple optimisation methods are needed, then several requests should be performed in parallel. |
| up | down | level | upAndDown | downAndUp | Transition types for interchanges. |
| TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | TRIP_OTHER | Types of problems that may be returned in responses to Trip requests. |
| straight_on | half_right | right | sharp_right | uturn | sharp_left | left | half_left | up | down | unknown_turn_action | The range of possible turns that can be described. |
11.2. The TripRequestGroup group
| Trip request structure. | ||||
| TripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. + Note: Systems may support only one. | |||
| 0:* | siri:ParticipantRefStructure | With this parameter a distributing system is asked to build a trip using a given System to pass through. This helps in selecting Exchange Points for this trip. ViaSystem is also used in sequence. + Note: Systems may support only one. | ||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
| 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| TripPolicy |
| 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) | |||
| 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) | ||
| 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. | ||
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 0:1 | Cycling profile of the user (especially for sportive activities). | |||
| 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 | |||
11.4. The 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. | ||
| 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| TripPolicy |
| 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) | |||
| 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) | ||
11.6. The TripMobilityFilterGroup group
| Parameters the user can set to restrict the mobility options - particularly for interchanging. | ||||
| 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. | ||
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 0:1 | Cycling profile of the user (especially for sportive activities). | |||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. | ||
11.8. The complex type 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 | |||
11.9. The complex type 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 | |||
11.10. The complex type 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 | ||||
11.11. The TripResponseGroup group
| Trip response structure. | ||||
11.8. The complex type 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:* | ||||
11.9. The complex type 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 | |||
11.10. The complex type 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 | |||
11.11. The complex type 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 | ||||
11.12. The 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. | |||
11.12. The complex type 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:* | ||||
11.13. The complex type 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. | ||
11.13. The complex type 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:* | ||||
11.14. The complex type 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. | ||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
11.14. The complex type 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 | |||
11.15. The complex type 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 | |||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| TripStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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 | 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:1 | xs:anyType | |||
11.15. The complex type 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 | |||
11.16. The complex type 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. | |||
| 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 | |||
11.16. The complex type 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 | |||
| 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. | |||
11.17. The complex type 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. | |||
| 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 | xs:anyType | |||
11.17. The complex type TransferLegStructure
| [a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Mode that is used for this interchange between public services. | ||
b |
| -1:1 | Mode that is used for this interchange between public services. | ||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
| 0:1 | Geographic embedding of this leg. | |||
| 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. | |||
| 0:1 | xs:anyType | |||
11.18. The complex type TransferLegStructure
| [a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Mode that is used for this interchange between public services. | ||
b |
| -1:1 | Mode that is used for this interchange between public services. | ||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
| TransferDuration |
| 1:1 | xs:duration | Overall duration of this interchange. | |
| 0:1 | xs:duration | Walk time as part of the overall interchange duration. | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains. | ||
| 0:1 | Text that describes this interchange. | |||
| 0:1 | Length of this interchange path. | |||
| 0:* | Note or service attribute. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
11.18. The complex type ContinuousLegStructure
| [relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
| 1:1 | Service of this leg. May be "walk" in most cases, but also cycling or taxi etc. | |||
| 0:1 | Text that describes this interchange. | |||
| 0:1 | Length of this interchange path. | |||
| 0:* | Note or service attribute. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility. | |||
| 0:* | Information about the feasibility of the TransferLeg, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType | |||
11.19. The complex type ContinuousLegStructure
| [relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
| 1:1 | Service of this leg. May be "walk" in most cases, but also cycling or taxi etc. | |||
| TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
| 1:1 | xs:duration | Duration of this leg according to user preferences like walk speed. | ||
| 0:1 | Title or summary of this leg for overview. | |||
| 0:1 | Length of the leg. | |||
| 0:1 | Detailed description of each element of this leg including geometric projection. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility. | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
11.19. The complex type 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: | |||||
| 1:1 | xs:duration | Duration of this leg according to user preferences like walk speed. | ||
| 0:1 | Title or summary of this leg for overview. | |||
| 0:1 | Length of the leg. | |||
| 0:1 | Detailed description of each element of this leg including geometric projection. | |||
| 0:1 | Structured model further describing this interchange, its geographic embedding and accessibility. | |||
| 0:* | Information about the feasibility of the ContinuousLeg, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 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. | |||
| 0:1 | xs:anyType | |||
11.20. The complex type 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 | ||
| 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 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
11.20. The complex type 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: | |||||
11.21. The complex type 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 | ||
| 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 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
11.21. The complex type 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: | |||||
11.22. The complex type 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 | ||
| 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 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
11.22. The complex type PathGuidanceStructure
| description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information | ||||
The element contains only one element: | |||||
| 1:* | one or more path guidance sections that build the trip Leg | |||
11.23. The complex type PathGuidanceSectionStructure
| [an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information | |||
| 0:1 | Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName. | |||
| 0:1 | various types of guidance advice given to travelle. | |||
| 0:1 | the range of alternative turns that can be described. | |||
| 0:1 | Textual direction hint for better understanding, e.g. "follow signs to Hamburg". | |||
| 0:1 | siri:AbsoluteBearingType | Absolute bearing after the described manoeuvre. | ||
| 0:1 | Description of the type of accessibility on this navigation section. | |||
| 0:* | ||||
11.24. The TransferDurationGroup group
| [an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time.. | ||||
11.23. The complex type PathGuidanceStructure
| Description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information. | ||||
The element contains only one element: | |||||
| 1:* | One or more PATH GUIDANCE sections that form the LEG. For a good PATH GUIDANCE a fine granularity of the sections may be needed. This may also depend on the MODE and the type of guidance required. | |||
11.24. The complex type PathGuidanceSectionStructure
| An extended definition of a NAVIGATION PATH in TMv6 and PATH GUIDANCE to include the textual navigation instructions. Description of a part of a TRIP. May include geographic information, turn instructions and accessibility information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | LINK PROJECTION on the infrastructure network of the LEG together with time information | |||
| 0:1 | Textual description of a manoeuvre. This should imply the information from Manoeuvre, TurnAction, and TrackSection.RoadName. | |||
| 0:1 | Various types of guidance advice given to traveller. | |||
| 0:1 | The range of possible turns that can be described. | |||
| 0:1 | Road name | |||
| 0:* | Signs, roads, POI to follow. | |||
| 0:1 | Textual direction hint for better understanding, e.g. "follow signs to Hamburg". | |||
| 0:1 | siri:AbsoluteBearingType | Absolute bearing (sky direction) after the described manoeuvre. | ||
| 0:1 | Description of the type of accessibility on this navigation section. This view is simplified in comparison to the NeTEx PathLink structure. | |||
| 0:1 | A list of references to SITUATIONs. | |||
11.25. The complex type FollowStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Follow a direction. | ||
b |
| -1:1 | Follow an exit. | ||
c |
| -1:1 | Follow a road/route. | ||
d |
| -1:1 | Follow a sign. | ||
11.26. The TransferDurationGroup group
| [an attribute of a CONNECTION (not INTERCHANGE) in TMv6] calculated duration in a response taking into ccount the request parameters.; TransferDuration plus waiting time is the minimum interval between arrival and departure time.. | ||||
| TransferDuration |
| 1:1 | xs:duration | Overall duration of this interchange. | |
| 0:1 | xs:duration | Walk time as part of the overall interchange duration. | ||
| 0:1 | xs:duration | Buffer time as part of the overall interchange duration. Buffer times, f.e. check in/out times, sometimes are mandatory for using certain services as f.e. airplanes, ferries or highspeed trains. | ||
11.25. The complex type PathLinkStructure
| [TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs,BOARDING POSITIONs,, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Whether path is up down or level . | |||
| 0:1 | Type of physical feature of PATH LINK. | |||
| 0:1 | xs:positiveInteger | Number how often the access feature occurs in this PathLink | ||
| 0:* | Presence of an accessibility feature on the PathLink. | |||
| 0:1 | Designations of level and place where this PathLink starts. | |||
| 0:1 | Designations of level and place where this PathLink ends. | |||
11.26. The complex type PathLinkEndStructure
| Designations of a floor/level. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:normalizedString | Public identifier of the level as found on elevators and signs. | ||
| 0:1 | Official name of the level. | |||
| 0:1 | xs:normalizedString | Id of the element at this end of the PathLink (typically a PLACE, e.g. where the elevator is located). | ||
11.27. The MultiPointTripRequestGroup group
| Multi-point trip request structure. | ||||
11.27. The complex type PathLinkStructure
| [TMv6] a link within a PLACE of or between two PLACEs (that is STOP PLACEs, ACCESS SPACEs or QUAYs, BOARDING POSITIONs, POINTs OF INTEREST etc or PATH JUNCTIONs) that represents a step in a possible route for pedestrians, cyclists or other out-of-vehicle passengers within or between a PLACE. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Whether path is up, down or level. | |||
| 0:1 | Type of physical feature of PATH LINK. | |||
| 0:1 | xs:positiveInteger | Number indicating how often the access feature occurs in this PathLink | ||
| 0:1 | Whether the access feature is available or out of service. | |||
| 0:1 | Textual information about reduced availability of the access feature, in particular if AccessFeatureStatus is partiallyAvailable. | |||
| 0:* | Presence of an accessibility feature on the PathLink. | |||
0:* | Reference to a situation that affects the availability of the access feature. | ||||
| 0:1 | Designations of level and place where this PathLink starts. | |||
| 0:1 | Designations of level and place where this PathLink ends. | |||
11.28. The complex type PathLinkEndStructure
| Designations of a floor/level. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:normalizedString | Public identifier of the level as found on elevators and signs. | ||
| 0:1 | Official name of the level. | |||
| 0:1 | xs:normalizedString | Id of the element at this end of the PathLink (typically a PLACE, e.g. where the elevator is located). | ||
11.29. The MultiPointTripRequestGroup group
| Multi-point trip request structure. | ||||
| MultiPointTripRequest |
| 1:* | Specifies the origin situation from where the user wants to start. | ||
| 1:* | Specifies the destination situation where the user is heading to. | |||
| 0:* | Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops. | |||
| 0:* | Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed. | |||
| 0:* | no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP | |||
| 0:1 | Options to control the search behaviour and response contents. | |||
11.28. The complex type MultiPointTripParamStructure
| Multi-point trip request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
11.30. The complex type MultiPointTripParamStructure
| Multi-point trip request parameter structure. | ||||
The element contains a sequence of the following elements: | |||||
| 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. | |||
| 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| 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 | 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. | |||
| 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. | ||
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 0:1 | Cycling profile of the user (especially for sportive activities). | |||
| 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 | |||
11.29. The MultiPointTripPolicyGroup group
| Policies that control the multi-point trip search behaviour. | ||||
| 0:1 | ||||
| 0:1 | xs:anyType | |||
11.31. The MultiPointTripPolicyGroup group
| Policies that control the multi-point 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
| 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 | 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. | |||
11.30. The MultiPointTripResponseGroup group
| Multi-point trip response structure. | ||||
| MultiPointTripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
11.32. The 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. | |||
11.31. The complex type 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 | |||
11.33. The complex type 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 | |||
| 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:* | ||||
11.32. The MultiPointWaitTimeGroup group
| Group for wait times at origin/destination. | ||||
| 0:* | ||||
11.34. The 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. | ||
11.33. The TripStatusGroup group
| Parameters which describe the current status of a TRIP | ||||
11.35. The TripStatusGroup group
| Parameters which describe the current status of a TRIP | ||||
| TripStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 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 | 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. | ||
11.34. The TripRefineRequestGroup group
| Trip refinement request structure. | ||||
11.36. The TripRefineRequestGroup group
| Trip refinement request structure. | ||||
| TripRefineRequest |
| 0:1 | Options to control the refine | ||
| 1:1 | The trip result to be refined by the server. | |||
| 0:1 | Context to hold objects, which are referenced within the response. | |||
11.35. The complex type 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. | ||
| 1:* | xs:NMTOKEN | Refers to a leg to be refined by the server. | ||
11.37. The complex type 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. | ||
| 1:* | xs:NMTOKEN | Refers to a leg to be refined by the server. | ||
| 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. | |
| 0:1 | xs:boolean | Whether the result should include the geographic projection (coordinates) of each journey leg. | ||
| 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 | ||
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters. | ||
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 0:1 | Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen | |||
| 0:1 | Cycling profile of the user (especially for sportive activities). | |||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. | ||
| 0:1 | Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). | |||
| 0:1 | xs:anyType | |||
11.36. The TripRefineResponseGroup group
| Trip refinement response structure. | ||||
| 0:1 | Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). | |||
| 0:1 | xs:anyType | |||
11.38. The TripRefineResponseGroup group
| Trip refinement response structure. | ||||
| TripRefineResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | xs:NMTOKEN | Refers to a leg that was not found in the data of the server. If the to be refined TripResult could not be found or unequivocally determined, all RefineLegRefs are returned as UnknownLegRefs. | ||
| 0:* | The trip results refined by the server. | |||
11.37. The complex type TripProblemStructure
| Problem that may be returned in responses to trip requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the trip problem. | |||
11.39. The complex type TripProblemStructure
| Problem that may be returned in responses to trip requests. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Type of the trip problem. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
12. OJP/OJP_JourneySupport.xsd - Supporting definitions for journeys on public transport vehicles
12.1. Simple type definitions
| none | service | stop | Possible types of reservation needed for services. |
| Not yet operated | Operation finished | At stop | Between stops | Vehicle progress relative to timetable service pattern. |
12.2. The complex type 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: | |||||
| 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. |
12.2. The complex type 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 | ||
| 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". | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | |||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | |||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | |||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
a |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | |
a |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | ||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
12.13. The complex type 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 | ||||
| |||||
12.14. The 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 | |||
12.13. The complex type 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 | ||||
| |||||
12.14. The 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. | ||
12.15. The ServiceTimeGroup group
| Contains at least scheduled time, but can contain real time and estimated times | ||||
| 0:1 | xs:boolean | The vehicle will not call at this stop despite earlier planning. | ||
| 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. | ||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
12.20. The StopCallStatusGroup group
| Status properties for the vehicle call at this stop. | ||||
| 0:1 | A list of references to SITUATIONs. | |||
12.20. The StopCallStatusGroup group
| Status properties for the vehicle call at this stop. | ||||
| StopCallStatus |
| 0:1 | xs:positiveInteger | Sequence number of this stop in the service pattern of the journey. | |
| 0:1 | xs:boolean | The vehicle journey calls at this stop only on demand. | ||
| 0:1 | xs:boolean | This stop has not been planned by the planning department. | ||
a |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | ||
a |
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | |
a |
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | |
a | 0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | |||
a |
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | ||
a |
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | ||
a |
| 0:* | Via points of the service that may help identify the vehicle to the public. | ||
a |
| 0:* | Note or service attribute. | ||
| 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:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType | |||
12.23. The complex type 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. | ||
12.24. The complex type 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. | |||
12.25. The 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 | |||
12.23. The complex type 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. | ||
12.24. The complex type 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. | |||
12.25. The 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). | ||
12.26. The BaseTripPolicyGroup group
| Policies that control the trip search behaviour for both public and individual transport. | ||||
| 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. |
| 0:1 | xs:boolean | The trip calculation should not use any realtime or incident data. | ||
| 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. | ||
12.27. The 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. | |
| 1:1 | Line name or service description as known to the public, f.e. "512", "S8" or "Circle Line" or "ICE 488". | |||
| 0:1 | xs:normalizedString | Contains the TrainNumber from NeTEx (TRAIN NUMBER from Transmodel). If several TrainNumber types exist, use the commercial one. In some cases also non-train modes will use TrainNumber. | ||
| 0:1 | →siri:VehicleRef | Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id. | ||
0:1 | Reference to an Operator ([TMv6] company providing public transport services.) Reference to transport operatorIdentifier of the operator of the sharing service | ||||
| 0:1 | References to the OPERATORS. Multiple OPERATORS in case a ContinuousLeg can be operated by more than one operator, especially in the ALTERNATIVE MODE OF OPERATION where there can be dozens of taxi companies and many free floating sharing companies. | |||
| 0:1 | Descriptive text for a route, f.e. "Airport via City Centre" | |||
| 0:* | Via points of the service that may help identify the vehicle to the public. | |||
| 0:* | Note or service attribute. | |||
| ProblemDetail |
| 0:1 | Title of the problem. | ||
| 0:1 | Explanation of the problem. | |||
| 0:1 | xs:string | Additional log data. | ||
14.3. The complex type PrivateCodeStructure
| Code within scope of a private referential system | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Code of the foreign referential system. | ||
| 1:1 | xs:NMTOKEN | Object code within this private/foreign system. | ||
14.4. The complex type LinearShapeStructure
| An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure. | ||||
The element contains only one element: | |||||
| 2:* | siri:LocationStructure | Ordered list of locations representing the geometry of the link or route. | ||
14.5. The complex type AreaStructure
| Area described as a polygon. | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | Ordered list of geographic locations describing the polygon of the area. | ||
14.6. The toplevel element ParticipantRef
| siri:ParticipantRefStructure | Reference to a Participant ([equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)) | |||
14.7. The toplevel element OperatorRef
| siri:OperatorRefStructure | Reference to an Operator ([TMv6] company providing public transport services.) | |||
14.8. The complex type OperatorFilterStructure
| Filter for in/exclusion of transport operators. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether operators in list are to include or exclude from search. Default is exclude. | ||
| 0:* | siri:OperatorRefStructure | Reference to transport operator | ||
14.9. The complex type ProductCategoryRefStructure
| Reference to a product category. As defined in NeTEx and SIRI, a product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products, e.g. to identify boats that run with steam in Switzerland ("BAV") | ||||
14.10. The toplevel element ProductCategoryRef
| siri:ProductCategoryRefStructure | Reference to a product category. Product categories should be defined once and used uniformly in all channels (e.g. NeTEx, SIRI, OJP) | |||
14.11. The complex type LineDirectionFilterStructure
| Filter for in/exclusion of lines (and directions). | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | siri:LineDirectionStructure | Reference a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables.. | ||
| 0:1 | xs:boolean | Whether lines in list are to include or exclude from search. Default is exclude. | ||
14.12. The complex type JourneyRefStructure
| Reference to a Journey | ||||
14.13. The toplevel element JourneyRef
| Reference to a Journey | ||||
14.14. The DatedJourneyRefGroup group
| Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day) | ||||
14.3. The complex type PrivateCodeStructure
| Code within scope of a private referential system | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Code of the foreign referential system. | ||
| 1:1 | xs:NMTOKEN | Object code within this private/foreign system. | ||
14.4. The complex type LinearShapeStructure
| An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure. | ||||
The element contains only one element: | |||||
| 2:* | siri:LocationStructure | Ordered list of locations representing the geometry of the link or route. | ||
14.5. The complex type AreaStructure
| Area described as a polygon. | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | Ordered list of geographic locations describing the polygon of the area. | ||
14.6. The toplevel element ParticipantRef
| siri:ParticipantRefStructure | Reference to a Participant ([equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)) | |||
14.7. The toplevel element OperatorRef
| siri:OperatorRefStructure | Reference to an Operator ([TMv6] company providing public transport services.) | |||
14.8. The complex type OperatorRefs_RelStructure
| |||||
The element contains only one element: | |||||
| 1:* | siri:OperatorRefStructure | |||
14.9. The complex type OperatorFilterStructure
| Filter for in/exclusion of transport operators. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether operators in list are to include or exclude from search. Default is exclude. | ||
| 0:* | siri:OperatorRefStructure | Reference to transport operator | ||
14.10. The complex type ProductCategoryRefStructure
| Reference to a product category. As defined in NeTEx and SIRI, a product category is a classification for VEHICLE JOURNEYs to express some common properties of journeys for marketing and fare products, e.g. to identify boats that run with steam in Switzerland ("BAV") | ||||
14.11. The toplevel element ProductCategoryRef
| siri:ProductCategoryRefStructure | Reference to a product category. Product categories should be defined once and used uniformly in all channels (e.g. NeTEx, SIRI, OJP) | |||
14.12. The complex type LineDirectionFilterStructure
| Filter for in/exclusion of lines (and directions). | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | siri:LineDirectionStructure | Reference a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables.. | ||
| 0:1 | xs:boolean | Whether lines in list are to include or exclude from search. Default is exclude. | ||
14.13. The complex type JourneyRefStructure
| Reference to a Journey | ||||
14.14. The toplevel element JourneyRef
| Reference to a Journey | ||||
14.15. The DatedJourneyRefGroup group
| Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day) | ||||
| DatedJourneyRef | 1:1 | Reference to a Journey | |||
1:1 | Reference to an Operating Day | ||||
14.15. The TimedVehicleRefGroup group
| Reference to a vehicle for a specific point in time. | ||||
14.16. The TimedVehicleRefGroup group
| Reference to a vehicle for a specific point in time. | ||||
| TimedVehicleRef |
| 1:1 | →siri:VehicleRef | ||
| 1:1 | xs:dateTime | Time stamp when the vehicle is operating. In most use cases equal to "now". | ||
14.16. The complex type 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 | ||
14.17. The SharingServiceUsageGroup group
| Usage parameters of a sharing service. | ||||
14.17. The complex type 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 | ||
14.18. The 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. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. | ||
14.18. The complex type SharingServiceStructure
| Service that provides shared vehicles. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:OperatorRefStructure | Identifier of the operator of the sharing service | ||
| 0:1 | xs:string | Public name of the service. | ||
| 0:1 | Type of the sharing scheme. | |||
14.19. The complex type SharingServiceStructure
| Service that provides shared vehicles. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:OperatorRefStructure | Identifier of the operator of the sharing service | ||
| 0:1 | xs:string | Public name of the service. | ||
| 0:1 | Type of the sharing scheme. | |||
| SharingServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. | ||
| 0:1 | Link to web page providing more details on service. | |||
14.19. The complex type OwnerRefStructure
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
14.20. The toplevel element OwnerRef
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
14.21. The complex type OperatingDayRefStructure
| Reference to an Operating Day | ||||
14.22. The toplevel element OperatingDayRef
| Reference to an Operating Day | ||||
14.23. The complex type OperatingDaysStructure
| [TMv6] day of public transport operation of which the characteristics are defined in a specific SERVICE CALENDAR and which may last more than 24 hours. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:date | Start date of period. | ||
| 1:1 | xs:date | End date of period. | ||
| 1:1 | Bit pattern for operating days between start date and end date. The length of the pattern is equal to the number of days from start date to end date. A bit value of "1" indicates that an event actually happens on the day that is represented by the bit position. | |||
14.24. The OperatingDaysGroup group
| Coded as bit pattern | ||||
| 0:1 | Link to web page providing more details on service. | |||
14.20. The complex type OwnerRefStructure
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
14.21. The toplevel element OwnerRef
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE | ||||
14.22. The complex type OperatingDayRefStructure
| Reference to an Operating Day | ||||
14.23. The toplevel element OperatingDayRef
| Reference to an Operating Day | ||||
14.24. The complex type OperatingDaysStructure
| [TMv6] day of public transport operation of which the characteristics are defined in a specific SERVICE CALENDAR and which may last more than 24 hours. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:date | Start date of period. | ||
| 1:1 | xs:date | End date of period. | ||
| 1:1 | Bit pattern for operating days between start date and end date. The length of the pattern is equal to the number of days from start date to end date. A bit value of "1" indicates that an event actually happens on the day that is represented by the bit position. | |||
14.25. The OperatingDaysGroup group
| Coded as bit pattern | ||||
| 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". | |||
14.25. The complex type WeekdayTimePeriodStructure
| [a specialisation of TIME BAND in TMv6] aggregation of TIME BAND and DAY OF WEEK (Time period on a weekday). | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays | |||
| 1:1 | xs:time | Start time of period. | ||
| 1:1 | xs:duration | Time duration of period. | ||
14.26. The complex type GeneralAttributeStructure
| Structured attribute classification with associated text. If URL is given, it refers to the whole attribute text. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Text of the attribute to be shown to the user. | |||
| 1:1 | xs:NMTOKEN | Internal code of the attribute. Can be used for detection of double occurrences. | ||
14.26. The complex type WeekdayTimePeriodStructure
| [a specialisation of TIME BAND in TMv6] aggregation of TIME BAND and DAY OF WEEK (Time period on a weekday). | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays | |||
| 1:1 | xs:time | Start time of period. | ||
| 1:1 | xs:duration | Time duration of period. | ||
14.27. The complex type GeneralAttributeStructure
| Structured attribute classification with associated text. If URL is given, it refers to the whole attribute text. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Text of the attribute to be shown to the user. | |||
| 1:1 | xs:NMTOKEN | Internal code of the attribute. Can be used for detection of double occurrences. | ||
| |||||
| 0:1 | xs:boolean | Defines whether the attribute has to be shown to the user. | ||
| 0:1 | Importance of the attribute. | |||
| WebLink |
| 1:1 | xs:anyURI | URL to resource on web. | |
| 0:1 | xs:normalizedString | MIME type of the referenced resource. To which kind of resource does the URL point to? | ||
| 0:1 | xs:boolean | Is the referenced resource meant to be embedded as a webview in a surrounding context, e.g. app or web page? If yes, the resource has to be fully responsive. Default is false. | ||
14.28. The SustainabilityGroup group
| Elements about sustainability. Primarily for TRIPs and LEGs. | ||||
| 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. | |||
15. OJP/OJP_FacilitySupport.xsd - Supporting definitions for facilities containing wrappers for SIRI
15.1. The AllFacilitiesGroup group
| Wrapper for SIRI facilities. | ||||
| |||||
15.2. The StopFacilityGroup group
| Wrapper for SIRI stop facilities. | ||||
16.5. The complex type 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. | ||
| |||||
16.6. The complex type 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. | |||
17. OJP/OJP_SituationSupport.xsd - Supporting definitions for situations containing wrappers for SIRI Situation Exchange service (SIRI SX)
17.1. The complex type SituationsStructure
| Wrapper type for SIRI PtSituationsElementStructure | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | siri:PtSituationElementStructure | SIRI situation details. | ||
| 0:* | siri:RoadSituationElementStructure | |||
17.2. The toplevel element SituationFullRef
| Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
17.3. The complex type SituationFullRefStructure
| siri:SituationFullRefStructure | Reference structure for situation message. Situation details might be found in response context or through other communication channels. | |||
17.4. The complex type 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. | ||||
18. OJP/OJP_Utility.xsd - Support definitions not specifically related to the public transport domain
18.1. Simple type definitions
| 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 |
18.2. The complex type 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. | ||
18.3. The WebLinkGroup group
| URL of a web resource including type of resource. | ||||
| WebLink |
| 1:1 | xs:anyURI | URL to resource on web. | |
| 0:1 | xs:normalizedString | MIME type of the referenced resource. To which kind of resource does the URL point to? | ||