• Home
• org.opentripplanner
• ojp-java-model
• 2.0.1
• source code
• OJP_Requests.xsd

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

xsd.2.0.OJP.OJP_Requests.xsd Maven / Gradle / Ivy

  
    OJP/OJP_Requests.xsd - OJP service requests and responses
  
  
  
  
    ========================================== Fare Service ==========================================
  
  
    
      This service provides general, stop-specific and trip-specific fare information. This service implements the models PI Stop Fare Request, PI FQ Fare Product Request, PI FQ Single Trip Fare Request from TM 6.
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      This service provides general, stop-specific and trip-specific fare information. This service implements the models PI Stop Fare Request, PI FQ Fare Product Request, PI FQ Single Trip Fare Request from TM 6.
    
  
  
    
      
        
          
          
          
          
        
      
    
  
  
    ========================================== Location Information Service ==========================================
  
  
    
      The Location Information service comprises the following four base functions:
matching text input against possible origin and destination locations, retrieval of all location objects (bunch delivery), geographical context service that provides location objects within a bounding box, reverse address resolution service that delivers the nearest address for a given coordinate.
By means of abstraction these functions are assembled within one single service – the Location Information service. This way, even more possible applications have arisen, such as: finding the nearest stops/stations for a given coordinate, matching text input against the names of locations near a given coordinate. This service implements the model PI QR Location Request from TM 6.
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      The Location Information service comprises the following four base functions:
matching text input against possible origin and destination locations, retrieval of all location objects (bunch delivery), geographical context service that provides location objects within a bounding box, reverse address resolution service that delivers the nearest address for a given coordinate.
By means of abstraction these functions are assembled within one single service – the Location Information service. This way, even more possible applications have arisen, such as: finding the nearest stops/stations for a given coordinate, matching text input against the names of locations near a given coordinate. This service implements the model PI QR Location Request from TM 6.
    
  
  
    
      
        
          
          
          
          
        
      
    
  
  
    ========================================== ExchangePoints Service ==========================================
  
  
    
      Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner must find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located.
The boundary points where the trip calculation is handed over to the next journey planning system are called exchange points. If they are not known in advance the exchange points can be looked up from a server by using the exchange points service. This service implements the model PI QR Location Request from TM 6.
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner must find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located.
The boundary points where the trip calculation is handed over to the next journey planning system are called exchange points. If they are not known in advance the exchange points can be looked up from a server by using the exchange points service. This service implements the model PI QR Location Request from TM 6.
    
  
  
    
      
        
          
          
          
          
        
      
    
  
  
    ========================================== StopEvent Service ==========================================
  
  
    
      This service provides information on arrivals and/or departures of public transport services from stops for a requested time or period of time. Restrictions can be set in the request parameters that filter the result contents accordingly. This service implements the model PI QR Stop Event Request from TM 6
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      This service provides information on arrivals and/or departures of public transport services from stops for a requested time or period of time. Restrictions can be set in the request parameters that filter the result contents accordingly. This service implements PI QR Stop Event Request from TM 6
    
  
  
    
      
        
          
          
          
          
        
      
    
  
  
    ========================================== TripInfo Service ==========================================
  
  
    
      This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't directly provide information about a trip. If the response changes the conditions in such a way that the trip becomes invalid (connection no longer possible, delay, cancellation), a new TripRequest is required for the remainder of the trip.
