Check-in [63108ec92f]
Not logged in
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to tclconference@googlegroups.com
or submit via the online form by Sep 9.

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Reworked the webservice call option list documentation (so I understand it better)
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256:63108ec92fbbf61d75417a6f7d185f635a8d840fba8ac4bddbd06464328c7bfc
User & Date: oehhar 2017-11-14 10:14:38
Context
2017-11-28 15:37
Two log optimizations "a $b" -> [list "a" $b] check-in: f52de14493 user: oehhar tags: trunk
2017-11-14 10:14
Reworked the webservice call option list documentation (so I understand it better) check-in: 63108ec92f user: oehhar tags: trunk
2017-11-06 08:20
Added check (for nested namespace prefix case), that a namespace prefix is not reused for another URI. See Ticket [dcce437d7a] check-in: fb182ca3fc user: oehhar tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to docs/Calling_a_Web_Service.html.

   348    348   </p><h2>Configuring a Service </h2>
   349    349   <p><b>Procedure Name&nbsp;: <i>::WS::Client::Config</i></b> </p>
   350    350   <p><b>Description&nbsp;: Configure a service's information</b> </p>
   351    351   <p><b>Arguments&nbsp;:</b> </p>
   352    352   <pre>
   353    353        <i>serviceName</i>     - The name of the Webservice
   354    354        <i>item</i>   - The item to configure.  Must be one of
          355  +</pre>
   355    356   <ul>
   356         -<li>contentType -- default is "text/xml;charset=utf-8"</li>
   357         -<li>location -- The URL of the service, derived from the WSDL.</li>
   358         -<li>skipHeaderLevel -- boolean indicating the first level of the XML in a request header <i><b>shall be</b></i> skipped.  Derived from options.  Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
   359         -<li>skipLevelOnReply -- boolean indicating the first level of the XML in a reply <i><b>may be</b></i> skipped.  Derived from options.  Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
   360         -<li>skipLevelWhenActionPresent -- boolean indicating if the first level of the XML is to be skipped.  Derived from options.  Default is 0 (do not skip).</li>
   361         -<li>suppressTargetNS -- boolean indicating if target namespace is not to be added to XML.  Derived from options.  Default is 0 (do not suppress). </li>
   362         -<li>targetNamespace -- the target namespace of the service, derived from the WSDL.</li>
   363         -<li>parseInAttr - parse attributes on inbound tags, see <A HREF="Using_Options.html#parseInAttr">here</A> for details</li>
   364         -<li>genOutAttr - generate attributes on outbound tags, see <A HREF="Using_Options.html#genOutAttr">here</A> for details</li>
   365         -<li>valueAttrCompatiblityMode - If this and genOutAttr/parseInAttr are set, then values are specified in the dictionary as {}.  Otherwise if genOutAttr/parseInAttr is set this is not set, then the values are specified in the dictionary as ::value.</li>
   366         -<li>useTypeNs - use type's namespace prefix as prefix of elements</li>
   367         -<li>nsOnChangeOnly - only put namespace prefix when namespaces change</li>
   368         -<li>suppressNS - do not put a particular namespace prefix</li>
          357  +<li><pre>allowOperOverloading</pre>
          358  +	<p>An overloaded operation is an operation with the same name but different  may exist with different input parameter sets.</p>
          359  +	<p>This option throws an error, if a WSDL is parsed with an overloaded operation.</p>
          360  +	Default: 1</li>
          361  +<li><pre>contentType</pre>
          362  +	The http content type of the http request sent to call the web service.<br />
          363  +	Default: "text/xml;charset=utf-8"</li>
          364  +<li><pre>errorOnRedefine</pre>
          365  +	Throw an error, if a service is created (CreateService etc) for an already existing service.<br />
          366  +	Default value: 0</li>
          367  +<li><pre>genOutAttr</pre>
          368  +	generate attributes on outbound tags, see <A HREF="Using_Options.html#genOutAttr">here</A> for details</li>
          369  +<li><pre>location</pre>
          370  +	The URL of the service. This is initialized on the value in the WSDL file, when the WSDL file is parsed. The value may be overwritten setting this option.</li>
          371  +<li><pre>noTargetNs</pre>
          372  +	The target namespace URI is normally included twice in the envelope of the webservice call:<br />
          373  +	<pre>
          374  +&lt;SOAP-ENV:Envelope
          375  +	...
          376  +	xmlns="http://targeturi.org/"
          377  +	xmlns:tns1="http://targeturi.org/"
          378  +	...&gt;
          379  +	</pre>
          380  +	Setting this option to 1 suppresses the line with "xmlns=".
          381  +	<br />This option was set to call a service published by SAP.
          382  +	<br />Default value: 0</li>
          383  +<li><pre>nsOnChangeOnly</pre>
          384  +	only put namespace prefix when namespaces change</li>
          385  +<li><pre>parseInAttr</pre>
          386  +	parse attributes on inbound tags, see <A HREF="Using_Options.html#parseInAttr">here</A> for details</li>
          387  +<li><pre>skipHeaderLevel</pre>
          388  +	boolean indicating the first level of the XML in a request header <i><b>shall be</b></i> skipped.  Derived from options.  Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
          389  +<li><pre>skipLevelOnReply</pre>
          390  +	boolean indicating the first level of the XML in a reply <i><b>may be</b></i> skipped.  Derived from options.  Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
          391  +<li><pre>skipLevelWhenActionPresent</pre>
          392  +	boolean indicating if the first level of the XML is to be skipped.  Derived from options.  Default is 0 (do not skip).</li>
          393  +<li><pre>suppressNS (default: empty string)</pre>
          394  +	do not put a particular namespace prefix</li>
          395  +<li><pre>suppressTargetNS</pre>
          396  +	<p>Do not add the Target Namespace URI prefix "tns1" to all parameters in the webservice call XML.</p>
          397  +	<p>As an example, the XML is modified from (option not set):
          398  +	<pre>
          399  +&lt;SOAP-ENV:Envelope ...
          400  +    xmlns:tns1="http://targeturi.org/"
          401  +    ... &gt;
          402  +  &lt;SOAP-ENV:Body&gt;
          403  +    &lt;tns1:CalledMethod&gt;
          404  +      &lt;tns1:Parameter1&gt;Value;/tns1:Parameter1&gt;
          405  +    &lt;/tns1:CalledMethod&gt;
          406  +  &lt;/SOAP-ENV:Body&gt;
          407  +&lt;/SOAP-ENV:Envelope&gt;
          408  +	</pre>
          409  +	to (option set)
          410  +	<pre>
          411  +&lt;SOAP-ENV:Envelope ...
          412  +    xmlns:tns1="http://targeturi.org/"
          413  +    ... &gt;
          414  +&lt;SOAP-ENV:Envelope ...
          415  +  &lt;SOAP-ENV:Body&gt;
          416  +    &lt;tns1:CalledMethod&gt;
          417  +      &lt;Parameter1&gt;Value;/Parameter1&gt;
          418  +    &lt;/tns1:CalledMethod&gt;
          419  +  &lt;/SOAP-ENV:Body&gt;
          420  +&lt;/SOAP-ENV:Envelope&gt;
          421  +	</pre>
          422  +	</p>
          423  +	Derived from options.
          424  +	<br />Internally, this option sets the option "suppressNS" to "tns1".
          425  +	<br />This option was set to call a service published by SAP.
          426  +	<br />This option made a call to a certain MS Web Service fail with the error message: "Input parameter 'Parameter1' can not be NULL or Empty.". 
          427  +	<br />Default is 0 (do not suppress).
          428  +	</li>
          429  +<li><pre>targetNamespace (default: empty string)</pre>
          430  +	the target namespace of the service, derived from the WSDL.</li>
          431  +<li><pre>UseNS (default: empty string)</pre>
          432  +	See <A HREF="Using_Options.html#UseNS">here</A>
          433  +	</li>
          434  +<li><pre>useTypeNS (default: empty string)</pre>
          435  +	use type's namespace prefix as prefix of elements</li>
          436  +<li><pre>valueAttrCompatiblityMode (default: 1)</pre>
          437  +	If this and genOutAttr/parseInAttr are set, then values are specified in the dictionary as {}.  Otherwise if genOutAttr/parseInAttr is set this is not set, then the values are specified in the dictionary as ::value.</li>
   369    438   </ul>
          439  +<pre>
   370    440        <i>value</i>         - Optional, the new value.
   371    441   </pre>
   372    442   <p><b>Returns&nbsp;:</b> </p><pre>     The value of the item.
   373    443   <p><b>Side-Effects&nbsp;: None</b> </p>
   374    444   <p><b>Exception Conditions&nbsp;&nbsp;: None</b> </p>
   375    445   <p><b>Pre-requisite Conditions&nbsp;: Service must have been defined.</b> </p></pre><p></p>
   376    446