Differences between revisions 2 and 8 (spanning 6 versions)
⇤ ← Revision 2 as of 2009-03-19 07:02:25 →
Size: 926
Editor: gemelli
Comment:
← Revision 8 as of 2009-03-19 07:30:22 → ⇥
Size: 2081
Editor: gemelli
Comment:
Deletions are marked like this. Additions are marked like this.
Line 16: Line 16:
=== Search for Features/Events in HER ===
To search for Features and Events in HER, one must append ''cmd=search'' to the base url.		 === Simple Search for Features/Events in HER ===
To do a simple search for Features and Events in HER, one must append to the base url:
Line 20: Line 20:
xxx cmd=search&type=column
Line 22: Line 22:

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

{{{
cmd=search&type=column&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&type=column&event_type=ar,fl,ef
}}}

One must also provide a time window using event_starttime and event_endtime

{{{
cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00
}}}

To get results in XML format, set ''cosec=1''

{{{
cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00&cosec=1
}}}


http://www.lmsal.com/her/dev/search-hpkb/hek?cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00&cosec=1&event_region=all&event_coordsys=helioprojective

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.

Simple Search for Features/Events in HER

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

cmd=search&type=column

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

cmd=search&type=column&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&type=column&event_type=ar,fl,ef

One must also provide a time window using event_starttime and event_endtime 

cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00

To get results in XML format, set cosec=1 

cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00&cosec=1

http://www.lmsal.com/her/dev/search-hpkb/hek?cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00&cosec=1&event_region=all&event_coordsys=helioprojective

Display

xxx

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