address

String

Free-form address used to find a location.

city

String

When provided with state, both are used to find a location.

state

String

When provided with city, both are used to find a location.

postalCode

String

Postal code used to find a location.

latitude

double

If another input method, such as postalCode, is used, the value returned by the GeoLocatorService is used for latitude.

longitude

double

If another input method, such as postalCode, is used, the value returned by the GeoLocatorService is used for longitude.

countryCode

String

If provided along with language, is used to create a Locale for the geo-location query. If not provided, the request’s locale is used.

language

String

If provided along with countryCode, is used to create a Locale for the geo-location query. If not provided, the request’s locale is used.

siteIds

Collection

IDs by which to constrain the results.

siteScope

String

Site scope by which to constrain the results. A site scope can be:

current – Results are restricted to current sites
any – Results are filtered to items that have at least one site
all – Results are not filtered by site
none – Results include items that have no site memberships

isIncludeInactiveSites

Runs the filter on all sites, including inactive sites.

isIncludeDisabledSites

Runs the filter on all sites, including disabled sites.

distance

double

Items within this distance in meters are returned.

unitOfMeasureKey

String

The unit of measure of the distance.

maximumDistance

double

The maximum allowed search distance, measured in meters. A value of -1 searches all items.

successURL

String

The URL that is used if no errors are encountered.

errorURL

String

The URL that is used if errors occur.

clearQueryURL

String

The URL used when the clearQuery action occurs.

locationResults

Collection

A collection of repository items returned by the locateItem handle method.

searchResultsByItemType

String

Returns the results sorted by item type.

enableCountQuery

Boolean

If true, locationResults returns a maximum of maxResultsPerPage based on the requested currentResultPageNum.

maxResultsPerPage

int

Maximum number of results to display for a page of results.

resultSetSize

int

The number of results returned by the query.

endIndex

int

The ending index to display based on the current page.

startIndex

int

The starting index to display based on the current page.

currentResultPageNum

int

The current page of results being displayed (1-based).

resultPageCount

int

The number of pages of results.

startCount

int

The index of the first record of the result set that is displayed within the current page.

endCount

int

The index of the last record of the results set that is displayed on the current page.

coordinateManager

CoordinateManager

The CoordinateManager used to find items based on their location.

siteGroupManager

SiteGroupManager

The SiteGroupManager used to interpret the site scope.

siteManager

SiteManager

Identifies the SiteManager to set.

geoLocatorService

GeoLocatorService

The GeoLocatorService used to identify latitude and longitude based on an address.

itemType

String

The item type to search for. Must be a valid item-descriptor for the repository used by the coordinateManager.