Bevakning — Dokumentation

Bevakningsfunktioner används via portalen och organisationens inloggade Firebase-session. Det här är interna Pro-endpoints, inte Skolkolls publika API-roadmap eller en API-nyckelprodukt.

Endpoints:

// Prenumeration:
POST   /api/watchers/subscribe          Bevaka en skola/kommun/huvudman
POST   /api/watchers/unwatch            Sluta bevaka
GET    /api/watchers/status             Kontrollera bevakningsstatus
GET    /api/watchers/list               Lista alla bevakningar

// Inställningar:
PUT    /api/watchers/thresholds         Ange tröskelvärden
PUT    /api/watchers/frequency          Ändra frekvens
PUT    /api/watchers/quiet-period       Sätt tyst period

// Profiler:
POST   /api/watchers/share-profile      Exportera bevakningsprofil
POST   /api/watchers/import-profile     Importera bevakningsprofil (max 200)

// Org-monitorer (Pro admin):
GET    /api/pro/monitors                Lista organisationsmonitorer
POST   /api/pro/monitors                Lägg till monitor
DELETE /api/pro/monitors/:id            Ta bort monitor

// Historik:
GET    /api/pro/watcher-events          Ändringsloggar (?limit=, ?schoolCode=)

// Notifieringsinställningar:
GET    /api/pro/notifications/preferences
PUT    /api/pro/notifications/preferences
GET    /api/pro/notifications/history

Exempel:

// Bevaka en skola:
POST /api/watchers/subscribe
{ "schoolCode": "12345678", "schoolName": "Exempelskolan" }

// Ändra tröskelvärden:
PUT /api/watchers/thresholds
{
  "schoolCode": "12345678",
  "thresholds": {
    "merit": 3,
    "eligibility": 5,
    "pupils": 10,
    "certifiedTeachers": 8,
    "studentsPerTeacher": 2
  }
}

// Ändra frekvens:
PUT /api/watchers/frequency
{ "schoolCode": "12345678", "frequency": "weekly" }

// Tyst period:
PUT /api/watchers/quiet-period
{ "until": "2026-08-01" }           // Pausa alla
{ "schoolCode": "12345678", "until": "2026-08-01" }  // Pausa en
{ "until": null }                    // Återaktivera

Detaljer:

Subscribe — ange schoolCode + schoolName (skola), municipalityCode + watchName (kommun), eller organizerOrgNr + watchName (huvudman). Kommun/huvudman kräver Pro.

Import-profile — max 200 bevakningar per import. Dubbletter hoppas över automatiskt.

Org-monitorer — kräver Pro-admin-roll. Monitorer gäller hela organisationen, inte enskilda användare.

Watcher-events — stöder ?limit= (standard 50, max 200) och ?schoolCode= för filtrering.

Felkoder: 400 (valideringsfel), 401 (ej inloggad), 403 (gratiskontogräns nådd / saknar Pro), 404 (bevakning hittades inte), 429 (rate limit), 500 (serverfel).