ProfCom Web Services
The ProfCom Web Services provides programmatic access to run ProfCom analyses.
For an interactive web formular based submission please go to Start Analysis.
According to the W3C a Web Service is a software system designed to support interoperable machine-to-machine interactions over a network. It has an interface that is described in a machine processable format such as WSDL (Web Services Description Language). WSDL provides a format for the description of a Web Service interface, including parameters and data types in sufficient detail for a programmer to write a client application for that service. Various tools are also available to generate these client classes. Other systems interact with the webservice using messages which may be enclosed in a SOAP envelope. For the transport layer itself, Web Services often use Hypertext Transfer Protocol (HTTP).
ProfCom Web Service advantages:
- Allows submission of batch analyses in an automated way. .
- Usable from almost any computer plattform and programming language.
- Allows to use any categorial data e.g. your own user-specific annotations.
The ProfCom Web Service was created using Apache Axis 1.4 and uses RPC SOAP messages. Users can call the Web Service from a client application written in any programming language that supports SOAP. The Web Service is described in the following wsdl file:
Perl: Download example Perl scripts: profcom_webservice_example.zip (compressed zip-archive file).
Java: Please see the axis userguide for help creating the necessary java client classes from the ProfCom WSDL file.
ProfCom WebService Methods
Submits a ProfCom job with along with own annotation data and reference set
INPUT: XML file containing the gene set of interest (setA) and the reference set of genes (setB) along with annotations and the profiling parameters. Your email address is used for user-optimized caching and notification. Important: the XML data file must be vaild formated in the ProfCom data format. All profiling parameters are set up in the XML data file too. Please check the Document Type Definition (DTD) here. That followed the XML data string must be encoded in the Base64 format according to RFC 2047 to avoid potential Web Service XML conflicts.
RESULTS: As result you'll get an array of strings with two elements: the first one contains the assigned job number, the second contains a MD5 hash of your email address. The hash code and the job number together build up the URL where all result files can be downloaded. If an error occurs, the error message will be returned in the first array field starting with the prefix "ERROR" followed by further information.