Bookshelf Home | Contents | Index | PDF     

Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Service API Calls >

LoginHistoryQueryPage

Executes a query against the list of user login history, and returns a subset of the records that match the search criteria set by the method arguments.

Usage

You use the LoginHistoryQueryPage method to view the Login History for a user. This is the same information that is displayed in the Company Administration, Sign In Audit page in the Oracle CRM On Demand application. As an example of how you might use this data, you might save the data in a CSV file and then import it into a spreadsheet. You could then use the spreadsheet to generate a report showing, for example, how often a user logs into Oracle CRM On Demand.

Arguments

Table 58 describes the arguments taken by the LoginHistoryQueryPage method.

Table 58. Arguments Taken by the LoginHistoryQueryPage Method
Name
Description
Required
Default
I/O

ListOfLoginHistory

The list of object instances queried (input), and after query execution, the list of object instances returned (output).

Yes

Not applicable

Input/Output

PageSize

The maximum number of records displayed on a page following a query.

No

10

Input

StartRowNum

Indicates the row from which the LoginHistoryQueryPage method starts to return records. Use the StartRowNum argument to return a set of records for any given method.

For example, if PageSize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query.

No

0

Input

LastPage

A value that indicates whether or not the last value in the query set has been returned.

Not applicable

Not applicable

Output

Return Value of the Call

The following information is returned for each usage record.

A list of user login history. The following are the child elements of ListOfLoginHistory:

  • UserId. The user ID of the user.
  • FirstName. The user's first name.
  • LastName. The user's last name.
  • UserAlias. The user alias of the user.
  • LoginName. The login name for the user.
  • LoginStatus. The login status for the user.
  • LoginTimestamp. The time at which the user last logged in.
  • ClientType. The type of client from which the user logged in.
  • IPAddress. The source IP address for the user.
  • AdditionalInformation. Additional information for the user.
  • LogoutTimestamp. The time at which the user last logged out.

Sample SOAP Request - LoginHistoryQueryPage

The following SOAP request queries against the list of user login history to return a login record that occurred after the timestamp of 08/01/2011 00:00:00. It also demonstrates the use of the optional <PageSize> and <StartRowNum> arguments to return one record at row 1 (second record).

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <soap:Header>

      <wsse:Security>

         <wsse:UsernameToken>

            <wsse:Username>%%%USERNAME%%%</wsse:Username>

            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>

         </wsse:UsernameToken>

      </wsse:Security>

   </soap:Header>

   <soap:Body>

      <LoginHistoryWS_LoginHistoryQueryPage_Input xmlns="urn:crmondemand/ws/loginhistory/">

         <ListOfLoginHistory>

            <LoginHistory>

               <UserId />

               <FirstName />

               <LastName />

               <UserAlias />

               <LoginName />

               <LoginStatus />

               <LoginTimestamp>&gt;='08/01/2011 00:00:00'</LoginTimestamp>

               <ClientType />

               <IPAddress />

               <AdditionalInformation />

               <LogoutTimestamp />

            </LoginHistory>

         </ListOfLoginHistory>

         <PageSize>1</PageSize>

         <StartRowNum>1</StartRowNum>

      </LoginHistoryWS_LoginHistoryQueryPage_Input>

   </soap:Body>

</soap:Envelope>

Sample SOAP Response

The following response contains the requested login history:

<?xml version="1.0" encoding="utf-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <SOAP-ENV:Body>

      <ns:LoginHistoryWS_LoginHistoryQueryPage_Output xmlns:ns="urn:crmondemand/ws/loginhistory/">

         <ns:LastPage>false</ns:LastPage>

         <ListOfLoginHistory xmlns="urn:/crmondemand/xml/loginhistory">

            <LoginHistory>

               <UserId>HRZ780-I5RUE</UserId>

               <FirstName>Joanne</FirstName>

               <LastName>Brown</LastName>

               <UserAlias>Joanne Brown</UserAlias>

               <LoginName>%%%USERNAME%%%</LoginName>

               <LoginStatus>Success</LoginStatus>

               <LoginTimestamp>08/02/2011 13:53:00</LoginTimestamp>

               <ClientType>WS</ClientType>

               <IPAddress>10.156.87.45</IPAddress>

               <AdditionalInformation></AdditionalInformation>

               <LogoutTimestamp>08/02/2011 13:59:00</LogoutTimestamp>

            </LoginHistory>

         </ListOfLoginHistory>

      </ns:LoginHistoryWS_LoginHistoryQueryPage_Output>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

    
Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37) Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.