Element: getUsersQueryRequest

Description

A getUsersQueryRequest message contains an element of getUsersQueryRequestType.

Derived By

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
queryParams	userQueryParametersType	0..1	Required. See userQueryParametersType. Leave this element blank to return all users.
pageNumber	integer	1..1	Required. Starts at 1. Say the getUsersQuery operation using the same query parameters returns 100 records. If the batch size is 50 records and you want the second batch of 50, set pageNumber to 2.
batchSize	integer	1..1	Required. Maximum number of records to return in the response.

Referenced By

Name	Type
getUsersQuery	Method

XML Example

The following XML fragment illustrates a getUsersQueryRequest message, querying by display name, last modified date/time, and account type:

<getUsersQueryRequest>
     <queryParams>
          <displayName>
               <value>john</value>
               <searchType>CONTAINS</searchType>
          </displayName>
          <lastModifiedDateTime>
               <value>2011-05-04T22:00:00</value>
               <searchType>AFTER</searchType>
         </lastModifiedDateTime>
         <accountType>PUBLISHER</accountType>
     </queryParams>
     <pageNumber>1</pageNumber>
     <batchSize>10</batchSize>
</getUsersQueryRequest>