The service also provides information about formation, occupancy, and capacity. The full SIRI elements are used. Therefore, a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6.
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't directly provide information about a trip. If the response changes the conditions in such a way that the trip becomes invalid (connection no longer possible, delay, cancellation), a new TripRequest is required for the remainder of the trip.
The service also provides information about formation, occupancy, and capacity. The full SIRI elements are used. Therefore, a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6.
    
  
  
    
      
        
          
          
          
          
        
      
    
  
  
    ========================================== Trip Service ==========================================
  
  
    
      This service provides intermodal trip information from an origin location to a destination taking various user preferences into account. In the case of OJPMultipointTripRequest it is a set of origins and destinations that are searched. This service implements the model PI QR Trip Request from TM 6.
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      This service provides intermodal trip information from an origin location to a destination taking various user preferences into account. In the case of OJPTripRequest it is single origin and a single destination that are searched. This service implements the model PI QR Trip Request from TM 6.
    
  
  
    
      
        
          
          
          
          
        
      
    
  
  
    ========================================== MultiPointTrip Service ==========================================
  
  
    
      This service provides intermodal trip information from multiple origin location to multiple destination taking various user preferences into account. In the case of OJPMultipointTripRequest it is a set of origins and destinations that are searched. This service implements the model PI QR Trip Request from TM 6.
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      This service provides intermodal trip information from multiple origin location to multiple destination taking various user preferences into account. In the case of OJPMultipointTripRequest it is a set of origins and destinations that are searched. This service implements the model PI QR Trip Request from TM 6.
    
  
  
    
      
        
          
          
          
          
        
      
    
  
  
    ========================================== Status Service ==========================================
  
  
    
      The status service provides basic information about the operational status of an OJP system.
    
  
  
    
      
        
          
        
      
    
  
  
    
      The status service provides basic information about the operational status of an OJP system.
    
  
  
    
      
        
          
          
          
          
        
      
    
  
  
    ========================================== TripRefine Service ==========================================
  
  
    
      The trip refinement service retrieves additional or updated information (e.g., real-time data) about a given, previously retrieved trip. It does not depend on the assumption that the trip has been retrieved from the same server; it may, in fact, even stem from another source than a OJP system. 
An example scenario may involve a trip retrieved from a system A and one wishes to refine the trip with real time information from another system B. As it cannot be ascertained that both systems use identical object IDs, this is signalled by setting ExternalObjectRefs to true. 
System B, being confronted with external IDs, must try to recognise the relevant objects in another way and retrieve them in its own database. In the response it will use its own object IDs. To maintain a consistent mapping, it is imperative that system B reflects the structure of the refine request precisely in its response (principle of structure maintenance).
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      The trip refinement service retrieves additional or updated information (e.g., real-time data) about a given, previously retrieved trip. It does not depend on the assumption that the trip has been retrieved from the same server; it may, in fact, even stem from another source than a OJP system. 
An example scenario may involve a trip retrieved from a system A and one wishes to refine the trip with real time information from another system B. As it cannot be ascertained that both systems use identical object IDs, this is signalled by setting ExternalObjectRefs to true. 
System B, being confronted with external IDs, must try to recognise the relevant objects in another way and retrieve them in its own database. In the response it will use its own object IDs. To maintain a consistent mapping, it is imperative that system B reflects the structure of the refine request precisely in its response (principle of structure maintenance).
    
  
  
    
      
        
          
          
          
          
        
      
    
  
  
    ========================================== Availability Request ==========================================
  
  
    
      The availability service informs about the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY, or SINGLE JOURNEY. This service implements the models PI QR AM Vehicle Type Request and PI QR AM Mobility Service Request from TM 6.
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      The availability service informs about the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY, or SINGLE JOURNEY. This service implements the models PI QR AM Vehicle Type Request and PI QR AM Mobility Service Request from TM 6.
    
  
  
    
      
        
          
          
          
        
      
    
  
  
    ========================================== Line Information Service ==========================================
  
  
    
      The service provides route information about a given LINE. This helps when displaying the LINE on maps. This implements a small part of model PI QR Schedule Request of TM 6.
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      The service provides route information about a given LINE. This helps when displaying the LINE on maps. This implements a small part of PI QR Schedule Request of TM 6.
    
  
  
    
      
        
          
          
          
        
      
    
  
  
    ========================================== Trip Change Service ==========================================
  
  
    
      A trip can be modified in a limited manner by specifying a longer time duration for a specific interchange or by specifying an estimated leg for which the exact time information shall be retrieved. In both cases, earlier or later legs of the trip may be recalculated as well.
    
  
  
    
      
        
          
          
        
      
    
  
  
    
      A trip can be modified in a limited manner by specifying a longer time duration for a specific interchange or by specifying an estimated leg for which the exact time information shall be retrieved. In both cases, earlier or later legs of the trip may be recalculated as well.