ChemGPS-NP Web - Web Services API (XML-RPC)

Introduction:

The XML-RPC web service interface was written based on the XML-RPC specification from UserLand Software. It's an traditional web service protocol using HTTP as its transport protocol with the request and response encoded in XML and delivered in the HTTP body (the XML payload).

Warning:

The XML-RPC specification was the result of a pre-dated fork of the work that later become the SOAP protocol specification. The XML-RPC specification is now more or less obsolete, and this paticular implementation should be considered as an experiment (even though its fully working).

If you find yourself wondering: "Should I use this in a production environment?", then the short answer is "No!". Use REST, SOAP or HTTP RPC instead.

Error handling:

The HTTP status code is always 200 and errors are encoded in the XML payload.

Specification:

The specification used can be found here: http://www.xmlrpc.com/spec

Testing:

Here are some example of using the utils/ws.php client for testing the XML-RPC protocol.

Show all RPC methods:

bash$> php ws.php --type=xmlrpc --func=batchelor.info

Describe the RPC method named batchelor.resume:

bash$> php ws.php --type=xmlrpc --func=batchelor.func --params='func=batchelor.resume'

List all jobs finished with errors, sorted by their start time:

bash$> php ws.php --type=xmlrpc --func=batchelor.queue --params='sort=started&filter=error'

Starting new job with simula.c as indata:

bash$> php ws.php --type=xmlrpc --func=batchelor.enqueue --post=simula.c


Index :: Introduction :: Setup :: SOAP :: REST :: HTTP RPC :: XML-RPC