getInstalledProducts

The getInstalledProducts method returns the deployed products.

Request Parameters
None
Response Parameters (return element children
result


A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.
remoteMessages


If xsi:nil="true" then there are no remote messages. Otherwise:

  • error - Boolean, true if an error occurred, false otherwise
  • info - Boolean
  • messageKey - A result code such as internal.request.denied.lock if such an error occurred
  • messageType - The type of error, such as internal.message.error
  • warning - Boolean, true if this is a warning, false if not
  • messageParams - Information about the message (there can be more than one messageParam)
installedProducts


    • displayName - The name of the product as displayed
    • name - The name of the product if different from the display name.
    • version - The product's version number.
    • adminUrl - URL of the product's admin GUI
    • id - the product ID
Example Request and Response
Request Response
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<SOAP-ENV:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn:getInstalledProducts</wsa:Action>
		<wsa:MessageID>uuid:2fe9a853-08b2-4390-9929-317711651d61</wsa:MessageID>
		<wsa:ReplyTo>
			<wsa:Address>http://server/servlet/WSACallBackHandler</wsa:Address>
			<wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType>
		</wsa:ReplyTo>
		<wsa:To>https://server/platform-services/services/ProductService. ProductServiceHttpSoap11Endpoint/</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<getInstalledProducts xmlns="server_url"/>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
									
								
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://server/servlet/WSACallBackHandler</wsa:To>
		<wsa:MessageID>urn:uuid:4F8DCF8A8A3428F84D1297119470696</wsa:MessageID>
		<wsa:Action>urn:getInstalledProductsResponse</wsa:Action>
		<wsa:RelatesTo>uuid:c1e22940-cd4e-4afe-9ef7-dee5fc5e135d</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getInstalledProductsResponse xmlns:ns="server_url">
			<ns:return xmlns:ax268="server_url/xsd" xmlns:ax267="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax267:ProductResponse">
				<ax267:remoteMessages xsi:nil="true"/>
				<ax267:result>internal.request.complete</ax267:result>
				<ax267:installedProducts xsi:type="ax267:InstalledProduct">
					<ax267:displayName>Cisco Unified Communications Manager</ax267:displayName>
					<ax267:name/>
					<ax267:version>8.6.0.96000-9006</ax267:version>
					<ax267:adminUrl>ccmadmin/showHome.do</ax267:adminUrl>
					<ax267:id>CallManager</ax267:id>
				</ax267:installedProducts>
			</ns:return>
		</ns:getInstalledProductsResponse>
	</soapenv:Body>
</soapenv:Envelope>
									
								

getProductName

The getProductName method returns the overall product name.

Request Parameters
None
Response Parameters (return element children
result


A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.
remoteMessages


If xsi:nil="true" then there are no remote messages. Otherwise:

  • error - Boolean, true if an error occurred, false otherwise
  • info - Boolean
  • messageKey - A result code such as internal.request.denied.lock if such an error occurred
  • messageType - The type of error, such as internal.message.error
  • warning - Boolean, true if this is a warning, false if not
  • messageParams - Information about the message (there can be more than one messageParam)
productName


The overall product name
Example Request and Response
Request Response
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
		<wsa:Action>urn:getProductName</wsa:Action>
		<wsa:ReplyTo>
			<wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:MessageID>uuid:5eda82c3-eb40-4b8d-87b4-f7407bb2fb14</wsa:MessageID>
	</soapenv:Header>
	<soapenv:Body/>
</soapenv:Envelope>
									  
								
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
		<wsa:Action>urn:getProductNameResponse</wsa:Action>
		<wsa:RelatesTo>uuid:5eda82c3-eb40-4b8d-87b4-f7407bb2fb14</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getProductNameResponse xmlns:ns="server_url">
			<ns:return xsi:type="ax269:ProductNameResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax270="server_url/xsd" xmlns:ax269="server_url/xsd">
				<ax269:remoteMessages xsi:nil="true"/>
				<ax269:result>internal.request.complete</ax269:result>
				<ax269:productName>Cisco Unified Communications Manager</ax269:productName>
			</ns:return>
		</ns:getProductNameResponse>
	</soapenv:Body>
</soapenv:Envelope>