Versions Compared

Old Version 1

changes.mady.by.user Paul Allen

Saved on

compared with

New Version 2

changes.mady.by.user Paul Allen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
Table of Contents

...

eBird Hot Spot List

...

Web Service API

API

This functionality is contained in the IS/DataDeliveryREST DataDelivery code base.

URL

description

status

notes

ws/refdata/subnational2hotspot/list?countryCode=<2-letter ISO country code>

Return list of "county" names hotspots found in the given country

coded , not and deployed

 

ws/ref/subnational2/find?match=<string to match>

Return list of "county" names that match

coded, not deployed

Can wildcards be used in the match string? No wildcard yet implemented.

ws/ref/subnational2/data/hotspot/list?subnational1Code=<subnational1 code>

Return list of "county" hotspots names found in the given "state"

coded , not and deployed

 

match

parameter

required

default

value options

description

status

yes, for /find

n/a

 

String to match against "county" names. What kind of wildcards can be used?

coded, not deployed. No wildcard yet implemented.

locale

no

en_US

Java standard locale codes

locale in which to perform matching, and in which to provide names in response (when possible)

not coded

countryCode

one of countryCode and subnational1Code is required for /list

n/a


see CountryCode List and Search Web Service API

coded , not and deployed

subnational1Code

one of countryCode and subnational1Code is required for /list

n/a


see Subnational1Code List and Search Web Service API

coded , not and deployed

format

no

csv

  • csv
  • xml

format to use for response; this parameter is case sensitive

coded , not deployed and deployed 

Test URLS

Development URL

Deployed URL

Expected Response

Notes

http://localhost/wsws1.0/ref/subnational2

 

empty list in CSV format

 

http://localhost/ws/ref/subnational2data/hotspot/list?countryCode=

 

empty list in CSV format

 

http://localhost/wsws1.0/refdata/subnational2hotspot/list?countryCode=US

 

entire list in CSV format

Country code in uppercase is valid.

http://localhost/wsws1.0/refdata/subnational2hotspot/list?countryCode=us

 

empty list in CSV format

Country code in lowercase is invalid.

http://localhost/wsws1.0/refdata/subnational2hotspot/list?countryCode=US&format=xml

 

entire list in XML format

 

http://localhost/wsws1.0/refdata/subnational2hotspot/list?countryCode=US&format=csv

 

entire list in CSV format

 

http://localhost/wsws1.0/refdata/subnational2hotspot/list?countryCode=US&format=XML

 

entire list in CSV format

"XML" is not a valid format option. Only "xml" and "csv" are valid options. An invalid option will default to "csv" format.

http://localhost/wsws1.0/refdata/subnational2hotspot/list?countryCode=US&format=qqq

 

entire list in CSV format

Bad format value is ignored and defaulted defaults to "csv".

http://localhost/ws/ref/subnational2/list?countryCode=US&format=QQQ

 

entire list in CSV format

Bad format value is ignored and defaulted to csv.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9a4b9a94-d759-49cb-9a52-7204e6f435c0"><ac:plain-text-body><![CDATA[

[][http://localhost/wsws1.0/refdata/subnational2hotspot/list?subnational1Code=]

 

empty list in CSV format


]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c7937de2-68d3-4c01-b239-7c710fca57a7"><ac:plain-text-body><![CDATA[

[][http://localhost/wsws1.0/refdata/subnational2hotspot/list?subnational1Code=US-NYFL]

 

entire list in CSV format

Subnational1 code in uppercase is valid.

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e0d3e0be-c938-41e8-802f-4aaa32bc5489"><ac:plain-text-body><![CDATA[

[][http://localhost/wsws1.0/refdata/subnational2hotspot/list?subnational1Code=us-nyfl]

 

empty list in CSV format

Subnational1 code in lowercase is invalid.

http://localhost/ws/ref/subnational2/list?subnational1Code=US-NY&format=xml

 

entire list in XML format

 

http://localhost/ws/ref/subnational2/find?match=clay

 

entire list in CSV format

 

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d7911971-a024-4e99-9953-d628d58f2ebd"><ac:plain-text-body><![CDATA[

[][][http://localhost/wsws1.0/refdata/subnational2/find?match=CLAY

 

entire list in CSV format

There should be no difference in response for upper/lower case search strings.

http://localhost/ws/ref/subnational2/find?match=clayhotspot/list?subnational1Code=US-FL&format=xml]

 

entire list in XML format

 

http://localhost/ws/ref/subnational2/find?match=

 

empty list in CSV format

 

...

]]></ac:plain-text-body></ac:structured-macro>


CSV Result Format

Panel

<loc ID>, <country code>, <subnational1 code>, <subnational2 code>, <name associated with subnational2 code>
, <latitude>, <longitude>, "<name>"
<loc ID>, <country code>, <subnational1 code>, <latitude>, <longitude>, "<name>"
<loc ID>, <country code>, <subnational1 code>, <latitude>, <subnational2 code>, <name associated with subnational2 code
<longitude>, "<name>"
<loc ID>, <country code>, <subnational1 code>, <subnational2 code>, <name associated with subnational2 code>

XML Result Format

<latitude>, <longitude>, "<name>"

Example

Panel

 L453718, US, US-RI, 41.3302, -71.8375, "Avondale Farm"
L231740, US, US-RI, 41.4496915, -71.3987547, "Beavertail State Park"
L466297, US, US-RI, 41.3202, -71.8303, "Big Maschaug Pond, Watch Hill"
L490189, US, US-RI, 41.3623801, -71.4880371, "Camp Cronin"
L487743, US, US-RI, 41.8591418, -71.3376617, "Central Pond Reservoir"
L466303, US, US-RI, 41.3571, -71.6374, "Charlestown Breachway"
L166174, US, US-RI, 41.49133, -71.292656, "Easton Pond"
L487669, US, US-RI, 41.7074586, -71.6359663, "Flat River Reservoir"
L357306, US, US-RI, 41.9668934, -71.5573883, "Fort Refuge"
L384479, US, US-RI, 41.4743419, -71.3398933, "Ft. Adams State Park"

XML Result Format

Example

No Format

<?xml version="1.0" encoding="UTF-8"?>
<response>
No Format

<response>
  <header>
        <locale country="US" language="en"/>
        <timestamp>2008-0207-21T1225T10:3754:3216.546432-0504:00</timestamp>
        <criteria>
            <property nameid="matchsubnational11Code" value="seomthing"US-RI" description="Rhode Island"/>
      <property name="subnational1Code" value="seomthing"/> </criteria>
      <property name="countryCode" value="seomthing" <comment/>
    </criteria>/header>
    <result>
        <hotspot>
            <loc-id>L453718</loc-id>
            <location>Avondale Farm</location>
            <longitude>-71.8375</longitude>
            <latitude>41.3302</latitude>
    <comment>
        <subnational1-code>US-RI</subnational1-code>
            </comment><country-code>US</country-code>
        </header>
  <result>
hotspot>
        <hotspot>
            <loc-id>L231740</loc-id>
      <location countryCode="" subnational1Code="" subnational2Code="">name of the subnational2<location>Beavertail regionState <Park</location>
            <longitude>-71.3987547</longitude>
    <location countryCode="" subnational1Code="" subnational2Code="">name of the subnational2 region <<latitude>41.4496915</location>latitude>
    <location countryCode="" subnational1Code="" subnational2Code="">name of the subnational2 region </location>
<subnational1-code>US-RI</subnational1-code>
       <location countryCode="" subnational1Code="" subnational2Code="">name of the subnational2 region </location>
     <country-code>US</country-code>
        </hotspot>
    </result>
</response>