xsd.2.0.OJP.OJP_Locations.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_Locations.xsd - Request and response definitions for location information
  
  
  
  
    FUNCTION 1: Place Identification
    FUNCTION 2: Object Information
    FUNCTION 3: Geographical Context
    FUNCTION 4: Coordinate to Address
    All functions integrated into one request / response
  
  
    
      
        
          
            Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs.
          
        
        
          
            LOCATION / PLACE for further refinement. If a Place in a previous response was marked as not "complete" it can be refined by putting it here. If Places are organised hierarchically, it may be reasonable to identify the Place in a top-down approach with several steps of refining a Place on each level of hierarchy. Following this approach an initial request retrieves a first list of top-level Places (e.g., streets) which are to be refined in a subsequent request to the next level (e.g., house number intervals). The objects of the current level are presented to the user for selection. The object reference of the selected object is then sent in the next request for further refinement.
          
        
      
      
        
          E.g. place types (stops, addresses, POIs) or specific place attributes
        
      
    
  
  
    
      
        
          Context to hold response objects that occur frequently.
        
      
      
        
          If the response returns fewer results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response.
        
      
      
        
          The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best.
        
      
    
  
  
    ========================================== Additional declarations ==========================================
  
  
    
      
        
          Name of the LOCATION object which is looked for. This is usually the user's input. If not given, the name of the resulting location objects is not relevant.
        
      
      
        
          Coordinate where to look for locations/places. If given, the result should prefer locations/place objects near to this GeoPosition.
        
      
      
        
          Restricts the resulting location/place objects to the given geographical area.
        
      
      
        
          Used in distributed environments. e.g., EU-Spirit. If none is given, the location/place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the location/place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/
        
      
    
  
  
    
      
      
      
      
    
  
  
    
      
        
          Area defined by a circle.
        
      
      
        
          Area defined by a rectangle.
        
      
      
        
          Area defined by a polyline.
        
      
    
  
  
    
      
        
          Centre position of the circle.
        
      
      
        
          Radius in metres.
        
      
    
  
  
    
      
        
          Upper-left (north-west) corner of the rectangle.
        
      
      
        
          Lower-right (south-east) corner of the rectangle.
        
      
    
  
  
    
       [specialisation of ZONE in TMv6] a LINK SEQUENCE (one-dimensional) forming the boundary of a ZONE
	
    
    
      
        
          Vertices of a polyline defining an area.
        
      
    
  
  
    
      
        
          Problems related to this LOCATION result.
        
      
      
        
          The Place / Location object.
        
      
      
        
          States whether the included location/place is complete or needs further refinement. Only complete locations/places are fully resolved and can be used in e.g., trip requests. Incomplete locations/places must be refined entering them once again into a LocationInformationRequest.
        
      
      
        
          Probability, that this result is the one meant by the user's input. Value should be between 0 and 1.
        
        
          
            
            
          
        
      
      
        
          Stores the system reference, where to ask for actual locations corresponding to this city name result. To get actual locations, a new location information request using the system ID of this result is needed.
        
      
      
        
          List of operators operating at this place object. This list should only be filled if this is explicitly requested.
        
      
    
  
  
    
      
        
          Preferred language in which to return text values.
        
      
      
        
          Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g.: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The place information service is expected to support a response volume of at least 500 objects within one single response.
        
      
      
        
          Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response.
        
      
      
        
          Tells the service to include the available public transport modes at returned stops.
        
      
      
        
          Tells the service to include the available operators at returned stops.
        
      
    
  
  
    
      
        
          Allowed location/place object types. If none is given, all types are allowed.
        
      
      
        
          Defines, whether location/place objects for origin, via, or destination are searched.
        
      
      
        
          Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops.
        
      
      
        
          Filter for locations/places that are operated by certain organisations.
        
      
      
        
          If at least one is set, only location/place objects within the given localities are allowed.
        
      
      
        
          Filter to narrow down POI searches.
        
      
    
  
  
    
      
        
          If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore, use with care.
        
      
      
        
          WGS84 coordinates position. Locations closer to this GeoPosition are preferred.
        
      
      
        
          Ignore locations with a lower probability.
        
      
    
  
  
    
      
        
          stop covers StopPlace and StopPoint. The main reason is that many systems may only return either STOP PLACE/QUAY information or SCHEDULED STOP POINTs.
        
      
      
      
      
        
          Deprecated. Use location instead.
        
      
      
        
          Geographic position consisting of coordinates. Replaces the deprecated value coord.
        
      
      
    
  
  
    
      
      
      
    
  
  
    ========================================== Exchange point request ==========================================
  
  
    
      
        
          Location/Place for which exchange points to other "neighbour" systems are to be searched. This location/place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.
        
      
      
        
          E.g. location/place types (stops, addresses, POIs) or specific location/place attributes
        
      
    
  
  
    
      
      
      
    
  
  
    
      
        
          Allowed location/place object types. If none is given, all types are allowed.
        
      
      
        
          Defines, whether the location/place object of this request acts as origin, via or destination point of the passenger journey.
        
      
      
        
          Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops.
        
      
      
        
          Filter for locations/places that are operated by certain organisations.
        
      
      
        
          If at least one is set, only location/place objects within the given localities are allowed.
        
      
      
        
          Reference to system in which the destination (or origin) of the passenger is located.
        
      
      
        
          One or more adjacent systems to which the exchange points should be retrieved.
        
      
    
  
  
    
      
        
          Preferred language in which to return text values.
        
      
      
        
          Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g., in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response.
        
      
      
        
          Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response.
        
      
    
  
  
    
      
        
          Context to hold trip response objects that occur frequently.
        
      
      
        
          If the response returns fewer results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response.
        
      
      
        
          The exchange points found by the service.
        
      
    
  
  
    
      
        
          Problems related to this EXCHANGE POINTS result.
        
      
      
        
          Place object that describes this exchange point.
        
      
      
        
          Rough estimate of the travel duration from the specified reference location/place to this exchange point.
        
      
      
        
          Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it must take care, that feeding arrival and fetching departure are at least this duration apart.
        
      
      
        
          Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE.
        
      
      
        
          List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested.
        
      
      
        
          The priority of the exchange point. 100 is the maximum. The priority can be used to select given ExchangePoints more often (e.g., because the station is a main hub).