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

TypeNameDescription
integerBatchesMatchedTotal number of batches matched. (required)
integerBatchesReturnedNumber of batches returned in this result set. (required)
integerStartIndexThe starting index used (defaults to 0). (required)
integerLimitThe max number batches to return in each result set. (required)
BatchStatusBatchesAn array BatchStatus objects for the matched batches. (required)