deal APIv1.3.0

EventSearchResponse

The result set for the specified event search criteria.

Types that use EventSearchResponse

Not used by any types

Call that uses EventSearchResponse

Fields

Field
Type
Description
events
array of Event
A list of results that match the search criteria.
href
The relative path to the current set of results.
limit
The maximum number of items, from the current result set, returned on a single page.

Default: 20
next
The relative path to the next set of results.
offset
The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output.

For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned.

Default: 0
prev
The relative path to the previous set of results.
total
The total number of matches for the specified search criteria.