queryAttendance( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a query to retrieve a list of attendances.

The queryAttendances() function builds a query to retrieve a list of attendances and returns a AttendancesQueryBuilder object.

The returned object contains the query definition, which is typically used to call the query using the find() function.

You can refine the query by chaining AttendancesQueryBuilder functions onto the query. AttendancesQueryBuilder functions enable you to sort, filter, and control the results that queryAttendances() returns.

queryAttendances() uses the following AttendancesQueryBuilder default values that you can override:

  • limit is 50.
  • Sorted by id in ascending order.

The functions that are chained to queryAttendances() are applied in the order they are called. For example, if you apply ascending("status") and then ascending("numberOfAttendees"), the results are sorted first by the "status", and then, if there are multiple results with the same "status", the items are sorted by "numberOfAttendees".

The following AttendancesQueryBuilder functions are supported for the queryAttendances() function. For a full description of the tip settings object, see the object returned for the items property in AttendancesQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),in(),ascending()
bookingIdeq(),ne(),in(),ascending()
sessionIdeq(),ne(),in(),ascending()
statuseq(),ne(),in(),ascending()
numberOfAttendeeseq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
Permissions
Manage Bookings Services and Settings
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Including Participants
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Did this help?