PH5 » PH5 Web Service Interfaces

h1. Overview Wiki

The DMC has three FDSNWS compatible h2. Current service interfaces

{{toc}}

h3. Kef web service end points for accessing

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

h4. about

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

h4. version

returns the version number of PH5 data at the DMC. Additionally PASSCAL maintains web service build.
http://www.iris.edu/pic-ph5/cgi-bin/kef/1/version

h4. application

returns a web form hosted on IRIS DMC hardware for accessing PH5 datasets WADL in SEG-Y xml format. Below are links to the web services, source code
http://www.iris.edu/pic-ph5/cgi-bin/kef/1/application

h4. query

* main application and will return various PH5 Web Service documentation, public PH5 API documentation, data in plain text kef format.
* 2 required parameters(exp_id and PH5 Web Form. The PH5 APIs are maintained jointly by PASSCAL 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 IRIS DMC. The PH5 Web Services utilize basic information about the PH5 APIs 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 data extraction. all events in kef format for experiment 07-012

h2. PH5 Wiki http://www.iris.edu/pic-ph5/cgi-bin/kef/1/query?exp_id=07-012&kef_type=array_t&array=001
* PH5 API Wiki: https://github.com/PIC-IRIS/PH5/wiki 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

h2. PH5 Web Services 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

PH5 Web services are used 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 timeseries and 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 extraction in miniSEED and SAC format. 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

h3. Primary Web Service Interfaces Metadata web service

* PH5 Dataselect: https://service.iris.edu/ph5ws/dataselect/1/ base url is: http://www.iris.edu/pic-ph5/cgi-bin/metdata/1/
* 4 supported methods
** about
** version
** application
** query

h4. about

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

h4. version

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

h4. application

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

h4. query

* main application and will return various PH5 Station: https://service.iris.edu/ph5ws/station/1/ data in either JSON or xml (station xml coming soon)
* PH5 Event: https://service.iris.edu/ph5ws/event/1/ 3 required parameters(exp_id , format, type)
* examples below:

h3. PH5 Web Form 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.

PH5 Web Form is used http://www.iris.edu/pic-ph5/cgi-bin/metadata/1/query?exp_id=07-012&format=JSON&type=Event
This will return metadata for timeseries data extraction all events in SEG-Y and SAC JSON format for 07-012. Changing format to XML will return the metadata in a basic xml format.

* Experiment List: http://ds.iris.edu/pic-ph5/experiment_list.php 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.