EarthRanger documentation

Contents:

• Overview

• Guides

• API

• Interactive API Documentation

Overview

Overview

• About ER - EarthRanger

Guides

Guides

• ER FAQ
  • General
  • API
• EarthRanger Architecture
  • The EarthRanger software architect
  • Technology
  • Data Size
  • Revisions
  • Activity - events and patrols
  • Observations
• Onboarding
  • Getting Started
  • Architecture
  • Coding Standards
  • Development Process
  • Other
• Supported Web Browsers and Operating Systems
  • Web Browsers
  • OS - Operating Systems
• EarthRanger Maps
  • Basemaps
  • Map Feature Classes
• Collars and Sensors integrated with ER
  • Radios
  • Vehicle Tracking
  • Tracking Collars
  • Camera Traps
• Alerts
  • Overview
  • Alert Rules
  • Notification Methods
  • Alert Content
  • Rate Limiting
  • Schedules
  • Permissions and Location Visibility
  • Pipeline Architecture
• ER map feature styles
  • Where the style lives
  • Supported keys
  • fill vs fill-color
  • How styles surface to clients
  • Editing presentation
  • ArcGIS imports
• Style cookbook
  • Boundaries
  • Roads
  • Rivers
  • POI
  • Operational
  • Fences
• Event Type Sync
  • Version 1 Event Type Sync
  • Summary for mobile clients
  • Version 2 Event Type Sync
  • Summary for mobile clients (v2)
• Patrol Sync
  • Patrol Types (catalog for offline)
  • Tracked-by schema (segment leaders / “reported by”)
  • Patrol configuration (teams and rosters)
  • Patrols (list and detail)
  • Patrol segments (list and detail)
  • Patrol state rules
  • Patrol sub-resources (notes, files)
  • Permissions
  • Summary for mobile clients
• Managed Users
  • Who does what
  • Creating a managed user on the add form
  • Every new account needs a way to sign in
  • Marking a user as a managed user
  • Setting a managed user’s password
  • Managed users cannot administer a site
  • Related
• Writing documentation for EarthRanger
  • Markdown
  • reStructuredText (reST)
  • Setup
• Glossary

API

API

• EarthRanger API Primer
  • Posting sensor data
  • Create an event
  • Add attachment (like an audio file)
  • Create an event and associate a subject to it
• API Deprecations
  • How to detect a deprecated endpoint
  • Lifecycle
  • How to migrate
  • Current deprecations
  • References
• Event Type Sync
  • Version 1 Event Type Sync
  • Summary for mobile clients
  • Version 2 Event Type Sync
  • Summary for mobile clients (v2)
• Patrol Sync
  • Patrol Types (catalog for offline)
  • Tracked-by schema (segment leaders / “reported by”)
  • Patrol configuration (teams and rosters)
  • Patrols (list and detail)
  • Patrol segments (list and detail)
  • Patrol state rules
  • Patrol sub-resources (notes, files)
  • Permissions
  • Summary for mobile clients
• Ranking
  • The after contract
  • Endpoints
  • Legacy v1 event-type and category rank endpoints
• OAuth 2
• Users and Permissions
  • New User Requirements
  • Users API
• Regions and Subjects
• Input Reports
• Community input file uploads
  • Chunked uploads
  • Per-form ceilings
  • Cleanup of abandoned uploads
  • Known gaps
• Analyzer configuration API
  • Geofence analyzer configuration
  • Observation attribute analyzer configuration
• Patrol configuration
  • Availability
  • Authorization
  • The default configuration name
  • GET .../config/default
  • GET .../config/default/resolved
  • Query parameters
  • Administration
  • See also
• Patrol provenance
  • Values
  • How it is set
  • Caveats
• Patrol segment capture fields
  • Availability
  • Payload
  • Validation
  • Time range validation
  • include_pauses
  • Conditional GET
  • Patrol timeline entries
• Observations
  • Filtering GET /observations
• Real-time DAS API
  • Requests
  • Event Messages
  • Request Messages
• Sensors
  • GPS Radio API
  • DAS Radio Agent API
  • Camera Trap API