REST APIs

GeoAnalytics Builder account required

Table

tables/{table_name}.{xml | json}

This service loads data from a table hosted on the Content Manager.


A table request loads data from a customer table. The data can then be presented using filters or geographic clusters and can be paginated and sorted. This data can also be used to be searched around geographical position with a search radius parameter. A table request must be formatted as follow:

https://geowebservices.maporama.com/table.output?maporamakey=key&parameters

Where:

  • key: Your account key
  • output: The response format, May be either of the following values:
    • .json output in JavaScript Object Notation (JSON)
    • .xml output as XML
    • .csv output in csv
    • .txt output as Txt
    • .kml output as KML (Keyhole Markup Language)
    • .geojson output as geojson
The service is available using HTTPS protocol. The HTTPS verb must be GET or POST.

List of parameters

Name Type Values Description
Search options
rowCount integer e.g. 10 The number of rows to be shown from the table (maximum is 1000 rows)
rowOffset integer e.g. 10 The row offset in the table. Can be used for pagination together with the row count parameter
searchType string quick | proxy | area Search type
searchString string e.g. CAFE The string used when searching for a match
searchColumn string e.g. name The name of the column to search
Search around options
searchCenter string e.g. 48.855454,2.346557 The center of the search used when doing a "search around". The input is a latitude and longitude seperated by comma
searchDistance integer e.g. 1000 The distance of the radius in meters from the search center
distanceType string vehicule | birdfly Using vehicule mode, returns the distance and time by route between search center and the results
showDistance boolean true | false Whether to display or not the distance from the search center in the output
showMapUrl boolean true | false
Filter options
filterFields string e.g. name,city The name of the fields on which filtering will be applied, separated by comma
filterValues string e.g. CAFE,PARIS The name of the values to be filtered corresponding to the filter fields, separated by comma
customFilter{id}_{condition} string e.g. and,city,in,'PARIS','NICE','TOURS' This parameter use multiple times in the same query, by incrementing the {id} element. The {condition} specifies the filter connective between the multiple parameters. The value of the parameter contains the filter connective, the filter field name, the SQL condition and the values used in the SQL condition
idCustomFilter integer e.g. 1 The ID of a custom filter to be applied
Bounding box search options
north double e.g. 48.905803 The latitude in degrees representing the north of the bounding box
east double e.g. 2.400405 The longitude in degrees representing the east of the bounding box
south double e.g. 48.824497 The latitude in degrees representing the south of the bounding box
west double e.g. 2.251403 The longitude in degrees representing the west of the bounding box
Cluster options
cluster boolean true | false Specifies whether to cluster the data or not
clusterType string grid | shape The type of clustering algorithm to apply
clusterShapeTable string e.g. franceRegions If shape is used as a cluster type, then use this table for the definition of shapes
zoom double e.g. 10 The map zoom level for which to do the clustering
clusterShowIds boolean true | false Specifies whether to show or not the ids of the points in a cluster
clusterShowSinglePoints boolean true | false
clusterGridCellSize double e.g. The size of a grid cell, if grid is used as a clustering algorithm
Sort options
sortBy string e.g. name The name of the field on which the sort is applied
sortMode string asc | desc The type of sort used
sortNulls string e.g.
Other options
distinctColumns string e.g.
compact boolean true | false
intersects string e.g.
joinConditions string e.g.
version integer e.g.
Demo
URL:
Format:
Send Request

Example

Definitions

  • Rows Table rows. Each row contains the names of all the columns with their corresponding value
  • Schema Table schema. Contains information like column name, type, position and pseudo type. The pseudo type identifies special columns used for storing geographical information
  • Type If the table contains geographical information about its points the type is 'address', otherwise is 'object'
  • Total count The number of rows of the table