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. (required)

integer

BatchesReturned

Number of batches returned in this result set. (required)

integer

StartIndex

The starting index used (defaults to 0). (required)

integer

Limit

The max number batches to return in each result set. (required)

BatchStatus

Batches

An array BatchStatus objects for the matched batches. (required)