addSOAPResponseHeader

Adds a SOAP response header to a web service response. Call only from within a CFC web service function that is processing a request as a SOAP web service.

addSOAPResponseHeader(namespace, name, value [, mustUnderstand]) → returns boolean

  1. CFDocs
  2. Functions
  3. All CFML Functions
  4. addSOAPResponseHeader
  5. CF7+
  6. Lucee
  7. BD
  8. 0 Issue
  9. Edit
See Also:   getSOAPResponseHeader   getSOAPResponse

Argument Reference

namespace string
Required

A webservice object as returned from the cfobject tag or the createobject function

name string
Required

Name of the SOAP header

value string
Required

Value of the SOAP header

mustUnderstand boolean

The mustUnderstand attribute indicates whether processing of the header is optional or mandatory.
This basically translates to the node trying to find an appropriate handler that matches the header
and proceed with processing the message in a manner consistent with its specification. If it can't find an appropriate handler
it must return an error and stop further processing. If mustUnderstand is set to true
the node is not allowed to ignore it.

Examples
Sample code invoking the addSOAPResponseHeader function 

ws = createObject("webservice", "http://localhost/soapheaders/headerservice.cfc?WSDL");
addSOAPRequestHeader(ws, "http://mynamespace/", "username", "tom", false);
ret = ws.echo_me("argument");
header = getSOAPResponseHeader(ws, "http://www.tomj.org/myns", "returnheader"); 
XMLheader = getSOAPResponseHeader(ws, "http://www.tomj.org/myns", "returnheader", true);

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub