EMBL-EBI Web Services

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== PHP SOAP ======

===== Introduction =====

[[http://www.php.net/soap|PHP SOAP]] is included with PHP 5 making it the simplest tool kit to set-up.

===== Creating a Service Proxy =====

For SOAP services providing a WSDL document, a service proxy object can be generated from the WSDL at runtime, allowing access to the current service interface.

For example using the [[services:dbfetch|WSDbfetch]] service (''[[https://svn.ebi.ac.uk/webservices/webservices-1.0/trunk/clients/php/examples/dbfetch_php_soap.php|dbfetch_php_soap.php]]''):
<code php>
# URL for the service WSDL
$wsdlUrl = 'http://www.ebi.ac.uk/ws/services/WSDbfetch?wsdl';

try {
  // Get a service proxy from the WSDL
  $proxy = new SoapClient($wsdlUrl);
 
  // Call a method on the service via the proxy
  $result = $proxy->fetchData('UNIPROT:ADH1A_HUMAN', 'fasta', 'raw');
  echo $result;
}
catch(SoapFault $ex) {
  echo 'Error: ';
  if($ex->getMessage() != '') echo $ex->getMessage();
  else echo $ex;
  echo "\n";
}
</code>

===== Complex Types =====

The methods in the [[services:dbfetch|WSDbfetch]] all use simple string parameters. Many of the other EBI services use more complex input structures. For example [[services:wublast|WSWUBlast]] requires a structure containing the various parameters and the input sequence to be passed to the ''runWUBlast'' method (''[[https://svn.ebi.ac.uk/webservices/webservices-1.0/trunk/clients/php/examples/wublast_php_soap.php|wublast_php_soap.php]]''):
<code php>
  // Input parameters
  $params = array(
		  'email' => 'email@example.org',
		  'async' => TRUE,
		  'program' => 'blastp',
		  'database' => 'swissprot'
		  );

  // Input data
  $data = array(
		array(
		      'type' => 'sequence',
		      'content' => <<<EOF
>Q8E5Q5_STRA3
MKLSKRYRFWQKVIKALGVLALIATLVLVVYLYKLGILNDSNELKDLVHKYEFWGPMIFI
VAQIVQIVFPVIPGGVTTVAGFLIFGPTLGFIYNYIGIIIGSVILFWLVKFYGRKFVLLF
MDQKTFDKYESKLETSGYEKFFIFCMASPISPADIMVMITGLSNMSIKRFVTIIMITKPI
SIIGYSYLWIYGGDILKNFLN
EOF
		      )
		);

  // Submit the job
  $jobId = $proxy->runWUBlast($params, $data);
  echo "$jobId\n";
</code>

The ''runWUBlast'' method returns a job identifier which can be used with the ''checkStatus'' method to get the status of the job (e.g. ''RUNNING'', ''DONE'' or ''ERROR'') and the ''poll'' method to get the results of the job:
<code php>
  // Poll till job finishes
  $status = 'PENDING';
  while(strcmp($status, 'RUNNING') == 0 || strcmp($status, 'PENDING') == 0) {
    $status = $proxy->checkStatus($jobId);
    echo "$status\n";
    if(strcmp($status, 'RUNNING') == 0 || strcmp(status, 'PENDING') == 0) {
      sleep(10);
    }
  }

  // Get the result
  $result = $proxy->poll($jobId, 'tooloutput');
  echo $result;
</code>

===== Sample Clients =====

Most SOAP Web Services at [[http://www.ebi.ac.uk/|EMBL-EBI]] have sample clients which provide command-line access to the service and example code. For PHP some of the clients are based on PHP-SOAP.

==== Document/literal SOAP ====

^ Service ^ Sample client ^
| [[:services:pfa:iprscan_soap|InterProScan (SOAP)]] | ''[[https://svn.ebi.ac.uk/webservices/webservices-2.0/trunk/php/php_soap/iprscan_lib_php_soap.php|iprscan_lib_php_soap.php]]'', ''[[https://svn.ebi.ac.uk/webservices/webservices-2.0/trunk/php/php_soap/iprscan_cli_php_soap.php|iprscan_cli_php_soap.php]]'', ''[[https://svn.ebi.ac.uk/webservices/webservices-2.0/trunk/php/php_soap/iprscan_web_php_soap.php|iprscan_web_php_soap.php]]'' |
| [[:services:sss:NCBI BLAST (SOAP)]] | ''[[https://svn.ebi.ac.uk/webservices/webservices-2.0/trunk/php/php_soap/ncbiblast_lib_php_soap.php|ncbiblast_lib_php_soap.php]]'', ''[[https://svn.ebi.ac.uk/webservices/webservices-2.0/trunk/php/php_soap/ncbiblast_cli_php_soap.php|ncbiblast_cli_php_soap.php]]'', ''[[https://svn.ebi.ac.uk/webservices/webservices-2.0/trunk/php/php_soap/ncbiblast_web_php_soap.php|ncbiblast_web_php_soap.php]]'' |
| [[:services:dbfetch|WSDbfetch (SOAP)]] | ''[[https://svn.ebi.ac.uk/webservices/webservices-2.0/trunk/php/php_soap/wsdbfetch_lib_php_soap.php|wsdbfetch_lib_php_soap.php]]'', ''[[https://svn.ebi.ac.uk/webservices/webservices-2.0/trunk/php/php_soap/wsdbfetch_cli_php_soap.php|wsdbfetch_cli_php_soap.php]]'', ''[[https://svn.ebi.ac.uk/webservices/webservices-2.0/trunk/php/php_soap/wsdbfetch_web_php_soap.php|wsdbfetch_web_php_soap.php]]'' |

==== RPC/encoded SOAP ====

^ Service ^ Sample client ^
| [[:services:dbfetch|WSDbfetch]] | ''[[https://svn.ebi.ac.uk/webservices/webservices-1.0/trunk/clients/php/wsdbfetch_cli_php_soap.php|wsdbfetch_cli_php_soap.php]]'' |

\\
^ Up | [[..:..:PHP]] ^ Contents | [[..:..:..:00_Contents|Contents]] |
EMBL-EBI Web Services

EMBL-EBI

Services

Research

Training

Industry

About us
