Workflow Endpoints

Endpoint Details

  • Search Endpoints: /api/endpoints/search - Search for endpoints by serial number.
  • Endpoint Detail: /api/endpoint/<endpoint_id> - View detailed information for a specific endpoint including meters, requests, and reads.
  • Endpoint Meters: /api/endpoint/<endpoint_id>/meters - Get meters associated with an endpoint.
  • Endpoint Requests: /api/endpoint/<endpoint_id>/requests - Get read requests for an endpoint.
  • Endpoint Reads: /api/endpoint/<endpoint_id>/reads - Get read records for an endpoint.

Endpoint Management

Files

  • File List: /api/files/ - Browse, download, delete, and process uploaded files.
  • File Info: /api/files/<file_id> - Retrieve metadata for a specific file.
  • File Download: /api/files/<file_id>/download - Download a file by ID.
  • File Delete: POST /api/files/<file_id>/delete - Delete a file by ID.
  • Import Requests: /api/files/import-requests - Import Read Requests from a file.
  • Export Requests: /api/files/export-requests - Export requests for a collector or mission.
  • Fill Reads: /api/files/fill-reads - Fill a file with reads.
  • Import Reads: /api/files/import-reads - Import reads from a file.

Task Management

  • List Tasks: /api/tasks/ - List all Current and recent tasks.

Validation

  • Validate Requests: /api/validation/validate - Submit a validation task to compare Temetra XML against Mirage database state.
  • List Validation Reports: /api/validation/reports - List recent validation reports with delta summaries.
  • Validation Report Detail: /api/validation/reports/<report_id> - Get detailed JSON data for a specific validation report.
  • Validation Report HTML: /api/validation/reports/<report_id>/html - View interactive HTML report with collapsible delta sections.

Contacts

  • Add Contact: /api/contacts/add/ - Add or re-activate a notification contact for a network. Sends a welcome email on creation. (Staff only)

Programmatic Endpoints (JSON Responses)

  • Add Client Config: /api/temetra/add-client-config - Add a new Temetra client configuration and associated network.
  • AMR Report: /api/reports/amr - Generate Type 3 AMR session report grouped by hour. Supports timezone conversion. Query params: network (required), route, cycle, timezone (MST, America/Edmonton, -0700).
  • Search Endpoints: /api/endpoints/search?serial=<serial_number> - Search for endpoints by serial number.
  • List Networks: /api/context/networks/ - List all networks.
  • List Clients: /api/context/clients/ - List all clients.
  • List Cycles: /api/context/cycles/ - List all cycles.
  • List Routes: /api/context/routes/ - List all routes.
  • List Errors: /api/files/errors/<group_id> - List detailed errors for a specific group.