switchVersions

The switchVersions method switches the running software version to the upgrade version. It activates and boots the inactive partition.

This service will restart the server; an asynchronous response is not guaranteed.

Request Parameters
None

This result indicates there is no inactive version.

Response Parameters (return element children)
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.
If internal.request.failed - see messageKey child of remoteMessages for cause of failure
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:switchVersions</wsa:Action>
		<wsa:MessageID>uuid:b04cfe9e-2f77-4eed-b150-805e3ba6980d</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/SwitchVersionService.SwitchVersionServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<switchVersions 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:BAFCD8D75A4A7146AE1299252260996</wsa:MessageID>
		<wsa:Action>urn:switchVersionsResponse</wsa:Action>
		<wsa:RelatesTo>uuid:66ab1659-7644-4baa-bf9d-381511f03dc4</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:switchVersionsResponse xmlns:ns="server_url">
			<ns:return xmlns:ax256="server_url/xsd" xmlns:ax255="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax255:SwitchVersionResponse">
				<ax255:remoteMessages xsi:type="ax255:RemoteMessage">
					<ax256:error>true</ax256:error>
					<ax256:info>false</ax256:info>
					<ax256:messageKey>error.version.inactive.notavailable</ax256:messageKey>
					<ax256:messageType>internal.message.error</ax256:messageType>
					<ax256:warning>false</ax256:warning>
				</ax255:remoteMessages>
				<ax255:result>internal.request.failed</ax255:result>
			</ns:return>
		</ns:switchVersionsResponse>
	</soapenv:Body>
</soapenv:Envelope>

The result indicates the switch was successful.

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.
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:switchVersions</wsa:Action>
		<wsa:MessageID>uuid:b04cfe9e-2f77-4eed-b150-805e3ba6980d</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/SwitchVersionService.SwitchVersionServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<switchVersions 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:BF1C7434AEA69934961297103225543</wsa:MessageID>
		<wsa:Action>urn:switchVersionsResponse</wsa:Action>
		<wsa:RelatesTo>uuid:2fab2b5e-747e-4420-9552-d5fc17eab05e</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:switchVersionsResponse xmlns:ns="server_url">
			<ns:return xmlns:ax256="server_url/xsd" xmlns:ax255="server_url/xsd" type="server_url.SwitchVersionResponse">
				<ax255:result>internal.request.complete</ax255:result>
			</ns:return>
		</ns:switchVersionsResponse>
	</soapenv:Body>
</soapenv:Envelope>