Get List of Vehicles Near a Given Place - OMVEHLST

Get List of Vehicles Near a Given Place (OMVEHLST)

Required Parameter Group:

API Overview:
The Get List of Vehicles Near a Given Place API (OMVEHLST) returns a variable length list of vehicles (in closest first order) that are near a given latitude and longitude. The returned list will be dependent on the input parameters received: a) the distance limit; b) the number of finds limit; and c) the direction to look.
The distance and direction from the given latitude and longitude are returned to the calling application along with the last known location place, state and timestamp. Also returned is the distance and direction from the last known location. The return status is set to indicate if any vehicles have been found.

Required Parameter Group Details:
(1) Latitude
INPUT; PACKED(7,0)
This parameter is the latitude portion of the reference point coordinate pair. This parameter must be given in signed seconds (not DDMMSS). This coordinate pair defines the geographic location from which the proximity search will begin.

(2) Longitude
INPUT; PACKED(7,0)
This parameter is the longitude portion of the reference point coordinate pair. This parameter must be given in signed seconds (not DDMMSS).

(3) Distance Limit
INPUT; PACKED(3,0)
This parameter limits the search to only those places that are within the specified radius. This value, which must be between 1 and 500, will be interpreted as either miles or kilometers depending on the system configuration.

(4) Number of Finds Limit
INPUT; PACKED(3,0)
This parameter limits the search to a maximum number of places. Valid limits vary depending on the value specified in the Format Name parameter.
The valid range for LST100 is 1 - 187. The valid range for LST200 is 1 - 53.

(5) Direction to Look
INPUT; CHAR(4)
This parameter limits the search by controlling which geographic direction the system will check for close places. Valid values are:

(6) Format Name
INPUT; CHAR(6)
The format of the information to be returned. Valid values are:

(7) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:

(8) Reason Code
OUTPUT; CHAR(4)
This parameter contains a reason code. Possible values returned include;

• Reason code 0002 will always be returned with return status 1. The proximity search did not fail but more than 1000 vehicles were found within the search limits given. Therefore, there is no guarantee that the closest vehicles have been found because more vehicles are within the circle of consideration than could be returned. For better accuracy, decrease the distance limit or limit the direction to look.
  (9) Number of Vehicles Found
  OUTPUT; PACKED(3,0)
  This parameter returns the total number of vehicles found within the requirements set by the input parameters.
  (10) Return Block
  OUTPUT; CHAR(3000)
  Variable format data structure that returns information to the calling program based on the 'format name' parameter. This parameter contains a list of repeating blocks of data. One block of data is returned for each vehicle that meets the selection criteria. The maximum number of vehicles returned varies depending on the format name parameter. If the maximum is not found, then the block is padded with blanks.
  The supported data formats are shown in the shaded tables below.
  LST100 Data Format (Vehicle distance and direction)

LST200 Data Format (Vehicle proximity - *AUTO style)