xsd.2.0.OJP.OJP_Common.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_Common.xsd - Supporting definitions of common structures
  
  
  
  
    
      Type for identifier of a NeTEx Object.
    
    
  
  
    ========================================== General ==========================================
  
  
    
      Error: All OJP related errors.
    
  
  
    
      Type for Error: OJP Error.
    
    
      
        
          
          
            
              ProblemDetailGroup
            
          
        
      
    
  
  
  
    
      Detailed description of the problem.
    
    
      
        
          Explanation of the problem.
        
      
      
        
          Additional log data.
        
      
    
  
  
    
      Code within scope of a private referential system
    
    
      
        
          Code of the foreign referential system.
        
      
      
        
          Object code within this private/foreign system.
        
      
    
  
  
    
      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.
    
    
      
        
          Ordered list of locations representing the geometry of the link or route.
        
      
    
  
  
    
      A percentage value between 0 and 100
    
    
      
      
    
  
  
    
      Area described as a polygon.
    
    
      
        
          Ordered list of geographic locations describing the polygon of the area.
        
      
    
  
  
    ========================================== Participants ==========================================
  
  
    
      Reference to a Participant ([equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s))
    
  
  
    ========================================== Operators ==========================================
  
  
    
      Reference to an Operator ([TMv6] company  providing public transport services.) 
    
  
  
    
      
    
  
  
    
      Filter for in/exclusion of transport operators.
    
    
      
        
          Whether operators in list are to include or exclude from search. Default is exclude.
        
      
      
        
          Reference to transport operator
        
      
    
  
  
    ========================================== ProductCategories ==========================================
  
  
    
      Reference to a product category. Product categories should be defined once and used uniformly in all channels (e.g., NeTEx, SIRI, OJP).
    
  
  
    ========================================= Lines ======================================
  
  
    
      Filter for in/exclusion of lines (and directions).
    
    
      
        
          Reference to a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables.
        
      
      
        
          Whether lines in list are to include or exclude from search. Default is exclude.
        
      
    
  
  
    ========================================== Journeys ==========================================
  
  
    
      Identifier of a Journey
    
    
  
  
    
      Reference to a Journey
    
    
      
    
  
  
    
      Reference to a Journey
    
  
  
    
      Reference to a DATED VEHICLE JOURNEY (Reference to a journey on a specific operating day).
    
    
      
      
    
  
  
    
      Reference to a TRAIN NUMBER of an OPERATOR at a given OPERATING DAY.
    
    
      
      
      
    
  
  
    ========================================== Vehicles ==========================================
  
  
    
      Reference to a vehicle for a specific point in time.
    
    
      
        
          Reference to vehicle.
        
      
      
        
          Time stamp when the vehicle is operating. In most use cases equal to "now".
        
      
    
  
  
    
      Filter for Vehicles
    
    
      
        
          Whether to include or exclude given VehicleRefs and TRAIN NUMBERS in the list from the search. Default is exclude.
        
      
      
        
          Reference to VEHICLE
        
      
      
        
          TRAIN NUMBERs
        
      
    
  
  
    ========================================== Sharing Services ==========================================
  
  
    
      Usage parameters of a sharing service.
    
    
      
        
          Typical time a user will need  to check in and unlock the vehicle.
        
      
      
        
          Typical time a user will need  to lock the vehicle and check out.
        
      
    
  
  
    
      Service that provides shared vehicles (The Transmodel MODE OF OPERATION is VEHICLE SHARING; other related Transmodel concepts: ALTERNATIVE MODE LEG.SINGLE JOURNEY.COMMON.VEHICLE SERVICE.TRANSPORT ORGANISATION).
    
    
      
      
        
          Identifier of the operator of the sharing service 
        
      
      
        
          Public name of the service.
        
      
      
      
        
          Link to the web page providing more details on the service.
        
      
      
        
          This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles).
        
      
      
        
          Information about the restriction.
        
      
    
  
  
    ========================================== Owners ==========================================
  
  
    
      identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE
    
    
  
  
    
      Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE
    
    
      
    
  
  
    
      Reference to an  ORGANISATION with ownership as the RESPONSIBILITY ROLE
    
  
  
    ========================================== Operating Days ==========================================
  
  
    
      Identifier of an Operating Day
    
    
  
  
    
      Reference to an Operating Day
    
    
      
    
  
  
    
      Reference to an Operating Day
    
  
  
    
       [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. This is useful, when the trip can be made during several days. Often users search in "general" without setting a date and then refine with the actual date. By using OperatingDaysStructure the result can directly be reused without an additional OJPTripRequest.
    
    
      
        
          Start date of period.
        
      
      
        
          End date of period.
        
      
      
        
          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 happens on the day that is represented by the bit position.
        
      
    
  
  
    
      Coded as bit pattern
    
    
      
        
          Bit string definition of operating days.
        
      
      
        
          Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays".
        
      
    
  
  
    
      [a specialisation of TIME BAND in TMv6] aggregation of TIME BAND and DAY OF WEEK (Time period on a weekday).
    
    
      
        
          [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays
        
      
      
        
          Start time of period.
        
      
      
        
          Time duration of period.
        
      
    
  
  
    
      [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays 
    
    
      
      
      
      
      
      
      
      
    
  
  
    ========================================== General Attributes ==========================================
  
  
    
      Structured attribute classification with associated text. If URL is given, it refers to the whole attribute text.
    
    
      
        
          Text of the attribute to be shown to the user.
        
      
      
        
          Internal code of the attribute. Can be used for detection of double occurrences.
        
      
      
        
          Key if the attribute is used as a key/value pair.
        
      
      
        
          Value if the attribute is used as a key/value pair.
        
      
      
        
          Facilities associated with this attribute.
        
      
      
        
          Defines whether the attribute has to be shown to the user.
        
      
      
        
          Importance of the attribute.
        
      
      
    
  
  
    ========================================== Sustainability ==========================================
  
  
    
      Elements about sustainability. Primarily for TRIPs and LEGs.
    
    
      
        
          Estimation of CO2 emissions.
        
      
    
  
  
    
      Estimation of CO2 emissions.
    
    
      
        
          Kilograms of CO2 emission by person and by kilometre.
        
        
          
            
          
        
      
      
        
          Confidence level of the emission value in percent.