Fields in green are included in the results only if the input parameter detail=simple (default). If detail=full then all result fields will be included.
Field |
Description |
commonName |
species common name. not included in the 'simple' detail if a scientific name was specified as an input parameter |
scientificName |
species scientific name. not included in the 'simple' detail if a scientific name was specified as an input parameter |
obsDt |
observation date (e.g. Feb 27, 2009). formatted according to input locale |
howMany |
The number observed. Not included if only presence was noted |
locID |
unique identifier for the location |
locName |
location name |
lat |
latitude of the location |
lng |
longitude of the location |
subnational2Code |
county code |
subnational2Name |
county name |
subnational1Code |
state/province ISO code |
subnational1Name |
state/province name |
countryCode |
country ISO code |
countryName |
country name |
firstName |
observer's first name |
lastName |
observer's last name |
subID |
submission ID |
obsID |
observation ID |
checklistID |
checklist ID |
obsReviewed |
'true' if obs has been reviewed. 'false' otherwise |
obsValid |
'true' if obs has been deemed valid by a regional reviewer. 'false' otherwise |
locationPersonal |
'true' if location has been marked private by the owner. 'false' otherwise |
presenceNoted |
'true' if user marked present but did not count the number of birds. 'false' otherwise |
Format
General result notes for each currently supported format, including special conditions and error handling.
JSON
Example JSON result for simple detail:
[{"howMany":"39","lat":42.4791969,"locID":"L97555","locName":"Sapsucker Woods","commonName":"Mallard","lng":-76.4513778,"scientificName":"Anas platyrhynchos","obsDt":"Mar 2, 2009"},{"lat":42.4791969,"locID":"L97555","locName":"Sapsucker Woods","commonName":"Mourning Dove","lng":-76.4513778,"scientificName":"Zenaida macroura","obsDt":"Mar 2, 2009"}]
Special Conditions & Error Handling
If there are validation problems with the input parameters the response will be an HTTP 400 error code that includes a simple array containing details of the problems encountered:
["Latitude out of range","Longitude out of range"]
Current List of Error Messages.
This list may change or be added to at any time.
error.data.lat_out_of_range = Latitude out of range
error.data.lng_out_of_range = Longitude out of range
error.data.lat_required = Latititude is required
error.data.lng_required = Longitude is required
error.data.rcodes_required = One or more locIDs are required
error.data.rcodes_toomany = Too many region codes. Please limit your selection to 10 region codes.
error.data.unknown_species = Unknown species: 'branttta canadensis'