Using the SOAP API

CICS® Configuration Manager clients communicate with the server by exchanging Simple Object Application Protocol (SOAP) 1.1 messages via Hypertext Transfer Protocol (HTTP) sockets. You can use the CICS Configuration Manager SOAP application programming interface (API) to develop your own client for CICS Configuration Manager.

Figure 1. The CICS Configuration Manager server and its clients exchange SOAP messages

A SOAP message is an XML document that contains application-specific elements inside standard "envelope" elements. Here, the "application-specific" elements are the CICS Configuration Manager API. A client sends a SOAP message containing a request to perform an API command; the server returns a SOAP message containing the response.

Figure 2 and Figure 3 show the general format of these SOAP messages. This API reference describes the body of the messages. For more information about SOAP and its envelope elements, see the specification at http://www.w3.org/TR/soap11/.

Tip: To see the XML of the request and response messages while using the CICS Configuration Manager ISPF dialog interface, open the Settings pull-down menu and set XML print on.

The CICS Configuration Manager server listens for API command requests on the following uniform resource locator (URL):

http://hostname:port/CICS/CWBA/CCVWSDSH/CCVADISP

where hostname is the name of your z/OS host and port is the port number. (If you specify an SSL port number, then specify the protocol as https instead of http.)

Figure 2. Request: SOAP message from client to server
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header SOAP-ENV:mustUnderstand="no"/>
  <SOAP-ENV:Body>
 
    <CCV510>
      <API_command_name>
        Input for this command…
      </API_command_name>
    </CCV510>
 
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Figure 3. Response: SOAP message from server to client
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header SOAP-ENV:mustUnderstand="no"/>
  <SOAP-ENV:Body>
 
    <CCV510>
      <API_command_name>
        <OutputData>
          Output for this command…
        </OutputData>
      </API_command_name>
    </CCV510>
 
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Information Information

Feedback


Timestamp icon Last updated: Friday, 8 February 2013


http://pic.dhe.ibm.com/infocenter/cicsts/v5r1/topic//ccv-api.htm