getUpgradeType

The getUpgradeType method returns the type of the current upgrade.

This service should only be called after the upgrade has started.

Request Parameters
None
Response Parameters (return element children) Validated
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)
result


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


Type of the current upgrade as follows:
L2 - Standard UC Application upgrade
RU - Refresh upgrade required for certain major OS changes (e.g. - migrating from a 32 bit to a 64 bit OS)
Example Request and Response
Request Response 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
		<wsa:Action>urn:getUpgradeType</wsa:Action>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:MessageID>uuid:26634481-3273-4a70-b537-ab4b874e4d6b</wsa:MessageID>
	</soapenv:Header>
	<soapenv:Body/>
</soapenv:Envelope>

								
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
	<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
		<wsa:Action>urn:getUpgradeTypeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:a8804cc2-0e60-4e44-9cab-6acb1c3f3fc9</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getUpgradeTypeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
		<ns:return xsi:type="ax229:UpgradeTypeResponse" xmlns:ax229="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax230="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
		<ax229:remoteMessages xsi:nil="true"/>
		<ax229:result>internal.request.complete</ax229:result>
		<ax229:upgradeType>L2</ax229:upgradeType>
		</ns:return>
		</ns:getUpgradeTypeResponse>
	</soapenv:Body>
</soapenv:Envelope>