Sites
#
Fetch all SitesFetch all sites for the app.
IMPORTANT: This method could result in long running operation with multiple API calls behind the scenes. It is recommended to use fetchSitesByQuery
.
#
ParamsName | Type |
---|---|
None | None |
#
Example#
Fetch Sites by QueryFetch sites for the app. The query
parameter will return results that match the partnerIdentifier
or name
of the site.
#
ParamsName | Type | Example |
---|---|---|
params | Obj | { query: 'Test', page: 1 } |
#
Example#
Fetch Sites by RegionFetch sites in a given region.
#
ParamsName | Type | Example |
---|---|---|
region | CircularRegion | {latitude: 47.6234207,longitude: -122.3300605,radius: 100} |
page | Int | 1 |
per | Int | 20 |
#
Example#
Fetch Site by Partner IdentifierFetch a site based on Partner Identifier.
#
ParamsName | Type | Example |
---|---|---|
partnerIdentifier | String | 123 |