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* \\ |
| {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 (e.g. Feb 27, 2009). formatted according to input locale |
| {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 present 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 JSON result for simple detail:
{noformat}
[{"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"}]
{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"]
{noformat}
h3. 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 {0} region codes.
error.data.unknown_species = Unknown species: {0}
|