Page History

Results and Error Conditions

Result Field Descriptions

Result Formats

Currently, two result formats are supported: xml and json.

XML

Example XML Error Response

<response><header><locale country="" language="en"/><timestamp>2009-05-15T15:40:30.031-04:00</timestamp><criteria><command><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>

JSON

Example JSON Error Response

The response will be an HTTP 400 error code, detailing the problems encountered in a simple JSON array:

[{"errorMsg":"Latitude out of range",
"errorCode":"error.data.lat_out_of_range"},
{"errorMsg":"Longitude out of range",
"errorCode":"error.data.lng_out_of_range"}]

Special Conditions and Error Handling

If there are validation problems with the input parameters the response will have an appropriate HTTP status code (e.g., 400) and details of the problem will be provided in the result format requested (JSON or XML).

Current List of Error Messages

This list may change or be added to at any time.  Items in brackets will be specified at the time the message is received.

...

Caching Information

For details on caching of results by our servers, see eBird-1.1-CacheInformation