API Reference
The NISC Muster Tracking API provides endpoints for managing personnel, beacons, floor plans, gateways, and emergency events.
Base URL
All API endpoints are relative to the application base:
https://muster.nisc.coop/apiAuthentication
All API requests require authentication via session cookie. Log in through the web UI to establish a session.
Endpoints Overview
Personnel
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/personnel | List all personnel |
| GET | /api/personnel/:id | Get a single person |
| POST | /api/personnel | Create a person |
| PUT | /api/personnel/:id | Update a person |
| DELETE | /api/personnel/:id | Delete a person |
Beacons
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/beacons | List all beacons |
| GET | /api/beacons/:id | Get a single beacon |
| POST | /api/beacons | Register a beacon |
| PUT | /api/beacons/:id | Update a beacon |
| POST | /api/beacons/:id/assign | Assign beacon to personnel |
Floor Plans
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/floorplans | List all floor plans |
| GET | /api/floorplans/:id | Get a floor plan with metadata |
| POST | /api/floorplans | Create a floor plan |
| PUT | /api/floorplans/:id | Update floor plan settings |
Gateways
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/gateways | List all gateways |
| GET | /api/gateways/:id | Get gateway details and health |
Emergency / Muster
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/emergencies | List emergency events |
| POST | /api/emergencies | Trigger an emergency |
| PUT | /api/emergencies/:id/resolve | Resolve an emergency |
| GET | /api/emergencies/:id/roster | Get muster roster |
Dashboard
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/dashboard | Dashboard summary metrics |
| GET | /api/health | System health check |
Response Format
All responses follow a consistent envelope:
json
{
"success": true,
"data": { ... }
}Error responses:
json
{
"success": false,
"error": "Description of what went wrong"
}