getActiveVersion

The getActiveVersion method returns the active product version.

    • Note, as of v5.0.2.0 the key "Unrestricted" is added if the active version is unrestricted. This value should be replaced with the correct localized value. You can use APIVersionService to check which version you are using.

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


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


The product version number
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:getActiveVersion</wsa:Action>
		<wsa:MessageID>uuid:c37f60b9-92eb-4c1a-8de7-873b60adce19</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/VersionService .VersionServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<getActiveVersion 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:B8E556B192135F3CC31298997621402</wsa:MessageID>
		<wsa:Action>urn:getActiveVersionResponse</wsa:Action>
		<wsa:RelatesTo>uuid:455bc1c3-8267-4902-9e7e-8f47b6200ad1</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getActiveVersionResponse xmlns:ns="server_url">
			<ns:return xmlns:ax217="server_url/xsd" xmlns:ax218="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax217:VersionResponse">
				<ax217:remoteMessages xsi:nil="true"/>
				<ax217:result>internal.request.complete</ax217:result>
				<ax217:version>8.6.0.98000-9005</ax217:version>
			</ns:return>
		</ns:getActiveVersionResponse>
	</soapenv:Body>
</soapenv:Envelope>

The result in this case shows that the service is throttling.

  • Platform Administrative Web Services permit a maximum of three concurrent threads running.
  • Certain services are denied access based on the Platform API lock, before throttling can occur.
  • Throttled services wait for up to 60 seconds for the throttling semaphore.
  • If the timeout elapses, the service returns a result of internal.request.failed with a messageKey error.remote.throttled.

If too many Platform Administrative Web Services arrive at once, Platform Administrative Web Services throttle.

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


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


Boolean for the nil attribute value, true if no version number could be determined, or the version number
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:getActiveVersion</wsa:Action>
		<wsa:MessageID>uuid:c37f60b9-92eb-4c1a-8de7-873b60adce19</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/VersionService .VersionServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<getActiveVersion 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:E4F05C2A76D78B5EEB1301499080974</wsa:MessageID>
		<wsa:Action>urn:getActiveVersionResponse</wsa:Action>
		<wsa:RelatesTo>uuid:ec12b570-6066-41d1-a0ff-506401a3302f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getActiveVersionResponse xmlns:ns="server_url">
			<ns:return xmlns:ax217="server_url/xsd" xmlns:ax218="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax217:VersionResponse">
				<ax217:remoteMessages xsi:type="ax217:RemoteMessage">
					<ax218:error>true</ax218:error>
					<ax218:info>false</ax218:info>
					<ax218:messageKey>error.remote.throttled</ax218:messageKey>
					<ax218:messageType>internal.message.error</ax218:messageType>
					<ax218:warning>false</ax218:warning>
				</ax217:remoteMessages>
				<ax217:result>internal.request.failed</ax217:result>
				<ax217:version xsi:nil="true"/>
			</ns:return>
		</ns:getActiveVersionResponse>
	</soapenv:Body>
</soapenv:Envelope>

getInActiveVersion

The getInActiveVersion method returns the inactive product version.

    • Note, as of v5.0.2.0 the key "Unrestricted" is added if the active version is unrestricted. This value should be replaced with the correct localized value. You can use APIVersionService to check which version you are using.

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


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


The inactive product version number
Example Request and Response
Request Response 
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn: getInactiveVersion</wsa:Action>
		<wsa:MessageID>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:MessageID>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:To></wsa:To>
	</soapenv:Header>
	<soapenv:Body>
		<getInactiveVersion xmlns="http://services.api.platform.vos.cisco.com"/>
	</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://www.w3.org/2005/08/addressing/anonymous</wsa:To>
		<wsa:MessageID>urn:uuid:1f248579-20e4-452f-ac40-a4e2cfea5fb7</wsa:MessageID>
		<wsa:Action>urn:getInactiveVersionResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getInactiveVersionResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax221="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax222="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax221:VersionResponse">
				<ax221:remoteMessages xsi:nil="true" />
				<ax221:result>internal.request.complete</ax221:result>
				<ax221:version></ax221:version>
			</ns:return>
		</ns:getInactiveVersionResponse>
	</soapenv:Body>
</soapenv:Envelope>