<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head profile="http://internetalchemy.org/2003/02/profile">
<link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
<link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
<meta name="dc.title" content="Function: soap_call - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: soap_call - Virtuoso Functions Guide" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
<link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
<link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
<link rel="parent" href="functions.html" title="Chapter Contents" />
<link rel="prev" href="appendixa.html" title="Appendix" />
<link rel="next" href="functions.html#.html" title="" />
<link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="doc.css" />
<link rel="stylesheet" type="text/css" href="/doc/translation.css" />
<title>Function: soap_call - Virtuoso Functions Guide</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<meta name="copyright" content="OpenLink Software, 1999 - 2009" />
<meta name="keywords" content="" />
<meta name="GENERATOR" content="OpenLink XSLT Team" />
</head>
<body>
<div id="header">
<a name="fn_soap_call" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - soap_call</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_soap_dt_define.html" title="soap_dt_define">Prev</a> | <a class="link" href="fn_soap_client.html" title="soap_client">Next</a>
</div>
</div>
<div id="currenttoc">
<form method="post" action="/doc/adv_search.vspx">
<div class="search">Keyword Search: <br />
<input type="text" name="q" /> <input type="submit" name="go" value="Go" />
</div>
</form>
<div>
<a href="http://www.openlinksw.com/">www.openlinksw.com</a>
</div>
<div>
<a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
</div>
<br />
<div>
<a href="index.html">Book Home</a>
</div>
<br />
<div>
<a href="contents.html">Contents</a>
</div>
<div>
<a href="preface.html">Preface</a>
</div>
<br />
<div>
<a class="selected" href="functions.html">Virtuoso Functions Guide</a>
</div>
<br />
<div>
<a href="functions.html#admin">Administration</a>
</div>
<div>
<a href="functions.html#aggr">Aggregate Functions</a>
</div>
<div>
<a href="functions.html#array">Array Manipulation</a>
</div>
<div>
<a href="functions.html#bpel">BPEL APIs</a>
</div>
<div>
<a href="functions.html#backup">Backup</a>
</div>
<div>
<a href="functions.html#compression">Compression</a>
</div>
<div>
<a href="functions.html#cursors">Cursor</a>
</div>
<div>
<a href="functions.html#time">Date & Time Manipulation</a>
</div>
<div>
<a href="functions.html#debug">Debug</a>
</div>
<div>
<a href="functions.html#dict">Dictionary Manipulation</a>
</div>
<div>
<a href="functions.html#encoding">Encoding & Decoding</a>
</div>
<div>
<a href="functions.html#file">File Manipulation</a>
</div>
<div>
<a href="functions.html#ft">Free Text</a>
</div>
<div>
<a href="functions.html#hash">Hashing / Cryptographic</a>
</div>
<div>
<a href="functions.html#ldap">LDAP</a>
</div>
<div>
<a href="functions.html#localization">Locale</a>
</div>
<div>
<a href="functions.html#mail">Mail</a>
</div>
<div>
<a href="functions.html#misc">Miscellaneous</a>
</div>
<div>
<a href="functions.html#number">Number</a>
</div>
<div>
<a href="functions.html#phrz">Phrases</a>
</div>
<div>
<a href="functions.html#rdf">RDF data</a>
</div>
<div>
<a href="functions.html#rmt">Remote SQL Data Source</a>
</div>
<div>
<a href="functions.html#repl">Replication</a>
</div>
<div>
<a class="selected" href="functions.html#soap">SOAP</a>
</div>
<div class="selected">
<div>
<a href="fn_http_body_read.html">http_body_read</a>
</div>
<div>
<a href="fn_soap_box_structure.html">soap_box_structure</a>
</div>
<div>
<a href="fn_soap_box_xml_entity.html">soap_box_xml_entity</a>
</div>
<div>
<a class="selected" href="fn_soap_call.html">soap_call</a>
</div>
<div>
<a href="fn_soap_client.html">soap_client</a>
</div>
<div>
<a href="fn_soap_current_url.html">soap_current_url</a>
</div>
<div>
<a href="fn_soap_dt_define.html">soap_dt_define</a>
</div>
<div>
<a href="fn_soap_make_error.html">soap_make_error</a>
</div>
<div>
<a href="fn_soap_print_box.html">soap_print_box</a>
</div>
<div>
<a href="fn_soap_sdl.html">soap_sdl</a>
</div>
<div>
<a href="fn_soap_server.html">soap_server</a>
</div>
<div>
<a href="fn_soap_wsdl.html">soap_wsdl</a>
</div>
<div>
<a href="fn_soap_wsdl_import.html">soap_wsdl_import</a>
</div>
<div>
<a href="fn_wst_cli.html">wst_cli</a>
</div>
</div>
<div>
<a href="functions.html#sql">SQL</a>
</div>
<div>
<a href="functions.html#string">String</a>
</div>
<div>
<a href="functions.html#txn">Transaction</a>
</div>
<div>
<a href="functions.html#type">Type Mapping</a>
</div>
<div>
<a href="functions.html#uddi">UDDI</a>
</div>
<div>
<a href="functions.html#udt">User Defined Types & The CLR</a>
</div>
<div>
<a href="functions.html#vad">VAD</a>
</div>
<div>
<a href="functions.html#jvmpl">Virtuoso Java PL API</a>
</div>
<div>
<a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
</div>
<div>
<a href="functions.html#ws">Web & Internet</a>
</div>
<div>
<a href="functions.html#xml">XML</a>
</div>
<div>
<a href="functions.html#XPATH">XPATH & XQUERY</a>
</div>
<br />
<div>
<a href="functionidx.html">Functions Index</a>
</div>
<br />
</div>
<div id="text">
<h2>soap_call</h2>
<div class="refpurpose">calls a function from a SOAP server and returns the result. value; deprecated, use SOAP_CLIENT () instead</div>
<div class="funcsynopsis">
<span class="funcdef">any <span class="function">soap_call</span>
</span>
(<span class="paramdef">in <span class="parameter">host</span> string</span>,
<span class="paramdef">in <span class="parameter">path</span> string</span>,
<span class="paramdef">in <span class="parameter">methodURI</span> string</span>,
<span class="paramdef">in <span class="parameter">methodName</span> string</span>,
<span class="paramdef">in <span class="parameter">params</span> array of (ParamName, Value)</span>,
<span class="paramdef">in <span class="parameter">version</span> integer</span>,
<span class="paramdef">in <span class="parameter">certificate</span> varchar</span>,
<span class="paramdef">in <span class="parameter">password</span> varchar</span>,
<span class="paramdef">in <span class="parameter">SOAPAction</span> varchar</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>
This calls a function from a SOAP server and returns the result as a return value.
Params is an array of (Parameter name, Value) pairs representing the parameters
passed in the SOAP call. Each of these pairs become an XML sub-entity
of the procedure entity. The return value of the function is the entity
inside the SOAP body of the response. In debug mode the return value is an
array of 3 elements; the non-debug return value (if any) as element 0, the XML
text of the request as element 1 and the XML text of the server response
as element 2. This function does not use any XML types when creating the
XML. It represents types as a cast to varchar would, with one
exception - dates and times according to ISO8061.
</p>
<p>The Virtuoso SOAP client can work with complex datatypes, in which case
the parameters array must conform to the following convention:</p>
<div>
<pre class="programlisting">
vector ( vector ([name1], [type1]), value1, vector ([name2], [type2]), value2 ...)
</pre>
</div>
<p>This will cause type checking and validation of the values to be
encoded for SOAP request.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">host – </span>
DNS name or IP address of the SOAP server</div>
<div class="refsect2">
<span class="refsect2title">path – </span>
path into the HTTP server containing the SOAP server page</div>
<div class="refsect2">
<span class="refsect2title">methodURI – </span>
URI of the SOAP method being called</div>
<div class="refsect2">
<span class="refsect2title">methodName – </span>
Name of the SOAP method being called</div>
<div class="refsect2">
<span class="refsect2title">params – </span>
array of parameters to the SOAP call; array of (ParamName, Value).
The Virtuoso SOAP client can work with complex datatypes. In order to
support this the parameters array must conform to the following convention:
vector ( vector ([name1], [type1]), value1, vector ([name2], [type2]), value2 ...).
This will cause type checking and validation of the values to be
encoded for SOAP request.</div>
<div class="refsect2">
<span class="refsect2title">version – </span>
the SOAP version used in call (SOAP 1.0 = 1, SOAP 1.1 = 11). Default value = SOAP 1.0.
If the value is negated : i.e. -1 or -11 then the soap_call procedure enters "debug" mode
</div>
<div class="refsect2">
<span class="refsect2title">certificate – </span>
If this parameter is specified (string or null) the HTTPS operation will be performed.
Path to the HTTPS client certificate in PKCS#12 format, if this parameter is set to NULL
then client will do only encrypted connection.
</div>
<div class="refsect2">
<span class="refsect2title">password – </span>
If certificate is supplied this parameter must contain password for opening the certificate file.
</div>
<div class="refsect2">
<span class="refsect2title">SOAPAction – </span>
SOAPAction parameter can be used to make SOAPAction header
value explicit. Normally this is taken from the namespace URI and SOAP
method name.</div>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="" />
<div class="example">
<div class="exampletitle">Calling a SQL procedure fishselect (in str varchar)</div>
<div>
<pre class="programlisting">
declare ret any;
ret := soap_call ('localhost:6666', '/SOAP',
'urn:com-openlinksw-virtuoso',
'fishselect',
vector ('str', 'G'));
</pre>
</div>
</div>
</div>
</div>
<div id="footer">
<div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
<div id="validation">
<a href="http://validator.w3.org/check/referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
549
