Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Google Gadgets to View Recent eBird and eBird Trail Tracker Sightings - Version 1.0

Panel
Table of Contents

Summary

Note

This gadget is deprecated. Please use version 1.1 of the gadget instead.

These two Google gadgets provide a means to show eBird or eBird Trail Tracker(eTT) observations over the past few days on a web site or on your Google home page. These gadgets utilize the eBird apiProvides a summary of data provided by the eBird Recent Sightings By Loc API (v1.0).That API delivers summary data about eBird and eTT observations for made at an eBird hotspot, over the past few days. Two different Google gadgets are also provided which consume this data.

...

. Since all eTT deployments are linked to a particular eBird hot spot, these gadgets can deliver summary information to the web site of an eTT owner/subscriber.

There are two separate gadgets, which display the same data, but are branded somewhat differently. One gadget has eTT branding while the other has pure eBird branding.

...

eTT-branded Gadget

The sample gadget utilizing this API: http://ebird.org/wstools1.0/google/byloc/ett-byloc.xml.

Example

Here is a live an example Example of this gadget on a page: http://ebird.org/wstools1.0/google/byloc/sample/sample-estero-llano.html

...

. This example utilizes the look and feel of the Estero Llano Grande State Park web site to show what the gadget might look like on the web site of an eTT owner/subscriber.

Installing This Gadget On Your Web Site

  1. You will need the eBird location ID (LOC_ID) of the eTT site. You can get this in one of two ways:
    1. Ask your eTT customer service representative.
    2. Find it in this list: http://ebird.org/ws1.0/data/hotspot/list?countryCode=USthe list of eBird hot spots by state/province.
  2. Customize the look of the gadget.
    1. Open the Google Gadget customization page
    To add this gadget to a web page that you manage
    1. : http://www.gmodules.com/ig/creator?synd=open&url=http://ebird.org/wstools1.0/google/byloc/ett-byloc.xml
    .
    1. Replace the default "Hot spot location ID" with the one you got from step one above.
    2. Configure how you want the gadget to look.
    Then copy
    1. Copy the JavaScript code provided on that page
    , and include it onto
    1. .
  3. Paste the JavaScript produced by step 2 above into a page on your own web pagesite.

...

Details

The sample gadget utilizing this APIURL of this gadget: http://ebird.org/wstools1.0/google/byloc/ebirdett-byloc.xml.

Suggestions for Improvement

  • For both gadgets:
    • Ability to sort by Most Recently Observed (followed by taxonomic order)
    • Ability to sort by High Count (followed by taxonomic order)
  • For eBird gadget:
    • Show first and last name of reporting observer
  • For eTT gadget:
    • link to AAB species on species names
    • link to map showing location of sighting (using eTT map)
    • identify rarities and specialties

API

...

URL

...

description

...

status

...

notes

...

http://ebird.org/ws1.0/product/byloc/recent

...

Return summary of recent sightings for most active hotspot over the past 24 hours

...

deployed

...

 

...

eBird-branded Gadget

Example

There is not yet an example installation of the eBird-branded gadget.

Installing This Gadget On Your Web Site

  1. You will need the eBird location ID (LOC_ID) of hot spot for which you want to see data. Find it in the list of eBird hot spots by state/province.
  2. Customize the look of the gadget.
    1. Open the Google Gadget customization page: http://www.gmodules.com/ig/creator?synd=open&url=http://ebird.org/

...

    1. wstools1.0/

...

    1. google/byloc/

...

    1. ebird-byloc.xml
    2. Replace the default "Hot spot location ID" with the one you got from step one above.
    3. Configure how you want the gadget to look.
    4. Copy the JavaScript code provided on that page.
  1. Paste the JavaScript produced by step 2 above into a page on your own web site.

Details

The URL of this gadget: http://ebird.org/wstools1.0/google/byloc/ebird-byloc.xml.

Wiki Markup
{import:eBird-footer}

...

Return summary of recent sightings at the given locID(s)

...

deployed

...

 

Parameter Descriptions

parameter

required

default

value options

example value

description

status

locID

no

n/a

locID of hotspot locations

L97555

The data summary is computed using data submitted to the given locIDs (up to three). The eBird-1.0-HotSpot web service lists valid hot spot locIDs.

deployed

locale

no

en_US

Java standard locale codes

en_US

Language/locale of common names provided in the response (when translations are available)

deployed

daysBack

no

0

0, 1, 2, 3, 4, 5, 6, 7

7

How many days backwards to look in computing the summary. Zero means use observations submitted for today. One means use observations for today and yesterday.  Etc.

deployed

Result Caching

Results are cached on the server for 30 minutes, so repeated calls to the same URL will usually result in exacted the same response. The time that the response was actually computed is provided in the header time stamp.

XML Result Format

No Format

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <header>
        <locale country="US" language="en"/>
        <timestamp>2008-06-27T15:57:58.877-04:00</timestamp>
        <criteria>
            <property id="locID" value="L97555" description="Sapsucker Woods"/>
            <property id="daysBack" value="7"/>
        </criteria>
    </header>
    <result>
        <sighting>
            <species-id>cangoo</species-id>
            <scientific-name>Branta canadensis</scientific-name>
            <common-name>Canada Goose</common-name>
            <how-many>20</how-many>
            <num-checklists>2</num-checklists>
            <obs-dt>2008-06-27</obs-dt>
        </sighting>
        <sighting>
            <species-id>norbob</species-id>
            <scientific-name>Colinus virginianus</scientific-name>
            <common-name>Northern Bobwhite</common-name>
            <how-many>1</how-many>
            <num-checklists>1</num-checklists>
            <obs-dt>2008-06-25</obs-dt>
        </sighting>
    </result>
</response>

Potential Improvements

...