Module: SeeClickFix::Client::WatchAreas

Included in:
SeeClickFix::Client
Defined in:
lib/seeclickfix/client/watch_areas.rb

Instance Method Summary collapse

Instance Method Details

#watch_areas(options = {}) ⇒ Array<Hashie::Mash>

Use this query to list public watch areas at a given location.

Examples:

SeeClickFix.watch_areas({:at => "San Francisco"})

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • at (String) —

    Geocodable street address. e.g. zipcode, city, state or 123 state st. new haven, ct.

  • zoom (String) —

    Integer level from 0 to 19 based on google maps.

  • lat (String) —

    Lattitude

  • lon (String) —

    Longitude

  • lon (String) —

    Longitude

  • radius (String) —

    Radius to search for watch areas by. Radius is in units of degrees. Default is 1.

  • watcher_search (String) —

    Search terms to limit the results by.

  • page (String) —

    Page to display the results as. Results are sorted by distance from the required parameter area's center. Default is 1.

  • num_results (Integer) —

    Number of results to return. Default is 20

Returns:

  • (Array<Hashie::Mash>)

See Also:



21
22
23
 
# File 'lib/seeclickfix/client/watch_areas.rb', line 21

def watch_areas(options={})
  get("api/watchers/list.json", options)
end