*** This version of Confluence is for testing only and contains a copy of content from June 29th 2026. No changes will be preserved. ***
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 |
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 a regional reviewer. 'false' otherwise |
Static Examples
JSON
| No Format |
|---|
[{"howMany":"39",
"lat":42.4791969,
"locID":"L97555",
"locName":"Sapsucker Woods",
"comName":"Mallard",
"lng":-76.4513778,
"sciName":"Anas platyrhynchos",
"obsDt":"2009-03-09 11:30"},
]
|
...
Error response
...
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 |
|---|
[{"errorMsg":"Latitude out of range",
"errorCode":"error.data.lat_out_of_range"},
{"errorMsg":"Longitude out of range",
"errorCode":"error.data.lng_out_of_range"}]
|
XML
| No Format |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<response>
<header>
<locale country="" language="en"/>
<timestamp>2009-05-15T15:37:38.625-04:00</timestamp>
<criteria>
<fmt>xml</fmt>
<include-provisional>false</include-provisional>
<hotspot>true</hotspot>
<rtype>loc</rtype>
<r>L99381</r>
<back>14</back>
<max-results>10000</max-results>
</criteria>
</header>
<result>
<sighting>
<loc-id>L99381</loc-id>
<obs-dt>2009-05-15 06:05</obs-dt>
<obs-reviewed>false</obs-reviewed>
<obs-valid>true</obs-valid>
<loc-name>Stewart Park</loc-name>
<how-many>3</how-many>
<lat>42.4613266</lat>
<lng>-76.5059255</lng>
<com-name>American Crow</com-name>
<sci-name>Corvus brachyrhynchos</sci-name>
</sighting>
</result>
</response>
|
...
Error response
...
| No Format |
|---|
<response>
<header>
<locale country="" language="en"/>
<timestamp>2009-05-15T15:40:30.031-04:00</timestamp>
<criteria>
<fmt>xml</fmt>
<include-provisional>false</include-provisional>
<hotspot>true</hotspot>
<rtype>loc</rtype>
<back>14</back>
<max-results>10000</max-results>
<detail>simple</detail>
</command>
</criteria>
<errors>
<error>
<error-msg>Please specify a region code</error-msg>
<error-code>error.data.rcodes_required</error-code>
</error>
</errors>
</header>
<result/>
</response>
|