...
Parameter Name | Required | Default | Value Options | Example Value | Description |
|---|---|---|---|---|---|
back |
| 14 | 1 - 30 integer | 7 | the number of days back to look for observations |
maxResults |
| 1 - 10000 integer | 10 | the maximum number of result rows to return in this request; to get all results do not include this parameter | |
detail |
| simple | simple | simple | toggle to restrict results to either all or a subset of sighting fields. see result field descriptions |
locale |
| en_US | Java standard locale codes | fr_CA | Language/locale of response (when translations are available). See http://java.sun.com/javase/6/docs/api/java/util/Locale.html. |
fmt |
| xml | json, xml | json | format of the response |
r | yes |
| any hotspot locID | L99381 | Code(s) for region of interest; here, regions are the locIDs of hotspots. LocIDs that are not valid or are not hotspots are ignored. Maximum of 10 locIDs. |
includeProvisional |
| false | true,false | false | set to true if you'd like flagged records that have not yet been reviewed to be included in the results |
Result Field Descriptions
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 |
numChecklists | num-checklists | the number of checklists reporting the species |
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 |
XML Example Result
| No Format |
|---|
<response><header><locale country="" language="en"/><timestamp>2009-06-24T11:04:34.397-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>1000</max-results><detail>simple</detail></criteria></header><result><sighting><loc-id>L99381</loc-id><obs-dt>2009-06-22 08:00</obs-dt><obs-reviewed>false</obs-reviewed><obs-valid>true</obs-valid><num-checklists>1</num-checklists><loc-name>Stewart Park</loc-name><how-many>2</how-many><lat>42.4613266</lat><lng>-76.5059255</lng><com-name>American Coot</com-name><sci-name>Fulica americana</sci-name></sighting></result></response>
|
JSON Example Result
| No Format |
|---|
[{"locID":"L99381","lat":42.4613266,"howMany":2,"locName":"Stewart Park","obsValid":true,"lng":-76.5059255,"sciName":"Fulica americana","numChecklists":1,"obsReviewed":false,"obsDt":"2009-06-22 08:00","comName":"American Coot"},{"locID":"L99381","lat":42.4613266,"howMany":4,"locName":"Stewart Park","obsValid":true,"lng":-76.5059255,"sciName":"Dendroica petechia","numChecklists":2,"obsReviewed":false,"obsDt":"2009-06-22 08:00","comName":"Yellow Warbler"}]
|