getActiveOptions

The getActiveOptions method returns the options installed on the active partition.

Request Parameters
None

This method returns a result that shows there are no options installed.

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)
options


xsi:nil="true" "True" if no options are installed, "false" if options are installed.
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:getActiveOptions</wsa:Action>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:MessageID>uuid:50e3c2ac-fc4e-45ab-9f98-58907619649b</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://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://server/servlet/WSACallBackHandler</wsa:To>
		<wsa:MessageID>urn:uuid:4F8DCF8A8A3428F84D1297118397075</wsa:MessageID>
		<wsa:Action>urn:getActiveOptionsResponse</wsa:Action>
		<wsa:RelatesTo>uuid:6a81599c-5813-4465-a777-c6b83c69ad11</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getActiveOptionsResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax29="server_url/xsd" xmlns:ax210="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax29:OptionsResponse">
				<ax29:remoteMessages xsi:nil="true"/>
				<ax29:result>internal.request.complete</ax29:result>
				<ax29:options xsi:nil="true"/>
			</ns:return>
		</ns:getActiveOptionsResponse>
	</soapenv:Body>
</soapenv:Envelope>

This method returns a result that shows there are options installed.

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)
options


    • display name - Name of the installed software option
    • name - Deprecated field
    • version - software version of named option
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:getInactiveOptions</wsa:Action>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:MessageID>uuid:af4f0eb9-44bb-4fb9-8f8d-fa8001e7dab3</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:getInactiveOptionsResponse</wsa:Action>
		<wsa:RelatesTo>uuid:af4f0eb9-44bb-4fb9-8f8d-fa8001e7dab3</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getInactiveOptionsResponse xmlns:ns="server_url.com">
			<ns:return xmlns:ax29="server_url/xsd" xmlns:ax210="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax29:OptionsResponse">
				<ax29:remoteMessages xsi:nil="true"/>
				<ax29:result>internal.request.complete</ax29:result>
				<ax29:options xsi:nil="true"/>
			</ns:return>
		</ns:getInactiveOptionsResponse>
	</soapenv:Body>
</soapenv:Envelope>

getInactiveOptions

The getInactiveOptions method returns options installed on the inactive partition.

Request Parameters
None

This result shows there are no options installed on the inactive partition.

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)
options


xsi:nil="true" "True" if no options are installed, "false" if options are installed.
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:getInactiveOptions</wsa:Action>
                                                 <wsa:ReplyTo>
                                                      <wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
                                                 </wsa:ReplyTo>
                                                  <wsa:MessageID>uuid:af4f0eb9-44bb-4fb9-8f8d-fa8001e7dab3</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:getInactiveOptionsResponse</wsa:Action>
                                              <wsa:RelatesTo>uuid:af4f0eb9-44bb-4fb9-8f8d-fa8001e7dab3</wsa:RelatesTo>
                                       </soapenv:Header>
                                       <soapenv:Body>
                                          <ns:getInactiveOptionsResponse xmlns:ns="server_url.com">
                                             <ns:return xmlns:ax29="server_url/xsd" xmlns:ax210="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax29:OptionsResponse">
                                                  <ax29:remoteMessages xsi:nil="true"/>
                                                  <ax29:result>internal.request.complete</ax29:result>
                                                  <ax29:options xsi:nil="true"/>
                                             </ns:return>
                                          </ns:getInactiveOptionsResponse>
                                       </soapenv:Body>
                                   </soapenv:Envelope>