Zum Hauptinhalt springen

Anwesenheits-Endpunkte

Das Anwesenheits-Modul verwaltet Campus-Standorte, Services, Service-Zeiten, Anwesenheitssitzungen, Besuche und Besuchssitzungen. Es bietet die Infrastruktur zur Verfolgung, wer welchen Service oder Gruppentreffen besucht hat, unterstützt Check-in-Workflows und bietet Anwesenheitstrend- und Zusammenfassungs-Berichterstattung.

Basispfad: /attendance

Campusse

Basispfad: /attendance/campuses

Standard-CRUD-Controller (erweitert GenericCrudController). Bietet getById, getAll, post und delete Routen über die CRUD-Basisklasse.

MethodePfadAuthBerechtigungBeschreibung
GET/JWTAlle Campusse für die Kirche auflisten
GET/:idJWTEinen Campus nach ID erhalten
POST/JWTServices.EditCampusse erstellen oder aktualisieren
DELETE/:idJWTServices.EditEinen Campus löschen

Services

Basispfad: /attendance/services

Erweitert GenericCrudController mit CRUD-Routen getById, getAll, post und delete. Die Endpunkte getAll (GET /) und search werden mit benutzerdefinierten Implementierungen überschrieben.

MethodePfadAuthBerechtigungBeschreibung
GET/JWTAlle Services auflisten (einschließlich Campus-Info)
GET/:idJWTEinen Service nach ID erhalten
GET/search?campusId=JWTServices nach Campus-ID durchsuchen
POST/JWTServices.EditServices erstellen oder aktualisieren
DELETE/:idJWTServices.EditEinen Service löschen

Service-Zeiten

Basispfad: /attendance/servicetimes

Erweitert GenericCrudController mit CRUD-Routen getById, post und delete. Die Endpunkte getAll und search sind benutzerdefinierte Implementierungen.

MethodePfadAuthBerechtigungBeschreibung
GET/JWTAlle Service-Zeiten auflisten. Filtern nach ?serviceId=. Füge ?include=groups hinzu, um Gruppendaten anzuhängen
GET/:idJWTEine Service-Zeit nach ID erhalten
GET/search?campusId=&serviceId=JWTService-Zeiten nach Campus und Service durchsuchen
POST/JWTServices.EditService-Zeiten erstellen oder aktualisieren
DELETE/:idJWTServices.EditEine Service-Zeit löschen

Anwesenheitsdatensätze

Basispfad: /attendance/attendancerecords

Bietet schreibgeschützte Aggregatansichten von Anwesenheitsdaten für Berichterstattung und Anzeige.

MethodePfadAuthBerechtigungBeschreibung
GET/JWTAttendance.ViewAnwesenheitsdatensätze für eine Person laden. Erfordert ?personId=
GET/treeJWTDen vollständigen Anwesenheitsbaum laden (Campusse, Services, Service-Zeiten, Gruppen)
GET/trend?campusId=&serviceId=&serviceTimeId=&groupId=JWTAttendance.View SummaryAnwesenheitstrend-Daten mit optionalen Filtern laden
GET/groups?serviceId=&week=JWTAttendance.ViewGruppen-Anwesenheit für einen Service in einer bestimmten Woche laden
GET/search?campusId=&serviceId=&serviceTimeId=&groupId=&startDate=&endDate=JWTAttendance.ViewAnwesenheitsdatensätze mit Filtern durchsuchen (Campus, Service, Service-Zeit, Gruppe, Datumsbereich)

Sitzungen

Basispfad: /attendance/sessions

Erweitert GenericCrudController mit CRUD-Routen getById und delete. Die Endpunkte getAll und save sind benutzerdefinierte Implementierungen, die es auch Gruppenleitern ermöglichen, Sitzungen für ihre Gruppen zu verwalten.

MethodePfadAuthBerechtigungBeschreibung
GET/JWTAttendance.View oder GruppenleiterAlle Sitzungen auflisten. Filtern nach ?groupId= (einschließlich Namen). Gruppenleiter können Sitzungen für ihre eigenen Gruppen anzeigen
GET/:idJWTAttendance.ViewEine Sitzung nach ID erhalten
POST/JWTAttendance.Edit oder GruppenleiterSitzungen erstellen oder aktualisieren. Gruppenleiter können Sitzungen für ihre eigenen Gruppen speichern
DELETE/:idJWTAttendance.EditEine Sitzung löschen

Besuche

Basispfad: /attendance/visits

Verwaltet einzelne Besuchsdatensätze (eine Person, die an einem bestimmten Datum besucht) und bietet den Check-in-Workflow.

MethodePfadAuthBerechtigungBeschreibung
GET/JWTAttendance.ViewAlle Besuche auflisten. Filtern nach ?personId=
GET/:idJWTAttendance.ViewEinen Besuch nach ID erhalten
GET/checkin?serviceId=&peopleIds=JWTAttendance.View oder Attendance.CheckinCheck-in-Daten für Personen bei einem Service laden. Gibt Besuche mit Besuchssitzungen aus dem letzten protokollierten Datum zurück
POST/JWTAttendance.EditBesuche erstellen oder aktualisieren
POST/checkin?serviceId=&peopleIds=JWTAttendance.Edit oder Attendance.CheckinCheck-in-Daten einreichen. Erstellt/aktualisiert Besuche und Besuchssitzungen, entfernt veraltete Datensätze
DELETE/:idJWTAttendance.EditEinen Besuch löschen

Besuchssitzungen

Basispfad: /attendance/visitsessions

Verwaltet die Zuordnung zwischen Besuchen und Sitzungen (welche spezifische Sitzung eine Person während eines Besuchs besucht hat). Bietet auch einen Quick-Log-Endpunkt und einen Download-/Export-Endpunkt.

MethodePfadAuthBerechtigungBeschreibung
GET/JWTAttendance.View oder GruppenleiterBesuchssitzungen auflisten. Filtern nach ?sessionId=. Gruppenleiter können Besuchssitzungen für ihre eigenen Gruppen anzeigen
GET/:idJWTAttendance.ViewEine Besuchssitzung nach ID erhalten
GET/download/:sessionIdJWTAttendance.ViewAnwesenheit für eine Sitzung herunterladen (gibt Personennamen mit anwesend/abwesend Status zurück)
POST/JWTAttendance.EditBesuchssitzungen erstellen oder aktualisieren
POST/logJWTAttendance.Edit oder GruppenleiterSchnell-Log-Anwesenheit einer Person zu einer Sitzung. Erstellt automatisch Besuch, falls erforderlich. Gruppenleiter können Anwesenheit für ihre eigenen Gruppen protokollieren
DELETE/:idJWTAttendance.EditEine Besuchssitzung nach ID löschen
DELETE/?personId=&sessionId=JWTAttendance.Edit oder GruppenleiterEine Person aus einer Sitzung entfernen. Löscht die Besuchssitzung und den übergeordneten Besuch, wenn keine Sitzungen verbleiben. Gruppenleiter können Anwesenheit für ihre eigenen Gruppen entfernen

Streaks

Basispfad: /attendance/streaks

Verfolgt Anwesenheits-Streaks für Einzelpersonen -- aufeinanderfolgende Wochen, in denen eine Person anwesend war. Nützlich für Engagement-Metriken und Gamifikation.

MethodePfadAuthBerechtigungBeschreibung
GET/person/:personIdJWTAnwesenheits-Streaks für eine Person laden

Verwandte Seiten