View Source

Recent eBird Sightings Summary By Loc Web Service API

URL	description	status	notes
http://ebird.org/data/ebird/byloc/recent?locIDs=L97555,L259855	Return summary of recent sightings at the given locID(s)	deployed

parameter	required	default	value options	example value	description	status
locIDs	yes	n/a	comma-separated list of up to three locIDs	L97555,L259855	The data summary is computed using data submitted to the given locIDs (up to three).	deployed
locale	no	en_US	Java standard locale codes	en_US	Language/locale of common names provided in the response (when translations are available)	implemented, not deployed (as of June 27, 2008)

XML Result Format

<response>
  <header>
    <locale country="US" language="en"/>
    <timestamp>2008-02-21T12:37:32.546-05:00</timestamp>
    <criteria>
      <property name="match" value="something"/>
    </criteria>
    <comment>
    </comment>
  </header>
  <result>
    <location countryCode="" >name of the country </location>
    <location countryCode="" >name of the country </location>
    <location countryCode="" >name of the country </location>
</response>

Sample output for CLO.

The URL is http://ebird.org/data/ebird/byloc/recent?locIDs=L97555

You can ask for up to three locs using the following format:

http://ebird.org/data/ebird/notable/recent?locIDs=L100,L97555,L101

If you ask for more than three locs the "extras" are silently ignored. The locIDs are made cannonical before the query is run. That is, they are ordered alphabetically, then truncated to at most 3 IDs. If the locIDs given to the system are not already in cannonical form, they are made cannonical and the request is rebsubmitted through a redirect. This is so that we will be able to use the same cache entry for locIDs=L101,L102,L203 no matter what order they are originally submitted.

Note that the query string ?locIDs=L100&locIDs=L101 will NOT work.

Caching is turned on to hold results for 30 minutes.

The time period over which the report is tallied is from midnight of the previous day to "now".

Enhancements for eBird gadget/data

add observer name to data and display

Enhancements for eTT gadget/data

Link to AAB species instead of eBird reports
link to map showing location of sighting (using kiosk map)
Identfiy rarities and specialties
Multiple time frames (week, month); for these, show date last observed
Support multiple points (via polygon)

Enhancements targeted for sprint

Add support for "daysBack" parameter where 0 <= days <= 7 to allow adjustable size of time frame.
- Must regurgitate parameter in response header.
- Validation check parameter values.
- Default value is 1, which indicates a time period of midnight of the previous day to "now".
- E.g., "3" would indicate midnight 3 days ago to "now". Thus the report always covers 3 x 24 hours + however far through the day we are right now.
Explore potential to use Oracle Spatial queries to query over a polygon and include multiple locations.