| Wiki Markup |
|---|
Fields in {color:#006600}green{color} 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
...
| *Field* \\ | *Description* \\ | | {color:#006600}commonName{color} | species common name. not included in the 'simple' detail if a scientific name was specified as an input parameter \\ | | {color:#006600}scientificName{color} \\ | species scientific name. not included in the 'simple' detail if a scientific name was specified as an input parameter | | {color:#006600}obsDt{color} | observation date formatted according to [ISO 8601|http://en.wikipedia.org/wiki/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
...
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 result for simple detail:
| No Format |
|---|
\\ | | {color:#006600}howMany{color} | The number observed. Not included if only presence was noted \\ | | {color:#006600}locID{color} | unique identifier for the location \\ | | {color:#006600}locName{color} | location name \\ | | {color:#006600}lat{color} | latitude of the location \\ | | {color:#006600}lng{color} | longitude of the location | | {color:#660099}subnational2Code{color} | county code \\ | | {color:#660099}subnational2Name{color} | county name \\ | | {color:#660099}subnational1Code{color} | state/province ISO code \\ | | {color:#660099}subnational1Name{color} | state/province name \\ | | {color:#660099}countryCode{color} | country ISO code \\ | | {color:#660099}countryName{color} | country name \\ | | {color:#660099}firstName{color} | observer's first name \\ | | {color:#660099}lastName{color} | observer's last name \\ | | {color:#660099}subID{color} | submission ID \\ | | {color:#660099}obsID{color} | observation ID \\ | | {color:#660099}checklistID{color} | checklist ID \\ | | {color:#660099}obsReviewed{color} | 'true' if obs has been reviewed. 'false' otherwise \\ | | {color:#660099}obsValid{color} | 'true' if obs has been deemed valid by a regional reviewer. 'false' otherwise \\ | | {color:#660099}locationPersonal{color} | 'true' if location has been marked private by the owner. 'false' otherwise \\ | | {color:#660099}presenceNoted{color} | 'true' if user marked presence but did not count the number of birds. 'false' otherwise \\ | h2. Format General result notes for each currently supported format, including special conditions and error handling. h3. JSON Example result for simple detail: {noformat} [{"howMany":"39", "lat":42.4791969, "locID":"L97555", "locName":"Sapsucker Woods", "commonName":"Mallard", "lng":-76.4513778, "scientificName":"Anas platyrhynchos", "obsDt":"2009-03-09 11:30"}, {"lat":42.4791969,"locID":"L97555","locName":"Sapsucker Woods","commonName":"Mourning Dove","lng":-76.4513778,"scientificName":"Zenaida macroura","obsDt":"2009-03-09 11:30"}] {noformat} Example result for full detail. |
...
The "full" detail nearly triples the size of the response on average: |
...
{noformat |
} [{"lat":42.446935, "obsValid":true, "firstName":"Marshall", "locID":"L212389", "obsID":"OBS65284875", "subID":"S4684058", "obsReviewed":true, "presenceNoted":false, "commonName":"Herring x Lesser Black-backed Gull (hybrid)", "scientificName":"Larus argentatus x fuscus", "obsDt":"2009-03-09", "howMany":1, "locationPrivate":false, "subnational2Code":"US-NY-109", "subnational1Code":"US-NY", "locName":"Game Farm and Compost Pile", "subnational2Name":"Tompkins", "subnational1Name":"New York", "lng":-76.4375442, "countryCode":"US", "countryName":"United States", "checklistID":"CL22224", "lastName":"Iliff"},{"lat":42.4676667,"obsValid":true,"firstName":"Tom","locID":"L583112","obsID":"OBS65588657","subID":"S4705440","obsReviewed":false,"presenceNoted":false,"commonName":"Great Horned Owl","scientificName":"Bubo virginianus","obsDt":"2009-03-09 11:30","howMany":1,"locationPrivate":false,"subnational2Code":"US-NY-109","subnational1Code":"US-NY","locName":"Schulenberg home","subnational2Name":"","subnational1Name":"","lng":-76.4511389,"countryCode":"US","countryName":"United States","checklistID":"CL22224","lastName":"Schulenberg"}] |
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:
| No Format |
|---|
{noformat} h4. 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: {noformat} ["Latitude out of range","Longitude out of range"] |
Current List of Error Messages
This list may change or be added to at any time.
{noformat} h5. Current List of Error Messages This list may change or be added to at any time. Items in brackets '{0}' will be specified at the time the message is received. error.data.lat_out_of_range = Latitude out of range |
...
error.data.lng_out_of_range = Longitude out of range |
...
error.data.lat_required |
...
= Parameter 'lat' is required error.data.lng_required |
...
= Parameter 'lng' is required error.data.rcodes_required = One or more locIDs are |
...
required error.data.rtype_required = The parameter 'rtype' is required error.data.rcodes_toomany = Too many region codes. Please limit your selection to |
...
{0} region codes |
...
. error.data.too_many_back = The maximum number of days back is {0} error.data.unknown_species = Unknown species: |
...
{0} |