xsd.2.0.OJP.OJP_Fare.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_Fare.xsd - Request and response definitions for general, stop-specific and trip-specific fare information
  
  
  
  
    ========================================== Request definitions ==========================================
  
  
    
      Fare request structure.
    
    
      
        
          
            A request for stop-related FARE information.
          
        
        
          
            A request for place-related FARE information.
          
        
        
          
            A request for general/static FARE information.
          
        
        
          
            A request to calculate the FARE information of a single trip.
          
        
        
          
            A request to calculate aggregated FARE information of multiple single trips.
          
        
      
      
        
          Parameter to filter the response contents.
        
      
    
  
  
    
      Sub-request: stop-related fare information.
    
    
      
        
          Reference to the stop point.
        
      
      
        
          Date for which to retrieve Fare information.
        
      
    
  
  
    
      Sub-request: PLACE related fare information. This doesn't make a lot of sense for addresses, topographic place, and coordinates. However, STOP PLACE, SCHEDULED STOP POINT and POINT OF INTEREST are different.
    
    
      
        
          Place to get FAREs from (usually use only StopPoint, StopPlace and PointOfInterest).
        
      
      
        
          Date for which to retrieve Fare information.
        
      
      
        
          Reference to a FareProduct. If no FareProductRef is specified, the responding system should reply with information about all available fare products.
        
      
    
  
  
    
      General Fare information. May depend on date.
    
    
      
        
          Date for which to retrieve Fare information.
        
      
      
        
          Reference to a FareProduct. If no FareProductRef is specified, the responding system should reply with information about all available fare products.
        
      
    
  
  
    
      Structure of a Single Trip Fare Request.
    
    
      
        
          Context to hold trip related objects that occur frequently. Especially necessary, when the system answering the fare request is not the same as the one that did the trip request.
        
      
      
        
          A complete trip from origin to destination
        
      
    
  
  
    
      Structure of a Multi Trip Fare Request.
    
    
      
        
          Context to hold trip related objects that occur frequently.
        
      
      
        
          Multiple complete trips from multiple origins and multiple destination
        
      
    
  
  
    ========================================== Response definitions ==========================================
  
  
    
      
        
          Context to hold trip response objects that occur frequently.
        
      
      
        
          Fare result choice element.
        
      
    
  
  
    
      Type for identifier of a NeTEx Object.
    
    
  
  
    
      Wrapper element for Fare results.
    
    
      
        
          ID of this result.
        
      
      
        
          Problems related to this FARE result.
        
      
      
        
          Whether the fare is only estimated by the service. Estimated can mean different things: For example, the fare may vary depending on age, PassengerCategory, FareClass, EntitlementProducts. It can also mean that the fare structure used by the service is not entirely accurate or that other factors, such as the time a shared vehicle is used, need to be factored into the price. As a rule, the price should then be given as an approximate and probably lower limit of the actual price. Default is TRUE.
        
      
      
        
          
            Stop-related Fare information.
          
        
        
          
            Place-related Fare information.
          
        
        
          
            Static Fare information.
          
        
        
          
            Fare and FareProducts for a given trip.
          
        
        
          
            Fare and FareProducts for multiple trips.
          
        
      
    
  
  
    
      Stop-related Fare information.
    
    
      
        
          One or more lists of Fare zones that belong to a Fare authority/area.
        
      
      
    
  
  
    
      PLACE-related Fare information.
    
    
      
        
          The involved PLACE. Usually,a StopPoint, StopPlace or PointOfInterest.
        
      
      
        
          [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information.
        
      
      
        
          URL to information page on the web.
        
      
      
    
  
  
    
      General Fare information.
    
    
      
        
          [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information.
        
      
      
        
          URL to information page on the web.
        
      
      
    
  
  
    
      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)
    
    
      
      
        
          Identifies the "valid from" trip.
        
      
      
        
          Identifies the "valid from" LEG. If missing, then valid from the first LEG.
        
      
      
        
          Identifies the "valid to" trip.
        
      
      
        
          Identifies the "valid to" LEG. If missing, then valid to the last LEG.
        
      
    
  
  
    
      Structure of a Multi Trip Fare Request result
    
    
      
        
          Non-empty list of trip references in the corresponding MultiTripFareRequestStructure
        
      
      
        
          Zero, one or more FareProducts that are valid for the referenced trips / part of trips.
        
      
      
        
          The set of passed zones.
        
      
      
        
          URL to Fare information pages on the web.