3.1.4.1 EnumerateDatabases

  • Article

This operation is used by the protocol client to retrieve the list of all the Lotus Notes databases in a Domino server.

If the value of lastSeenDatabase element is an empty string, this operation MUST return all the Lotus Notes databases in the Domino server.

If the value of lastSeenDatabase element is the value of the DATABASEITEMID.databaseId element, this operation MUST return all the Lotus Notes databases in the Domino server whose databaseId is greater than DATABASEITEMID.databaseId.

The following is the WSDL port type specification of the EnumerateDatabases WSDL operation.

 <wsdl:operation name="EnumerateDatabases" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://tempuri.org/INotesWebServiceApplication/EnumerateDatabases" message="tns:INotesWebServiceApplication_EnumerateDatabases_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://tempuri.org/INotesWebServiceApplication/EnumerateDatabasesResponse" message="tns:INotesWebServiceApplication_EnumerateDatabases_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends an INotesWebServiceApplication_EnumerateDatabases_InputMessage (section 3.1.4.1.1.1) request message, and the protocol server responds with an INotesWebServiceApplication_EnumerateDatabases_OutputMessage (section 3.1.4.1.1.2) response message, as follows.

  • On success, the protocol server MUST return the list of Lotus Notes databases in the Domino server.

  • On error, the protocol server MUST send a FaultException<ExceptionDetail> message to the protocol client.