- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
api [2012/08/01 17:49] lisa created |
api [2016/09/14 18:19] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | The WorkXpress API exposes the complete WorkXpress Engine using only four | + | API Overview |
| - | simple functions. These functions include: | + | |
| - | * LookupData | ||
| - | * AddItem | ||
| - | * UpdateItem | ||
| - | * ExecuteAction | ||
| - | Each exposed function has the same three simple parameters and returns response | ||
| - | XML containing the data requested. These parameters include: | ||
| - | |||
| - | * API version | ||
| - | * Authentication Code | ||
| - | * Request XML | ||
| - | |||
| - | 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. | ||
