Feature Server API documentation version 1.0

http://www.example.com/featureserver/api

Home

This API exposes a generic storage and query service for geojson features. The features are organised into databases and (feature) collections.

databases available on server

get

get

Returns a list of databases

get put delete

database (schema) containing collections (tables)

get

Returns the list of collections (tables) in the specified database

put

Creates a new database (no request body is required).

delete

Drops the database

Returns the list of collections (tables) in the specified database

URI Parameters

  • database: required(string)

HTTP status code 200

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

[
   {
       "name": "collection",
       "url": "/api/databases/wegsegmenten/collection"
   }
 ]

HTTP status code 404

the database does not exist.

Creates a new database (no request body is required).

URI Parameters

  • database: required(string)

HTTP status code 201

CREATED when the database has been successfully created.

HTTP status code 409

CONFLICT when the database already has been created

Drops the database

URI Parameters

  • database: required(string)

HTTP status code 200

The database has been successfully dropped (or doesn't exist)

post

register a regular table as a feature collection

post

URI Parameters

  • database: required(string)

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

{                
 "collection": "table-name",
 "geometry-column": "geometry"  
 "extent": { 
    "crs" : 4326,                   
    "envelope": [-90,-180, 90, 180]
    }                 
}

HTTP status code 200

The specified table is sucessfully registered as a feature collection

HTTP status code 409

There already exists a feature collection with that name

get put delete

a collection (table) of GeoJSON features.

get

Returns the metadata associated with this collection. The metadata consists of:

  • the name of the collection
  • the spatial extent of the complete collection
  • the index-level (not used)
  • the type of the (required) id property (either 'text' or 'decimal')
  • the number of features currrently in the collection
put

Creates a collection, using the metadata specified in the request body

delete

Drops the collection, and all associated database objects (views, metadata, etc.)

Returns the metadata associated with this collection. The metadata consists of:

  • the name of the collection
  • the spatial extent of the complete collection
  • the index-level (not used)
  • the type of the (required) id property (either 'text' or 'decimal')
  • the number of features currrently in the collection

URI Parameters

  • database: required(string)
  • collection: required(string)

HTTP status code 200

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

{
  "collection": "segment",
  "extent": {
    "crs": 31370,
    "envelope": [0, 0, 300000, 300000]
  },
  "index-level": 8,
  "id-type": "text",
  "count": 151922
}

HTTP status code 404

if the collection or database does not exist

Creates a collection, using the metadata specified in the request body

URI Parameters

  • database: required(string)
  • collection: required(string)

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

{
 "index-level": 8,
 "id-type": "text",
 "extent": { 
    "crs" : 4326,
    "envelope": [-90,-180, 90, 180]
    }                 
}

HTTP status code 201

the collection has been created successfully

HTTP status code 404

the database does not exist

HTTP status code 409

the collection already exists

Drops the collection, and all associated database objects (views, metadata, etc.)

URI Parameters

  • database: required(string)
  • collection: required(string)

HTTP status code 200

the collection has been dropped, or doesn't exist

Resource for executing transactions against the specified collection.

post

post

POST a stream of GeoJson features to this resource for bulk upload or insert.

The features must be seperated by a newline.

POST a stream of GeoJson features to this resource for bulk upload or insert.

The features must be seperated by a newline.

URI Parameters

  • database: required(string)
  • collection: required(string)

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

<GeoJson>\n
<GeoJson>\n
....

post

post

POST a delete specification. A delete specification is a json object having a query property, which contains a query expression

POST a delete specification. A delete specification is a json object having a query property, which contains a query expression

URI Parameters

  • database: required(string)
  • collection: required(string)

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

{
  "query" : "id = 433"
}

HTTP status code 200

the transaction executed successfully

HTTP status code 400

the delete specification is malformed (either not a json, or invalid query expression).

HTTP status code 404

the database or collection does not exist

post

post

POST an update specification. An update specification is a json object having query and update properties. The query property holds a query expression that specifies the features to update. The update property holds a replacement feature.

POST an update specification. An update specification is a json object having query and update properties. The query property holds a query expression that specifies the features to update. The update property holds a replacement feature.

URI Parameters

  • database: required(string)
  • collection: required(string)

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

{
"query": "id = 433",
"update" : {id = 433, geometry":{"type":"Point","crs":{"properties":{"name":"EPSG:31370"},"type":"name"},"bbox":[158000,191400,158050,191400],"coordinates":[158000,191400]},"type":"Feature","properties":{"some-property":"some-value"}}
}

HTTP status code 200

The update executed successfully

HTTP status code 400

The request body doesn't contain a JSON object with valid query or update properties.

post

post

POST a stream of GeoJson features to this resource for bulk upsert into the specified collection.

The features must be seperated by a newline.

An upsert performs an update if the collection already contains the feature, and an insert otherwise. Features are identified by their id property.

POST a stream of GeoJson features to this resource for bulk upsert into the specified collection.

The features must be seperated by a newline.

An upsert performs an update if the collection already contains the feature, and an insert otherwise. Features are identified by their id property.

URI Parameters

  • database: required(string)
  • collection: required(string)

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

{id = 433, geometry":{"type":"Point","crs":{"properties":{"name":"EPSG:31370"},"type":"name"},"bbox":[158000,191400,158050,191400],"coordinates":[158000,191400]},"type":"Feature","properties":{"some-property":"some-value"}}\n
{id = 434, geometry":{"type":"Point","crs":{"properties":{"name":"EPSG:31370"},"type":"name"},"bbox":[158000,191400,158050,191400],"coordinates":[158000,191400]},"type":"Feature","properties":{"some-property":"some-value"}}\n
....

get

get

Executes a query on the specified collection and returns a stream of features (separated by a newline character). The bbox and query parameters are ANDed together.

Executes a query on the specified collection and returns a stream of features (separated by a newline character). The bbox and query parameters are ANDed together.

URI Parameters

  • database: required(string)
  • collection: required(string)

Query Parameters

  • bbox: (string)

    Bounding box in string-representation (<min-x>,<min-y>,<max-x>,<max-y>)

    Example:

    0,0,90,90
  • query: (string)

    Query expression

    Example:

    Properties.foo = 'bar'
  • start: (integer)

    Skips the specified number of features before returning features

  • limit: (integer)

    Specifies the maximum number of features to return

  • projection: (string)

    specifies a comma-separated list of feature property paths. If this parameter is present, the output contains all and only the specified property paths. If the input Json doesn't contain a specified property path, it will be add in the output with a value of null.

    Example:

    properties.foo,properties.bar,properties.baz
  • sort: (string)

    specifies a comma-separated list of feature property paths. If this parameter is present, the output is sorted on the specified property paths (according to the order specified in the 'sort-direction'-parameter).

    Example:

    properties.foo,properties.bar,properties.baz
  • sort-direction: (string)

    specifies a comma-separated list of sort directions (either 'asc' or 'desc') to use when sorting the corresponding property paths specified in the sort parameter. If this parameter is absent, or does not specify a direction for a sort property, the ascending sort order will be used by default.

  • with-view: (string)

    The name of the ViewDef to apply. A ViewDef has query and projection properties. The ViewDef query expression will be conjoined (AND-ed) to the query request parameter, and the ViewDef projection property will be concatenated to the projection request parameter.

  • sep: (string)

    The separator to use in the CSV result this parameter is ignored when the accepted media type is other than CSV

  • fmt: (string)

    Either "csv" or "json". Hack for specifying the Accepted media type for the response, when no Accept header can be set by the client.

  • filename: (string)

    Hack to add a filename to content-disposition attachment header field to force browser to download the data with given filename.

HTTP status code 200

Successfully executed the query

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

{id = 433, geometry":{"type":"Point","crs":{"properties":{"name":"EPSG:31370"},"type":"name"},"bbox":[158000,191400,158050,191400],"coordinates":[158000,191400]},"type":"Feature","properties":{"some-property":"some-value"}}
{id = 434, geometry":{"type":"Point","crs":{"properties":{"name":"EPSG:31370"},"type":"name"},"bbox":[158001,191401,158051,191401],"coordinates":[158001,191401]},"type":"Feature","properties":{"some-property":"some-other-value"}}
....

Media type: application/vnd.geolatte-featureserver+csv;version=1.0

Type: any

Example:

id, geometry-wkt, some-property
433,SRID=31370;POINT(158000 191400),"some-value"
434,SRID=31370;POINT(158001 191401),"some-other-value"

get

get

Executes a query to find the distinct values, using the projection parameter. The bbox and query parameters are ANDed together.

Executes a query to find the distinct values, using the projection parameter. The bbox and query parameters are ANDed together.

URI Parameters

  • database: required(string)
  • collection: required(string)

Query Parameters

  • projection: required(string)

    Specifies a feature property path to get the distinct values from

    Example:

    properties.foo
  • bbox: (string)

    Bounding box in string-representation (<min-x>,<min-y>,<max-x>,<max-y>)

    Example:

    0,0,90,90
  • query: (string)

    Query expression

    Example:

    Properties.foo = 'bar'

HTTP status code 200

Successfully executed the query

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

["bar1", "bar2", "bar3"]

get

get

Executes the query on the specified collection and returns the result in a Json response object.

The only difference between this and the /query request, is that the query request returns the object as a stream of objects (http chunked encoded), and this request a single Json object. The returned object contains

Executes the query on the specified collection and returns the result in a Json response object.

The only difference between this and the /query request, is that the query request returns the object as a stream of objects (http chunked encoded), and this request a single Json object. The returned object contains

URI Parameters

  • database: required(string)
  • collection: required(string)

Query Parameters

  • bbox: (string)

    Bounding box in string-representation (<min-x>,<min-y>,<max-x>,<max-y>)

    Example:

    0,0,90,90
  • query: (string)

    Query expression

    Example:

    Properties.foo = 'bar'
  • start: (integer)

    Skips the specified number of features before returning features

  • limit: (integer)

    Specifies the maximum number of features to return

  • projection: (string)

    specifies a comma-separated list of feature property paths. If this parameter is present, the output contains all and only the specified property paths. If the input Json doesn't contain a specified property path, it will be add in the output with a value of null.

    Example:

    properties.foo,properties.bar,properties.baz
  • sort: (string)

    specifies a comma-separated list of feature property paths. If this parameter is present, the output is sorted on the specified property paths (according to the order specified in the 'sort-direction'-parameter).

    Example:

    properties.foo,properties.bar,properties.baz
  • sort-direction: (string)

    specifies a comma-separated list of sort directions (either 'asc' or 'desc') to use when sorting the corresponding property paths specified in the sort parameter. If this parameter is absent, or does not specify a direction for a sort property, the ascending sort order will be used by default.

  • with-view: (string)

    The name of the ViewDef to apply. A ViewDef has query and projection properties. The ViewDef query expression will be conjoined (AND-ed) to the query request parameter, and the ViewDef projection property will be concatenated to the projection request parameter.

  • sep: (string)

    The separator to use in the CSV result this parameter is ignored when the accepted media type is other than CSV

  • fmt: (string)

    Either "csv" or "json". Hack for specifying the Accepted media type for the response, when no Accept header can be set by the client.

  • filename: (string)

    Hack to add a filename to content-disposition attachment header field to force browser to download the data with given filename.

HTTP status code 200

Successfully executed the query

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Example:

{
  "total":151921,
  "count":2,
  "features":[
     {"id": 433, "geometry":{"type":"Point","crs":{"properties":{"name":"EPSG:31370"},"type":"name"},"bbox":[158000,191400,158050,191400],"coordinates":[158000,191400]},"type":"Feature","properties":{"some-property":"some-value"}},
     {"id": 434, "geometry":{"type":"Point","crs":{"properties":{"name":"EPSG:31370"},"type":"name"},"bbox":[158001,191401,158051,191401],"coordinates":[158001,191401]},"type":"Feature","properties":{"some-property":"some-other-value"}}
   ]
 }

get

get

Gets the indexes defined on the specified collection.

Note: in addition to the indexes listed in the response, there will always be also a spatial index, and an index on the id property.

Gets the indexes defined on the specified collection.

Note: in addition to the indexes listed in the response, there will always be also a spatial index, and an index on the id property.

URI Parameters

  • database: required(string)
  • collection: required(string)

HTTP status code 200

Returns the array with index descriptions

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

[
  {
    "name": "ididx",
    "url": "/api/databases/wegsegmenten/segment/indexes/ididx"
}
]

put get delete

put

Creates the index on the specified collection.

If the regex property is specified and set to true a GIST index will be created using the tigram matching functions of the pg_trgm extension. If this extension has not been created in the database, index creation will fail.

get

GETs index definition

delete

Deletes the specified index

Creates the index on the specified collection.

If the regex property is specified and set to true a GIST index will be created using the tigram matching functions of the pg_trgm extension. If this extension has not been created in the database, index creation will fail.

URI Parameters

  • database: required(string)
  • collection: required(string)
  • indexName: required(string)

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Example:

{
  "paths" : ["properties.entity.id"],
  "type" : "decimal",
  "regex" : true
}

HTTP status code 201

The index has been created. Note: It is possible to successfully create an index to a non-existent property paths.

GETs index definition

URI Parameters

  • database: required(string)
  • collection: required(string)
  • indexName: required(string)

HTTP status code 200

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Example:

{
  "name": "ididx",
  "indexDef": "CREATE INDEX ...."
}

HTTP status code 404

if the specified index does not exist (or the collection, or database).

Deletes the specified index

URI Parameters

  • database: required(string)
  • collection: required(string)
  • indexName: required(string)

HTTP status code 200

Successful deletion of the index (or the index doesn't exist)

get

A Resource for managing views on the collection.

get

Returns the list with View descriptions

Returns the list with View descriptions

URI Parameters

  • database: required(string)
  • collection: required(string)

HTTP status code 200

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

put get delete

This resource represents a View defined on the specified collection.

put

Creates a View

get

Returns the view defintion

delete

Deletes the view

Creates a View

URI Parameters

  • database: required(string)
  • collection: required(string)
  • viewName: required(string)

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Example:

{
  "query" : "foo.bar = 2",
  "projection": [
                  "foo.bar", 
                  "foo.baz"
                ]
}

HTTP status code 201

Successful creation of the index

Headers

  • Location: required(string)

    URL to the created view.

Returns the view defintion

URI Parameters

  • database: required(string)
  • collection: required(string)
  • viewName: required(string)

HTTP status code 200

The view definition

Body

Media type: application/vnd.geolatte-featureserver+json;version=1.0

Type: any

Example:

{
    "name": "view_1",
    "query": "foo.bar = 2",
    "projection": [
        "foo.bar",
        "foo.baz"
    ],
    "url": "/api/databases/someDb/comeCollection/views/view_1"
}

Deletes the view

URI Parameters

  • database: required(string)
  • collection: required(string)
  • viewName: required(string)

HTTP status code 200

Deletes the view, or the view does not exist.