Element: getUniformSuitesQueryRequest

Description

A getUniformSuitesQueryRequest message contains an element of getUniformSuitesQueryRequestType.

Derived By

Type getUniformSuitesQueryRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
queryParams	suiteQueryParametersType	0..1	Required. See suiteQueryParametersType. Leave this element blank to return all suites.
pageNumber	integer	1..1	Required. Starts at 1. Say the getUniformSuiteCount 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.
returnContainedObjects	boolean	1..1	Required. If true, return arrays of elements that are contained in the suite.

Referenced By

Name	Type
getUniformSuiteQuery	Method

XML Example

The following XML fragment illustrates a getUniformSuitesQueryRequest message:

<getUniformSuitesQueryRequest>
   <queryParams>
      <suiteName>
         <value>S10</value>
         <searchType>EQUALS</searchType>
      </suiteName>
      <version>
         <value>1.0</value>
         <searchType>EQUALS</searchType>
      </version>
   </queryParams>
   <pageNumber>1</pageNumber>
   <batchSize>10</batchSize>
   <returnContainedObjects>false</returnContainedObjects>
</getUniformSuitesQueryRequest>