developer:soap:objects:batchsearchresult

Soap API v1.2

BatchSearchResult

Contains results of a batch search.

Description

This object is returned by the searchBatches method. It describes the result of the search, including the total number of batches matched, the number being returned, and an array of BatchStatus objects

Properties

Type Name Description
integer BatchesMatched Total number of batches matched
integer BatchesReturned Number of batches returned in this result set
integer StartIndex The starting index used (defaults to 0)
integer Limit The max number batches to return in each result set.
BatchStatus Batches An array BatchStatus objects for the matched batches

Places Used

Examples

developer/soap/objects/batchsearchresult.txt · Last modified: 2009/10/23 21:37 by tem

Page Tools