Diff for "ApplicationProgrammingInterface"

Differences between revisions 1 and 5 (spanning 4 versions)

Heliophysics Events Knowledgebase API

Third party clients can communicate with the Heliophysics Events Knowledgebase (HER) via our web API. Usage of an API function amounts to using HTTP to fetch a web document. The base url for all API calls is (including the question mark)

http://www.lmsal.com/her/dev/search-hpkb/hek?

Following the url base, one can append a list of keywords to specify the type of command and options for that specific command.

Search for Features/Events in HER

To search for Features and Events in HER, one must append to the base url:

cmd=search

In addition to the command (cmd), one must specify which event type to search for. For all event types, use **

cmd=search&event_type=**

For some but not all event types, use a comma delimited list of two-letter abbreviations (see http://www.lmsal.com/helio-informatics/hpkb/VOEvent_Spec.html for full list of event types). E.g. the following specifies that one wishes to search for active regions, flares and emerging flux regions:

cmd=search&event_type=ar,fl,ef

Display

xxx

HekWiki: ApplicationProgrammingInterface (last edited 2014-08-15 05:19:04 by MarkCheung)

-  ⇤ ← Revision 1 as of 2009-03-19 06:58:27 → 
  Size: 649
  Editor: gemelli
  Comment:
+   ← Revision 5 as of 2009-03-19 07:16:17 → ⇥
  Size: 1417
  Editor: gemelli
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 10:
-a web document. The base url for all API calls is
+a web document. The base url for all API calls is (including the question mark)
 Line 14:
+Following the url base, one can append a list of keywords to specify the type of command and options for that specific command.
-Line 15:
+Line 16:
-=== Example ===
+=== Search for Features/Events in HER ===
To search for Features and Events in HER, one must append to the base url:
-Line 17:
+Line 20:
-xxx
+cmd=search
-Line 19:
+Line 22:
+In addition to the command (cmd), one must specify which event type to search for. For all event types, use **

{{{
cmd=search&event_type=**
}}} 

For some but not all event types, use a comma delimited list of two-letter abbreviations (see http://www.lmsal.com/helio-informatics/hpkb/VOEvent_Spec.html for full list of event types). E.g. the following specifies that one wishes to search for active regions, flares and emerging flux regions:

{{{
cmd=search&event_type=ar,fl,ef
}}}