1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_soap_server">
<refmeta>
<refentrytitle>soap_server</refentrytitle>
<refmiscinfo>soap</refmiscinfo>
</refmeta>
<refnamediv>
<refname>soap_server</refname>
<refpurpose>Execute SOAP request and return XML reply as a varchar.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_soap_server">
<funcprototype id="fproto_soap_server">
<funcdef>varchar <function>soap_server</function></funcdef>
<paramdef>in <parameter>req_xml</parameter> any</paramdef>
<paramdef><optional>in <parameter>soap_method</parameter> varchar</optional></paramdef>
<paramdef><optional>in <parameter>lines</parameter> any</optional></paramdef>
<paramdef><optional>in <parameter>soap_version</parameter> long</optional></paramdef>
<paramdef><optional>in <parameter>procedure_mappings</parameter> any</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_soap_server"><title>Description</title><para>
This function executes the SOAP request in the same way as it it was
directed to the <literal>/SOAP</literal> physical path.
It returns the XML SOAP reply as a varchar value.</para></refsect1>
<refsect1 id="params_soap_server"><title>Parameters</title>
<refsect2><title>req_xml</title>
<para>Required. The XML entity of the SOAP request to execute.</para></refsect2>
<refsect2><title>soap_method</title>
<para>Optional(default ""). The "SOAPAction" header field value</para></refsect2>
<refsect2><title>lines</title>
<para>Optional(default NULL). The Request header fields (the lines parameter to the VSPs for HTTP)</para></refsect2>
<refsect2><title>soap_version</title>
<para>Optional(default 11). The SOAP version (11 for SOAP 1.1 and 1 for SOAP 1.0)</para></refsect2>
<refsect2><title>procedure_mappings</title>
<para>Optional(default NULL). A vector of pairs (<SOAP_method>, <PL procedure>)
mapping the SOAP call request to the corresponding PL function name.
If empty, then the mapping proceeds by taking the local name of the SOAP
method and finding a procedure with the same name in the executing
user's current qualifier and owner.</para>
<para>If a string is supplied then this string is considered as a PL module name.
Mapping takes place from the local name of the SOAP call to a PL procedure inside
the module. Virtuoso matches procedure names in case-sensitive fashion.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_soap_server"><title>Return Types</title><para>Returns the XML SOAP reply as a varchar value.</para></refsect1>
</refentry>
|
