1. Start Here

    1. Welcome
    2. Get Help
    3. Blog
    4. Version Changelog
  2. [+]Examples

  3. Reference

  4. [+]JavaScript API

  5. [+]REST API

  6. [+]Analysis

GeoIQ API Overview

GeoIQ is the engine that powers the GeoCommons Community. GeoIQ includes a full Application Programming Interface (API) that allows developers to build unique and powerful domain specific applications. The API provides capability for uploading and download data, searching for data and maps, building, embedding, and theming maps or charts, as well as general user, group, and permissions management.

The GeoIQ API consists of a REST API and a JavaScript API. REST means that it uses simple URL’s and HTTP methods to perform all of the actions. For example, a dataset is a specific endpoint that a user can create, read, update or delete (CRUD).

There are many sections to the API included in this documentation. Each section contains specific methods, examples, and illustrations.

Overall Capabilities

  1. Upload data and register web feeds
  2. Manage, update, and delete datasets
  3. Download datasets
  4. Search for data and maps
  5. Create maps and style layers
  6. Embed maps and charts into websites
  7. Create, update and delete users
  8. Create groups and add or remove users
  9. Set access permissions for viewing, downloading, or editing resources

Available Resources

GeoIQ uses general HTTP REST architecture. This provides a simple interface for working with PLATFORM_NAME. The following is a complete list of available endpoints. Some endpoints have full CRUD capability, while others are limited to just a subset of methods. Each are documented in more detail in the relevant API documentation section.

Content Type

The GeoIQ relies heavily upon supporting many formats for each resource.

HTTP Status Codes

The PLATFORM_NAME API attempts to return appropriate HTTP status codes for every request.