switchVersions
This switchVersions method switches the running software version to the upgrade version.
Request Parameters
None
This result indicates there is no inactive version.
Response Parameters (return element children)
remoteMessages
error - Boolean: true, message is an error message, false it is not
info - Boolean: true,message is an informational message, false it is not
messageKey - identifies info, warning or error message
messageType - identifies messagekey as info, warning, or error
warning - Boolean: true,message is a warning message, false it is not
messageParams - identifies messagekey parameters
info - Boolean: true,message is an informational message, false it is not
messageKey - identifies info, warning or error message
messageType - identifies messagekey as info, warning, or error
warning - Boolean: true,message is a warning message, false it is not
messageParams - identifies messagekey parameters
result
internal.request.failed - request call 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> <wsa:Action xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> urn:switchVersions</wsa:Action> <wsa:MessageID xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> uuid:b04cfe9e-2f77-4eed-b150-805e3ba6980d</wsa:MessageID> <wsa:ReplyTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> <wsa:Address>http://server/servlet/WSACallBackHandler </wsa:Address> <wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType> </wsa:ReplyTo> <wsa:To xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">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)
remoteMessages
error - Boolean, true, message is an error message, false it is not
info - Boolean: true,message is an informational message, false it is not
messageKey - identifies info, warning or error message
messageType - identifies messagekey as info, warning, or error
warning - Boolean: true,message is a warning message, false it is not
messageParams - identifies messagekey parameters
info - Boolean: true,message is an informational message, false it is not
messageKey - identifies info, warning or error message
messageType - identifies messagekey as info, warning, or error
warning - Boolean: true,message is a warning message, false it is not
messageParams - identifies messagekey parameters
result
A result code such as internal.request.complete that describes the result. See Error Codes in the
Developer's Guide for details.
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> <wsa:Action xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> urn:switchVersions</wsa:Action> <wsa:MessageID xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> uuid:b04cfe9e-2f77-4eed-b150-805e3ba6980d</wsa:MessageID> <wsa:ReplyTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> <wsa:Address>http://server/servlet/WSACallBackHandler </wsa:Address> <wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType> </wsa:ReplyTo> <wsa:To xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">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>