queryReservationLocations( )


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 reservation locations.

The queryReservationLocations() function builds a query to retrieve a list of reservation locations and returns a ReservationLocationsQueryBuilder object.

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

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

queryReservationLocations() runs with the following ReservationLocationsQueryBuilder defaults, which you can override:

The following ReservationLocationsQueryBuilder functions are supported for queryReservationLocations(). For a full description of the reservation location object, see the object returned for the items property in ReservationLocationsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),in()
Permissions
Read Reservation Locations (Basic)
Read Reservation Locations (Full)
Manage Reservation Locations
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryReservationLocationsOptions

An object representing the available options for querying reservation locations.

Was this helpful?
Yes
No