Wiki¶

Current service interfaces¶

• Table of contents
• Wiki
  • Current service interfaces
    • Kef web service
      • about
      • version
      • application
      • query
    • Metadata web service
      • about
      • version
      • application
      • query

Kef web service¶

• base url: http://www.iris.edu/pic-ph5/cgi-bin/kef/1/
• 4 supported methods
  • about
  • version
  • application
  • query

about¶

returns basic information about the web service in plain text.
http://www.iris.edu/pic-ph5/cgi-bin/kef/1/about

version¶

returns the version number of the web service build.
http://www.iris.edu/pic-ph5/cgi-bin/kef/1/version

application¶

returns a WADL in xml format.
http://www.iris.edu/pic-ph5/cgi-bin/kef/1/application

query¶

• main application and will return various PH5 data in plain text kef format.
• 2 required parameters(exp_id and kef_type) as well as 2 additional parameters used in certain cases.
• examples below:

http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=experiment_t
This will return all the basic information about the experiment 07-012

http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=event_t
This will return the metadata for all events in kef format for experiment 07-012

http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=array_t&array=001
This requires an additional parameter(array) to indicate what array number you would like. This request will return all the station metadata for a given array

http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=response_t
This will return the response table metadata in kef format for experiment 07-012

http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=Receiver_t
This will return all metadata in the receiver table in kef format for experiment 07-012

http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=index_t
This will return all metadata in the index table in kef format for experiment 07-012

http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=das_t&das=11979
This requires an additional parameter(das) to indicate what das you would like. This will return all metadata about a given das in kef format for experiment 07-012

http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=time_t
This will return all metadata in the time table in kef format for experiment 07-012

http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=master
will return the entire master.ph5 file in ph5 format for experiment 07-012

Metadata web service¶

• base url is: http://www.iris.edu/pic-ph5/cgi-bin/metdata/1/
• 4 supported methods
  • about
  • version
  • application
  • query

about¶

returns basic information about the web service in plain text.
http://www.iris.edu/pic-ph5/cgi-bin/metadata/1/about

version¶

returns the version number of the web service build.
http://www.iris.edu/pic-ph5/cgi-bin/metadata/1/version

application¶

returns a WADL in xml format.
http://www.iris.edu/pic-ph5/cgi-bin/metadata/1/application

query¶

• main application and will return various PH5 data in either JSON or xml (station xml coming soon)
• 3 required parameters(exp_id , format, type)
• examples below:

http://www.iris.edu/pic-ph5/cgi-bin/metadata/1/query?exp_id=07-012&format=JSON&type=Experiment
This will return metadata data about the basic experiment information in JSON format for 07-012. Changing format to XML will return the metadata in a basic xml format.

http://www.iris.edu/pic-ph5/cgi-bin/metadata/1/query?exp_id=07-012&format=JSON&type=Event
This will return metadata for all events in JSON format for 07-012. Changing format to XML will return the metadata in a basic xml format.

http://www.iris.edu/pic-ph5/cgi-bin/metadata/1/query?exp_id=07-012&format=JSON&type=Event
This will return metadata for all DAS in JSON format for 07-012. Changing format to XML will return the metadata in a basic xml format.

http://www.iris.edu/pic-ph5/cgi-bin/metadata/1/query?exp_id=07-012&format=JSON&type=array
This will return metadata for all arrays in JSON format for 07-012. Changing format to XML will return the metadata in a basic xml format.