SOAP_HEADER( header-key [, index, header-attribute ] )

LONG VARCHAR

This function may be used with a single parameter header-key to return a header entry. A header entry is an XML string representation of an element, and all its sub-elements, contained within a SOAP header.

This function may also be used to extract a header entry attribute by specifying the optional index and header-attribute parameters.

This function returns the value of the named SOAP header field, or NULL if not called from a SOAP service. It is used when processing a SOAP request via a web service.

If a header for the given header-key does not exist, the return value is NULL.

• NEXT_SOAP_HEADER function [SOAP]
• sa_set_soap_header system procedure
• Tutorial: Using SQL Anywhere to access a SOAP/DISH service
• Web services functions
• Web services system procedures

When used within a stored procedure that is called by an HTTP web service, the following example processes all the keys located in the SOAP request header. When it processes the Authentication key, it also obtains the key's value.

BEGIN
  DECLARE hd_key LONG VARCHAR;
  DECLARE hd_entry LONG VARCHAR;
header_loop:
  LOOP
    SET hd_key = NEXT_SOAP_HEADER( hd_key );
    IF hd_key IS NULL THEN
      -- no more header entries
      LEAVE header_loop;
    END IF;
    IF hd_key = 'Authentication' THEN
      SET hd_entry = SOAP_HEADER( hd_key );
    END IF;
  END LOOP header_loop;
END;