xsd.2.0.OJP.OJP_TripInfo.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
Generates Java model from OJP xsds using jaxb.
The newest version!


  
    OJP/OJP_TripInfo.xsd - Request and response definitions for information on a single trip
  
  
  
    ========================================== Request definitions ==========================================
  
  
    
      TripInfo request structure.
    
    
      
        
        
        
      
      
        
          Request parameter.
        
      
    
  
  
    
      TripInfo request parameter structure.
    
    
      
      
      
    
  
  
    
      Parameters that control the response behaviour.
    
    
      
        
          Use real-time data. Default is "full"
        
      
    
  
  
    
      Possible values how to include formations in the basic filters
    
    
      
      
        
          The response should include VehicleFeatureRef (from SIRI).
        
      
      
        
          Besides VehicleFeatureRefs also Formation, ArrivalFormation and DepartureFormation can be used. This is the full SIRI formation experience. Refer to the SIRI documentation for details. The specification document and the examples may show simpler ways of doing things. For full accessibility many features are needed. It is recommended to always also use VehicleFeatureRef (for people not processing SIRI formation and because buses and the like don't need Formation in most cases).
        
      
    
  
  
    
      Parameters that control the level of detail to be returned in the results.
    
    
      
        
          Whether call information is to be included. Default is true.
        
      
      
        
          Whether current position is to be included. Default is true.
        
      
      
        
          Whether service information is to be included. Default is true.
        
      
      
        
          Whether the result should include TrackSection elements to describe the geographic route of this vehicle journey.
        
      
      
        
          Whether the result should include the geographic projection (coordinates) of this vehicle journey.
        
      
      
        
          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 formation should be included. With "simple" only VehicleFeature is used. "full" may unleash the full power of the SIRI formation model (especially for trains). The OJP specification document gives hints on how to limit oneself as a server to the most important aspects. Default is none.
        
      
      
        
          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
        
      
    
  
  
    ========================================== Response definitions ==========================================
  
  
    
      TripInfo response structure.
    
    
      
        
          Response context.
        
      
      
        
          Result structure.
        
      
    
  
  
    
      TripInfo result structure containing the status of a trip.
    
    
      
        
          Problems related to this TripInfo result.
        
      
      
        
          The stops this service already has called at. Including the current stop if service is currently at stop.
        
      
      
        
          Current position of this service.
        
      
      
        
          The stops this service still has to call at.
        
      
      
        
          Description of the service.
        
      
      
      
      
        
          Geographic embedding of this journey. The entire journey is regarded as one leg.
        
      
      
    
  
  
    ========================================== Problems ==========================================
  
  
    
      Types of problems that may be returned in responses to TripInfo requests.
    
    
      
        
          The journey reference used in the request is unknown.
        
      
      
        
          The vehicle reference used in the request is unknown.
        
      
      
        
          No matching journey could be found for the requested time and journey/vehicle identifiers.
        
      
      
        
          No geographic information available for this vehicle journey.
        
      
      
        
          No real-time information available.
        
      
      
        
          A problem has occurred that does not have a specific problem type.