Element: getConsolidatedFulfillmentsQueryRequest

Description

A getConsolidatedFulfillmentsQueryRequest message contains an element of getConsolidatedFulfillmentsQueryRequestType.

Derived By

Type getConsolidatedFulfillmentsQueryRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
queryParams	consolidatedFulfillmentsQPType	0..1	Required. See consolidatedFulfillmentsQPType.
pageNumber	integer	1..1	Required. Starts at 1. Say the getConsolidatedFulfillmentCount 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.
includeLicenseText	boolean	0..1	Optional. Whether to include the entire text of the consolidated license(s) in the response. Default is true.

Referenced By

Name	Type
getConsolidatedFulfillmentsQuery	Method

XML Example

The following XML fragment illustrates a getConsolidatedFulfillmentsQueryRequest message:

<getConsolidatedFulfillmentsQueryRequest>
   <queryParams>
      <consolidatedLicenseId>
         <value>CID</value>
         <searchType>STARTS_WITH</searchType>
      </consolidatedLicenseId>
      <soldTo>
         <value>ACME</value>
         <searchType>EQUALS</searchType>
      </soldTo>
   </queryParams>
   <pageNumber>1</pageNumber>
   <batchSize>30</batchSize>
   <includeLicenseText>true</includeLicenseText>
</getConsolidatedFulfillmentsQueryRequest>