Portal API Specification
A series of RESTful API endpoints provides programmatic access to specific resources, especially associated with spatial features. The endpoints and their associated resources are described below.
Base URL: /api/v1
Endpoint | Resource | Type | Parameters | Description |
---|---|---|---|---|
/projects/sumter/spatial/watersheds | Project Features | Spatial | Returns Sumter project watersheds as spatial features formatted as GeoJSON. | |
/projects/sumter/collections/features | Project Features | Spatial | watershed, featureCollection | Returns spatial features (specified by the featureCollection parameter) associated with a watershed (watershed parameter) |
projects/sumter/spatial/attachments | Attachments | Spatial | Returns all point attachments (photos) associated with sumter project features |
Spatial endpoints return responses as GeoJSON
Authorization Endpoints
Endpoint | Resource | Type | Parameters | Description |
---|---|---|---|---|
/auth/get-token | User | Get/Assign New API Token | id - User ID | Get or assign a new bearer token for a user |
/auth/check-token | User | Check API Token | Bearer Token (Authorization Header) | Verify API Token for a user |