Skip to content

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/api

Authentication

All API requests require authentication via session cookie. Log in through the web UI to establish a session.

Endpoints Overview

Personnel

MethodEndpointDescription
GET/api/personnelList all personnel
GET/api/personnel/:idGet a single person
POST/api/personnelCreate a person
PUT/api/personnel/:idUpdate a person
DELETE/api/personnel/:idDelete a person

Beacons

MethodEndpointDescription
GET/api/beaconsList all beacons
GET/api/beacons/:idGet a single beacon
POST/api/beaconsRegister a beacon
PUT/api/beacons/:idUpdate a beacon
POST/api/beacons/:id/assignAssign beacon to personnel

Floor Plans

MethodEndpointDescription
GET/api/floorplansList all floor plans
GET/api/floorplans/:idGet a floor plan with metadata
POST/api/floorplansCreate a floor plan
PUT/api/floorplans/:idUpdate floor plan settings

Gateways

MethodEndpointDescription
GET/api/gatewaysList all gateways
GET/api/gateways/:idGet gateway details and health

Emergency / Muster

MethodEndpointDescription
GET/api/emergenciesList emergency events
POST/api/emergenciesTrigger an emergency
PUT/api/emergencies/:id/resolveResolve an emergency
GET/api/emergencies/:id/rosterGet muster roster

Dashboard

MethodEndpointDescription
GET/api/dashboardDashboard summary metrics
GET/api/healthSystem 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"
}

NISC Muster Tracking Documentation