getAPIVersion

The getAPIVersion method returns the API version of the Platform Administrative Web Services.

Request Parameters
None
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.


APIVersion


The API version in use.


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:getAPIVersion</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://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
		<wsa:Action>urn:getAPIVersionResponse</wsa:Action>
		<wsa:RelatesTo>uuid:26634481-3273-4a70-b537-ab4b874e4d6b</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getAPIVersionResponse xmlns:ns="http://server_url">
			<ns:return xsi:type="ax25:APIVersionResponse" xmlns:ax25="http://server_url/xsd" xmlns:ax26="http://server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
				<ax25:result>internal.request.complete</ax25:result>
				<ax25:APIVersion>5.0.2.0</ax25:APIVersion>
			</ns:return>
		</ns:getAPIVersionResponse>
	</soapenv:Body>
</soapenv:Envelope>