XYZ - Developer Guide
  • Introduction
  • Licence
  • Deploying
    • Local Deployments
  • Access
    • Access Control List (ACL)
    • User account registration
    • Password reset
    • Failed login attempts
  • Environment Settings
    • Hosting
    • Access Control
    • Workspace Connections
    • 3rd party API keys
  • Workspaces
    • Title
    • Documentation
    • Locate
    • Locales
      • Gazetteer
    • Layers
      • Tile Layer
      • PostGIS Data Layers
      • Cluster Layer
      • GeoJSON Layer
      • MapBox Vector Tile (MVT) Layer
      • Grid (Hex) Layer
      • Filter
    • Locations
      • infoj
        • Groups
        • Filter
        • Lookups
        • withSelect
        • Table definition
        • Ordered list
        • Geometry
    • Editing
    • Access Restrictions & Filter
    • Workspace Checks
  • Routes
    • / (root)
    • /proxy/request
    • /api
      • /gazetteer
        • /autocomplete
        • /googleplaces
      • /layer
        • /cluster
        • /extent
        • /geojson
        • /grid
        • /mvt/:z/:x/:y
      • /location
        • /edit
          • /delete
          • /image/delete
          • /image/upload
          • /draw
          • /draw/catchment
          • /catchment/create
          • /catchment/delete
          • /update
        • /select
          • /id
          • /cluster
          • /latlng/contains
          • /latlng/nnearest
          • /latlng/intersects
          • /aggregate
        • /field/range
    • /auth
      • /login
      • /register
      • /token
        • /api
        • /renew
      • /user
        • /admin
        • /verify
        • /approve
        • /update
        • /delete
    • /workspace
      • /get
      • /load
      • /admin
      • /admin/json
  • Infrastructure
    • _xyz
      • host
      • layer
      • location
      • mapview
      • tableview
    • Dependencies
      • Webpack
      • SASS
    • Testing
    • Security
      • JWT token
      • Strategy
      • SQL Injections
    • Server
    • Client
Powered by GitBook
On this page
  1. Routes
  2. /api
  3. /location
  4. /select

/cluster

location id, lnglat and label of cluster locations.

GET geolytix.xyz/api/location/select/cluster

This endpoint queries a JSON array of ID and label from a cluster location.

Query Parameters

Name
Type
Description

locale

string

The locale (key) which contains the cluster layer.

layer

string

The cluster layer (key).

table

string

The table which holds the cluster locations.

lnglat

string

Comma seperated float for longitude and latitude.

filter

string

A stringified JSON filter object.

count

string

The maximum number of locations from cluster to return.

token

string

A token is required to access private endpoints.

[
  {
    "id": 8213,
    "label": "Cooltrader - Erdington",
    "lnglat": [
      -1.8388261591,
      52.5237149882455
    ]
  },
  {
    "id": 8853,
    "label": "Erdington",
    "lnglat": [
      -1.83784775521401,
      52.5235273833912
    ]
  },
  {...}
]
'Invalid token.'
'Invalid locale.'
​
'Invalid layer.'
​
'Missing table.'
​
'Missing lnglat.'
​
'Invalid parameter.'
'Failed to query PostGIS table.'

Access filter on the layer apply and the locations can not be returned if the access token does hold the required roles for private endpoints.

Previous/idNext/latlng/contains

Last updated 6 years ago