*** This version of Confluence is for testing only and contains a copy of content from June 29th 2026. No changes will be preserved. ***
-
Created by
user-ad27b, last updated on Jun 30, 2009
1 minute read
Result Field Descriptions
Simple Result Fields
Field (JSON) |
Field (XML) |
Description |
|---|---|---|
comName |
com-name |
species common name. not included in the 'simple' detail if a scientific name was specified as an input parameter |
sciName |
sci-name |
species scientific name. not included in the 'simple' detail if a scientific name was specified as an input parameter |
obsDt |
obs-dt |
observation date formatted according to ISO 8601 (e.g. 'YYYY-MM-DD', or 'YYYY-MM-DD hh:mm'). Hours and minutes are excluded if the observer did not report an observation time. |
howMany |
how-many |
The number observed. Not included if only presence was noted |
locID |
loc-id |
unique identifier for the location |
locationPrivate |
location-private |
'true' if location is not a birding hotspot. 'false' otherwise |
locName |
loc-name |
location name |
lat |
lat |
latitude of the location |
lng |
lng |
longitude of the location |
obsReviewed |
obs-reviewed |
'true' if obs has been reviewed. 'false' otherwise |
obsValid |
obs-valid |
'true' if obs has been deemed valid by either the automatic filters or a regional reviewer. 'false' otherwise |
Example Responses
XML
<?xml version="1.0" encoding="UTF-8"?>
<response>
<header>
<locale country="US" language="en"/>
<timestamp>
2009-07-01T10:29:53.035-04:00
</timestamp>
<criteria>
<command>
<fmt>
xml
</fmt>
<include-provisional>
true
</include-provisional>
<r>
L99381
</r>
<back>
30
</back>
<max-results>
500
</max-results>
<detail>
simple
</detail>
</command>
</criteria>
</header>
<result>
<sighting>
<loc-id>
L99381
</loc-id>
<obs-dt>
2009-06-24 17:00
</obs-dt>
<obs-reviewed>
false
</obs-reviewed>
<obs-valid>
true
</obs-valid>
<loc-name>
Stewart Park
</loc-name>
<how-many>
1
</how-many>
<lat>
42.4613266
</lat>
<lng>
-76.5059255
</lng>
<com-name>
Barn Swallow
</com-name>
<sci-name>
Hirundo rustica
</sci-name>
</sighting>
</result>
</response>
JSON
[{
"locID": "L99381",
"lat": 42.4613266,
"howMany": 1,
"locName": "Stewart Park",
"obsValid": true,
"lng": -76.5059255,
"sciName": "Hirundo rustica",
"obsReviewed": false,
"obsDt": "2009-06-24 17:00",
"comName": "Barn Swallow"
}]
Full Result Fields
In addition to the fields above, these fields are included in the response when full detail is requested:
Field (JSON) |
Field (XML) |
Description |
|---|---|---|
subnational2Code |
subnational2-code |
county code |
subnational2Name |
subnational2-name |
county name |
subnational1Code |
subnational1-code |
state/province ISO code |
subnational1Name |
subnational1-name |
state/province name |
countryCode |
country-code |
country ISO code |
userDisplayName |
user-display-name |
first and last name of the observer, when available |
countryName |
country-name |
country name |
firstName |
first-name |
observer's first name, when available (DEPRECATED in favor of userDisplayName) |
lastName |
last-name |
observer's last name, when available (DEPRECATED in favor of userDisplayName) |
subID |
sub-id |
submission ID |
obsID |
obs-id |
observation ID |
checklistID |
checklist-id |
checklist ID |
presenceNoted |
presence-noted |
'true' if user marked presence but did not count the number of birds. 'false' otherwise |
Example Responses
Note that "full" detail nearly triples the size of the response on average.
XML
<?xml version="1.0" encoding="UTF-8"?>
<response>
<header>
<locale country="US" language="en"/>
<timestamp>
2009-07-01T11:26:06.296-04:00
</timestamp>
<criteria>
<fmt>
xml
</fmt>
<hotspot>
false
</hotspot>
<rtype>
subnational1
</rtype>
<r>
US-NY
</r>
<back>
5
</back>
<max-results>
500
</max-results>
<detail>
full
</detail>
</criteria>
</header>
<result>
<sighting>
<sub-id>
S5130155
</sub-id>
<obs-id>
OBS72270247
</obs-id>
<checklist-id>
CL22361
</checklist-id>
<loc-id>
L285876
</loc-id>
<presence-noted>
false
</presence-noted>
<location-private>
true
</location-private>
<country-name>
United States
</country-name>
<country-code>
US
</country-code>
<subnational2-name>
Richmond
</subnational2-name>
<subnational2-code>
US-NY-085
</subnational2-code>
<first-name>
Catherine
</first-name>
<subnational1-name>
New York
</subnational1-name>
<last-name>
Barron
</last-name>
<subnational1-code>
US-NY
</subnational1-code>
<obs-dt>
2009-06-30 13:30
</obs-dt>
<obs-reviewed>
false
</obs-reviewed>
<obs-valid>
false
</obs-valid>
<loc-name>
SI-South Beach/Ft Wadsworth
</loc-name>
<how-many>
2
</how-many>
<lat>
40.6028326
</lat>
<lng>
-74.0537782
</lng>
<com-name>
Red-throated Loon
</com-name>
<sci-name>
Gavia stellata
</sci-name>
</sighting>
</result>
</response>
JSON
[{
"locID": "L285876",
"locationPrivate": true,
"checklistID": "CL22361",
"obsValid": false,
"presenceNoted": false,
"countryCode": "US",
"subnational1Name": "New York",
"subnational1Code": "US-NY",
"lastName": "Barron",
"lat": 40.6028326,
"howMany": 2,
"firstName": "Catherine",
"sciName": "Gavia stellata",
"subnational2Name": "Richmond",
"subnational2Code": "US-NY-085",
"obsReviewed": false,
"comName": "Red-throated Loon",
"obsID": "OBS72270247",
"locName": "SI-South Beach/Ft Wadsworth",
"lng": -74.0537782,
"subID": "S5130155",
"obsDt": "2009-06-30 13:30",
"countryName": "United States"
}]
Unable to render {include} The included page could not be found.