Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

parameter

required

default

value options

example value

description

status

locIDs locID

no yes

n/a

locID of hotspot locations comma-separated list of up to three locIDs

L97555 ,L259855

The data summary is computed using data submitted to the given locIDs (up to three).
If you ask for more than three locIDs the "extras" are silently ignored. The locIDs are made cannonical before the query is run. That is, they are ordered alphabetically, then truncated to at most 3 IDs. If the locIDs given to the system are not already in cannonical form, they are made cannonical and the request is rebsubmitted through a redirect. This is so that we will be able to use the same cache entry for locIDs=L101,L102,L203 no matter what order they are originally submitted.
Note that the query string ?locIDs=L100&locIDs=L101 does not conform to the API and will not work.

deployed

locale

no

en_US

Java standard locale codes

en_US

Language/locale of common names provided in the response (when translations are available)

implemented, not deployed (as of June 27, 2008)

daysBack

no

0

0, 1, 2, 3, 4, 5, 6, 7

7

How many days backwards to look in computing the summary. Zero means use observations submitted for today. One means use observations for today and yesterday.  Etc.

deployed

...