Qore SoapClient Module Reference: SoapClient Module

Qore SoapClient Module Reference 0.2.3

- Main Page
- Namespaces
- Classes

All Classes Namespaces Functions Variables Pages
SoapClient Module

# Introduction

The SoapClient module implements a minimal SOAP client using WSDL, XSD, SOAP support implemented in the WSDL module.

Create outgoing request messages by setting up a Qore data structure corresponding to the SOAP message. Exceptions will be thrown if either the outgoing or the response message do not corespond to the WSDL. The exceptions should be fairly verbose to allow you to quickly correct any mistakes.

Currently the WSDL implementation is fairly basic so any messages using unimplemented features of SOAP or XSD will fail.

# Example

Here is an example of how to use this module:

%requires SoapClient
my SoapClient $sc = new SoapClient(("wsdl" : "http://soap.server.org:8080/my-service?wsdl"));
my hash $msg = getMessage();
my any $result = $sc.call("SubmitDocument", $msg);

The SoapClient::constructor() takes named arguments in the form of a hash; valid arguments are:

- required keys: one of:
  - `"wsdl"` or `"wsdl_file"`: a string defining the WSDL or the URL of the WSDL
- optional keys:
  - `"service"`: the name of the "portType" to use (if more than 1 portType is defined in the WSDL then this key is mandatory
  - `"url"`: to override the URL defined in the WSDL
  - `"headers"`: to override any HTTP headers sent in outgoing messages
  - `"event_queue"`: to set an I/O event queue on the HTTPClient

Also the following keys can be set to set HTTP options:

- `"connect_timeout"`
- `"http_version"`
- `"max_redirects"`
- `"proxy"`
- `"timeout"`