class TflApi::Client::BikePoint
This class communicates with the TFL “/BikePoint” API to obtain details about bike points locations based upon their IDs or by their latitude and longitude values.
Public Class Methods
Public Instance Methods
Returns all BikePoint
locations known by the TFL service
@return [Array] An array of hashes containing all BikePoints and their details
# File lib/tfl_api_client/bike_point.rb, line 48 def locations @client.get('/BikePoint') end
Returns all BikePoint
locations known by the TFL service within a the given box based upon it's defined corner locations.
@param sw_latitude [String] the south-west latitude positional value of the bounding box @param sw_longitude [String] the south-west longitude positional value of the bounding box @param ne_latitude [String] the north-east latitude positional value of the bounding box @param ne_longitude [String] the north-east longitude positional value of the bounding box
@return [Array] An array of hashes containing all BikePoints and their details
# File lib/tfl_api_client/bike_point.rb, line 87 def locations_within_bounding_box(sw_latitude, sw_longitude, ne_latitude, ne_longitude) uri_params = { swLat: sw_latitude, swLon: sw_longitude, neLat: ne_latitude, neLon: ne_longitude } @client.get('/BikePoint', uri_params) end
Returns all BikePoint
locations known by the TFL service within a particular position or place (a locus).
@param latitude [String] the latitude value @param longitude [String] the longitude value @param radius [String] the radius of the area to cover
@return [Array] An array of hashes containing all BikePoints and their details
# File lib/tfl_api_client/bike_point.rb, line 72 def locations_within_locus(latitude, longitude, radius) uri_params = { lat: latitude, lon: longitude, radius: radius } @client.get('/BikePoint', uri_params) end
Returns all BikePoint
locations known by the TFL service within based upon the given search query.
@param query [String] the query term to search for
@return [Array] An array of hashes containing all BikePoints and their details
# File lib/tfl_api_client/bike_point.rb, line 99 def search(query) @client.get('/BikePoint/Search', { query: query }) end