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