xsd.2.0.OJP.OJP_Availability.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_Availability.xsd - Request and response definitions for availability of tickets and services on a journey leg.
  
  
  
  
    ========================================== AvailabilityRequest ==========================================
  
  
    
      Availability request. Used to check the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY or SINGLE JOURNEY. Be aware that usually after the response arrives, the rest of the TRIP must be recalculated. As especially pick-up and drop-off locations may have shifted from where they were in the previously calculated TRIP.
    
    
      
        
          A choice as we assume that here future extensions may occur (non-public transport).
        
        
          
            Definition of the journey leg to be covered by public transport. Other mobility services can be added later.
          
        
      
      
        
          Passenger(s) for whom the service needs to be booked, one MobilityUser per passenger.
        
      
      
        
          This element is only used to transmit restrictions from the earlier/or later trip part. The possible trip is the result of a previous OJPTripRequest. The desired time for the public transport is set within PublicTransport element.
        
      
      
    
  
  
    ========================================== Additional Declarations ==========================================
  
  
    
      Journey leg by public transport.
    
    
      
        
          Location where passenger intends to enter the service.
        
      
      
        
          Location where passenger intends to leave the service.
        
      
      
        
          Properties of a service (line and direction) by which the availability is being checked: attributes of ContinuousServiceStructure or DatedJourneyStructure.
        
      
      
    
  
  
    
      Passenger(s) for whom the service needs to be booked.
    
    
      
        
          Age of the passenger on the day of travel.
        
      
      
      
    
  
  
    
      Provisioned vehicle call at a general location.
    
    
      
      
        
          More general location for a call than stop points. May be used with flexible services or "Area Dial-A-Ride".
        
      
      
        
          Arrival times of the service at this stop.
        
      
      
        
          Departure times of the service at this stop.
        
      
      
    
    
  
  
    
      Earliest possible departure time from a start location and latest possible arrival at a different destination location.
    
    
      
        
          Earliest possible departure time from start location.
        
      
      
        
          Latest possible arrival time at destination location.
        
      
    
  
  
    ========================================== From Trias_JourneySupport.xsd ==========================================
  
  
    
      Profile of the passenger's abilities.
    
    
      
        
          Passenger uses a wheelchair. Default is FALSE.
        
      
      
        
          Passenger uses a walking frame. Default is FALSE.
        
      
      
        
          Passenger uses a walking stick. Default is FALSE.
        
      
      
        
          Passenger is (maybe temporarily) walking impaired. Default is FALSE.
        
      
      
        
          Passenger has a pram with him/her. Default is FALSE.
        
      
      
        
          Passenger has got heavy luggage. Default is FALSE.
        
      
      
        
          Passenger is visually impaired.
        
      
      
        
          Passenger is hearing impaired.
        
      
      
        
          Passenger is reading impaired.
        
      
    
  
  
    
      Description of passenger's accessibility requirements
    
    
      
      
    
  
  
    
      Requirements for the driver/staff to assist the passenger when boarding/alighting.
    
    
      
        
          Whether assistance is required for boarding. Could be offered by the driver or station staff. Default is FALSE.
        
      
      
        
          Whether assistance is required for alighting. Could be offered by the driver or station staff. Default is FALSE.
        
      
    
  
  
    ========================================== AvailabilityResponse ==========================================
  
  
    
      Availability response.
    
    
      
        
          Context to hold availability response objects that occur frequently.
        
      
      
        
          Indication of the availability of the requested service.
        
      
      
    
  
  
    ========================================== Additional declarations ==========================================
  
  
    
      Availability result structure.
    
    
      
        
          Problems related to this AVAILABILITY result.
        
      
      
        
          
            Definition of the journey leg that should be made by public transport. Other mobility services may be added later.
          
        
      
      
      
    
  
  
    ==================== ticket and service information =====================
  
  
    
      Lists those tickets or surcharges and service characteristics such as the transportation of wheelchairs, prams, luggage etc. or the provision of required child seats or booster seats that are offered in the trips transport company to be booked for the trip.
    
    
      
        
          Sequence of bookable tickets or surcharges for this part of the trip. If ticket price is zero: an already purchased/virtual ticket of this type presented to the driver would be accepted.
        
      
      
        
          Sequence of bookable service items for this part of the trip.
        
      
    
  
  
    
      Possible service items that can be booked in the actual booking system (defined by the traffic company of charge). Only those elements with value greater 0 are bookable. The indicated capacity corresponds to the maximum number that can be booked in one booking. This number does not have to be available for the specific booking and may result in booking failure. Caution: list can vary widely from one traffic company to another.
    
    
      
        
          The type of bookable service.
        
      
      
        
          Maximum number of service items that can be booked in one booking transaction. Default is 0.
        
      
    
  
  
    
      Types of bookable service items.
    
    
      
        
          Space for a wheelchair.
        
      
      
        
          Space for a motorised wheelchair.
        
      
      
        
          Space for storing a foldable wheelchair.
        
      
      
        
          Place suitable for a person with a walking frame.
        
      
      
        
          Space for a pram or pushchair.
        
      
      
        
          Space for storing heavy luggage.
        
      
      
        
          Seat suitable for attaching a child seat taken along by the passengers.
        
      
      
        
          Child seat provided in the vehicle.
        
      
      
        
          Seat suitable for attaching a baby carrier taken along by the passengers.
        
      
      
        
          Baby carrier provided in the vehicle.
        
      
      
        
          Seat booster provided in the vehicle.
        
      
      
        
          Space for a bicycle.
        
      
      
        
          Place suitable when accompanied by a guide dog.
        
      
      
        
          Place suitable when accompanied by a dog.
        
      
      
        
          Assistance for boarding.
        
      
      
        
          Assistance for alighting.
        
      
      
        
          Assistance available on board, during the journey.
        
      
      
        
          Assistance for a minor travelling alone.
        
      
    
  
  
    ========================================== Problems ==========================================
  
  
    
      Types of problems that may be returned in responses to AVAILABILITY requests.
    
    
      
        
          No SERVICE (VEHICLE JOURNEY or VEHICLE) could be found for this request.
        
      
      
        
          At the locations (address, stop, etc.) for which the availability has been requested, there is no public transport service at all. E.g. outside the area.
        
      
      
        
          The location (address, stop, etc.) for which availability was requested is unknown.
        
      
      
        
          The vehicle is not available due to existing rules like operating hours or not competing against an existing public transport line. In the details of the problem there should be information indicating which rules were violated: e.g., The desired MOBILITY SERVICE can't be provided because there exists a regular line for this TRIP.
        
      
      
        
          The MOBILITY SERVICE is disrupted. 
        
      
      
        
          There is no VEHICLE available at the current time.
        
      
      
        
          A problem has occurred that does not have a specific problem type.