---

login

Provides the administrative credentials for a stateful session. While the client maintains the HTTP session, credentials are not required in subsequent SOAP messages.

SOAP Message

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

Element Descriptions 

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

Contains these elements:

<credentials>
<locale>

<credentials xmlns="">

Provides the credentials for the Oracle SES administrator. It contains these 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

Example

This example provides the credentials for a stateful session:

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

This is the service response:

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