xsd.2.0.OJP.OJP_StopEvents.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojp-java-model Show documentation
Show all versions of ojp-java-model Show documentation
Generates Java model from OJP xsds using jaxb.
The newest version!
OJP/OJP_StopEvents.xsd - Request and response definitions for arrivals and departures of public transport services at stops
========================================== Request definitions ==========================================
Request structure for departure and arrival events at stops
LOCATION / PLACE for which to obtain stop event information. If a coordinate or an address is used, then the result may depend on other parameters: All stops in reasonable walking distance and stops that are within range of limitations of the IndividualTransportOptions should be shown. If the next stop is too far away, then no result is shown. "Reasonable" is usually defined as part of the server configuration.
Request parameter
Request specific parameters (parameters which define what is to be included in a Stop Event result)
Request data filters
MODEs to be excluded or included in stop events. We on purpose don't use ModeOfOperationFilter in the stop event service.
Lines/Directions to include/exclude.
Transport operators to include/exclude.
There might exist lines that have special restrictions and are not generally available to the public. E.g. school buses, company shuttles. dragLifts need to have an ACCESS MODE ski. Lines with ACCESS MODE bicycle will be included as well. If this flag is set, then existing restricted lines are considered by the router. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements.
Request policies
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
Time window events should lie within. Starting from time given in PlaceContext.
Only departures or arrivals or both.
Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided
(if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only
provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/StopPlaces in the hierarchy, if
such a hierarchy exists. "all" does include all StopPoints/StopPlaces for the meta station if it is known. How
to use this: if you indicate the reference to a train station and the parameter is set to "down", the departures/
arrivals at the associated bus stations will show as well. If you have the ScheduledStopPoint of platform B of
the local bus and it is associated with 3 other stations, you will get all these arrivals/departures as well,
if the parameter is set to "all".
Content filters which data is expected in the response
Whether the previous calls of each vehicle journey should be included in the response.
Whether the onward calls of each vehicle journey should be included in the response.
Whether operating day information of this stop event should be included in the response.
Whether real-time information of this stop event should be used in the response. Default is "full"
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.
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
Indicates for which parts of the hierarchy of the StopPlace(s) stop events should
be provided (if known by the server). "local" (default) is the local server setting. "no" will include
no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/
StopPlaces in the hierarchy, if such a hierarchy exists. "all" does include all StopPoints/StopPlaces
for the meta station if it is known. How to use this: if you indicate the reference to a train station
and the parameter is set to "down", the departures/arrivals at the associated bus stations will show as
well. If you have the ScheduledStopPoint of platform B of the local bus and it is associated with 3 other
stations, you will get all these arrivals/departures as well if the parameter is set to "all".
Departure or arrival events or both
========================================== Response definitions ==========================================
Response structure for departure and arrival events at stops
Container for data that is referenced multiple times.
Enclosing element for stop event data.
Type for identifier of a NeTEx Object.
Wrapper element for a single stop event result.
ID of this result.
Problems related to this STOPEVENT result.
Stop event data element.
Stop event structure.
Calls at stops that happen before this stop event (service pattern of this vehicle journey before this stop event).
The call of this vehicle journey at this stop.
Calls at stops that happen after this stop event (rest of the service pattern of the vehicle journey).
Service that calls at this stop.
For SITUATIONs that affect the whole StopEvent. Otherwise, references for SITUATIONs can be added at the different CALL elements
indication of the walk distance and time to a nearby stop where relevant.
[same as CALL in SIRI] the meeting of a VEHICLE JOURNEY with a specific SCHEDULED STOP POINT.
Distance from request LOCATION / PLACE (e.g., address) to this stop in metres.
Walking duration from request LOCATION / PLACE (e.g., address) to this stop. All user options considered (e.g., walk speed).
========================================== Problems ==========================================
Types of problems that may be returned in responses to STOPEVENT requests.
No departure/arrival could be found within the requested period that meets the given restrictions.
At the locations (address, stop, etc.) for which stop events have been requested, there is no public transport service at all.
The location (address, stop, etc.) for which stop events were requested is unknown.
There are no timetables available for the requested date.
This departure/arrival event is the last one of this line for this operating day.
There is no real-time or forecast data available for this departure/arrival event.
A problem has occurred that does not have a specific problem type.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy