Versions Compared

Old Version 15

changes.mady.by.user user-ad27b

Saved on

compared with

New Version Current

changes.mady.by.user user-ad27b

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

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

locationPrivate

location-private

'true' if location is not a birding hotspot.  'false' otherwise

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 either the automatic filters or 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:

...

Example Responses

XML

No Format
 
<?xml version="1.0" encoding="UTF-8"?> 
<response>
    <header>
        <locale country="US" language="en"/>
        <timestamp>
            2009-07-01T10:29:53.035-04:00
        </timestamp>
        <criteria>
            <command>
                <fmt>
                    xml
                </fmt>
                <include-provisional>
                    true
                </include-provisional>                
                <r>
                    L99381
                </r>
                <back>
                    30
                </back>
                <max-results>
                    500
                </max-results>
                <detail>
                    simple
                </detail>
            </command>
        </criteria>
    </header>
    <result>
        <sighting>
            <loc-id>
                L99381
            </loc-id>
            <obs-dt>
                2009-06-24 17:00
            </obs-dt>
            <obs-reviewed>
                false
            </obs-reviewed>
            <obs-valid>
                true
            </obs-valid>
            <loc-name>
                Stewart Park
            </loc-name>
            <how-many>
                1
            </how-many>
            <lat>
                42.4613266
            </lat>
            <lng>
                -76.5059255
            </lng>
            <com-name>
                Barn Swallow
            </com-name>
            <sci-name>
                Hirundo rustica
            </sci-name>
        </sighting>
    </result>
</response>

...

Error response

...

JSON

No Format
 
<response>[{
  <header>
  <locale country="locID": language="en"/>
  <timestamp>2009-05-15T15:40:30.031-04:00</timestamp>L99381",
  <criteria>
    <fmt>xml</fmt>"lat": 42.4613266,
    <include-provisional>false</include-provisional>
    <hotspot>true</hotspot>"howMany": 1,
    <rtype>loc</rtype>
    <back>14</back>"locName": "Stewart Park",
    <max-results>10000</max-results>
    <detail>simple</detail>"obsValid": true,
    </command>
  </criteria>"lng": -76.5059255,
  <errors>
  "sciName": "Hirundo <error>rustica",
      <error-msg>Please specify a region code</error-msg>"obsReviewed": false,
      <error-code>error.data.rcodes_required</error-code>
    </error>
  </errors>
  </header>
  <result/>
</response> "obsDt": "2009-06-24 17:00",
    "comName": "Barn Swallow"
}]