REST API

The EasyGIS REST API methods allow developers to access the repository data and meta-data. This includes update geo data (feature types), map and layer definitions, member profiles, etc.

The API is entirely HTTP based. Methods to retrieve (by id, different searches) data from the EasyGIS API require a GET request. Methods that submit, change data require a POST or PUT request. A DELETE request is accepted for methods that remove data from the EasyGIS Repository.

The EasyGIS is built around a notion called Web resource. A resource represents a business entity and includes both: data and behavior. All Web resources have a unique URL, although it’s not prohibited to expose some auxiliary URLs for the same resource. All resources have 2 main representations, or formats: HTML and JSON. The default response format is HTML. A client may specify the desired resource presentation in the resource URL. The following is a request for JSON presentation to Maps resource:
http://localhost:8080/easygis/services/data/maps.json The same resource might be requested as HTML page in 2 ways (with and without resource extension): http://localhost:8080/easygis/services/data/maps or http://localhost:8080/easygis/services/data/maps.html

Most of the EasyGIS Web resources support built-in search functionality. You may pass 5 special parameters requesting those resources:

  • searchQuery – Full Text Search query string
  • start - the index of the first result returned in this response
  • limit - The number of entities to return per page, up to a max of 1000
  • sort – property name used for sorting of the search results
  • dir – direction of sorting. Can either be "ASC" or "DESC", defaults to ascending

Available REST Web resources