- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This is an old revision of the document!
The WorkXpress API exposes the complete WorkXpress Engine using only four simple functions. These functions include:
Each exposed function has the same three simple parameters and returns response XML containing the data requested. These parameters include:
Before each call is made, the client program must assemble an appropriate Request XML string. Then, a connection to the WorkXpress API must be made through the SOAP WSDL. A SOAP connection object must be instantiated, and finally, the call is made.
This call returns a Response XML document, which needs to be parsed by the client program, to extract its requested data.
A complete specification of the request and response XML documents for each exposed API function follows. All code examples are in PHP and will need to be modified for the appropriate language.
For PHP developers there is a PEAR package that makes communicating with WorkXpress easier. For more information, please see http://www.workxpress.com//sites/default/files/Services%20WorkXpress.pdf.
In most programming languages making an API call requires the client application to first instantiate a connection to the server, to a specific WSDL file. The WSDL file defines what functions and data structures are available for consumption through the API.
The URL for the WorkXpress WSDL is: http://example.workxpress.com/api/api.php?wsdl
Once the object is instantiated against the WorkXpress WSDL, all of the functions detailed below are available on the connection object, and can be called like any other function in the client language.
Example:
$soap = new
SoapClient('http://example.workxpress.com/api/api.php?wsdl');
$response = $soap→UpdateItem(1, $auth_code, $xml);
This document is written for compatibility level 1.
