queryLocations( )

Creates a query to retrieve a list of locations.

The queryLocations() function builds a query to retrieve a list of up to 1,000 locations and returns a LocationsQueryBuilder object.

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

You can refine the query by chaining LocationsQueryBuilder functions onto the query. LocationsQueryBuilder functions enable you to sort, filter, and control the results that queryLocations() returns. The functions that are chained to queryLocations() are applied in the order they are called.

queryLocations() runs with the following LocationsQueryBuilder defaults that you can override:

• skip: 0
• limit: 50

The following QueryLocationsBuilder functions are supported for the queryLocations() function. For a full description of the Locations object, see the object returned for the items property in LocationsQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
_id	eq(),ne(),exists(),in(),hasSome(),startsWith()
name	eq(),ne(),exists(),in(),hasSome(),startsWith()
description	eq(),ne(),exists(),in(),hasSome(),startsWith()
default	eq(),ne(),exists(),in(),hasSome()
status	eq(),ne(),exists(),in(),hasSome()
locationType	eq(),ne(),exists(),in(),hasSome()
fax	eq(),ne(),exists(),in(),hasSome(),startsWith()
timeZone	eq(),ne(),exists(),in(),hasSome(),startsWith()
email	eq(),ne(),exists(),in(),hasSome(),startsWith()
phone	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.country	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.subdivision	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.city	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.postalCode	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.streetAddress.number	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.streetAddress.name	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.streetAddress.apt	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.formattedAddress	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.hint	eq(),ne(),exists(),in(),hasSome(),startsWith()
address.geocode.latitude	eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge()
address.geocode.longitude	eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge()
businessSchedule.periods.openDay	eq(),ne(),exists(),in(),hasSome()
businessSchedule.periods.openTime	eq(),ne(),exists(),in(),hasSome(),startsWith()
businessSchedule.periods.closeDay	eq(),ne(),exists(),in(),hasSome()
businessSchedule.periods.closeTime	eq(),ne(),exists(),in(),hasSome(),startsWith()
businessSchedule.specialHourPeriod.startDate	eq(),ne(),exists(),in(),hasSome(),startsWith()
businessSchedule.specialHourPeriod.endDate	eq(),ne(),exists(),in(),hasSome(),startsWith()
businessSchedule.specialHourPeriod.isClosed	eq(),ne(),exists(),in(),hasSome()
businessSchedule.specialHourPeriod.comment	eq(),ne(),exists(),in(),hasSome(),startsWith()
revision	eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge()
archived	eq(),ne(),exists(),in(),hasSome()