---

getAPIVersion

Returns the version number of the Oracle SES Administration API.

SOAP Message

<getAPIVersion xmlns="http://search.oracle.com/Admin">
   <credentials xmlns="">
      <password>
      <userName>
   <locale xmlns="">

Element Descriptions 

<getAPIVersion xmlns="http://search.oracle.com/Admin">

Contains these elements:

<credentials>
<locale>

<credentials xmlns="">

Provides the credentials for the Oracle SES administrator. Credentials are required only when the session is stateless. See "Providing Credentials".

This element contains these child elements:

<password>
<userName>

<password>

Contains the password for <userName>.

<userName>

Contains the user name of the Oracle SES administrator.

<locale xmlns="">

Sets the language for error messages. See Table 2-2, "Product Languages" for a list of valid codes.

If you omit this element or enter an invalid code, then Oracle SES uses the default locale of the system where it is running.

SOAP Faults

AdminAPIRuntimeFault
InvalidInputFault

Example

This example requests the version number of the API:

<getAPIVersion xmlns="http://search.oracle.com/Admin"/>

The service response contains the version number:

<ns2:getAPIVersionResponse xmlns:ns2="http://search.oracle.com/Admin">
   <return>11.2.2.0.0</return>
</ns2:getAPIVersionResponse>

<ns2:getAPIVersionResponse xmlns:ns2="http://search.oracle.com/Admin">
   <version>11.2.2.0.0</version>
</ns2:getAPIVersionResponse>