• Created by user-ad27b, last updated on Jul 01, 2009 1 minute read

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

Example Responses

XML

<?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>

JSON

[{
    "locID": "L99381",
    "lat": 42.4613266,
    "howMany": 1,
    "locName": "Stewart Park",
    "obsValid": true,
    "lng": -76.5059255,
    "sciName": "Hirundo rustica",
    "obsReviewed": false,
    "obsDt": "2009-06-24 17:00",
    "comName": "Barn Swallow"
}]

Full Detail Fields

In addition to the result fields above, these fields are included when full detail is requested:

Field (JSON)

Field (XML)

Description

subnational2Code

subnational2-code

county code

subnational2Name

subnational2-name

county name

subnational1Code

subnational1-code

state/province ISO code

subnational1Name

subnational1-name

state/province name

countryCode

country-code

country ISO code

countryName

country-name

country name

firstName

first-name

observer's first name

lastName

last-name

observer's last name

subID

sub-id

submission ID

obsID

obs-id

observation ID

checklistID

checklist-id

checklist ID

locationPersonal

location-personal

'true' if location has been marked private by the owner.  'false' otherwise

presenceNoted

presence-noted

'true' if user marked presence but did not count the number of birds.  'false' otherwise

Full Detail JSON Example Result

Note that "full" detail nearly triples the size of the response on average. 

 
[{"lat":42.446935, 
"obsValid":true, 
"firstName":"Marshall", 
"locID":"L212389", 
"obsID":"OBS65284875", 
"subID":"S4684058", 
"obsReviewed":true, 
"presenceNoted":false, 
"comName":"Herring x Lesser Black-backed Gull (hybrid)", 
"sciName":"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"}]
  • No labels