Zum Hauptinhalt springen

Membership-Endpunkte

Das Membership-Modul verwaltet Personen, Gemeinden, Gruppen, Haushalte, Rollen, Berechtigungen, Formulare und Einstellungen. Es ist das größte Modul und stellt die zentrale Identitäts- und Autorisierungsschicht für alle anderen Module bereit.

Basispfad: /membership

Personen​

Basispfad: /membership/people

MethodePfadAuthBerechtigungBeschreibung
GET/JWTPeople.View oder MemberAlle Personen der Gemeinde auflisten
GET/:idJWTPeople.View oder eigener DatensatzEine Person anhand der ID abrufen (enthält Formularübermittlungen)
GET/ids?ids=JWTPeople.View, Member oder People.ViewNamesMehrere Personen anhand kommagetrennter IDs abrufen. Aufrufer mit People.ViewNames ohne People.View erhalten das Basismodell; Personen, die dem Verzeichnis widersprochen haben, werden ausgelassen (außer dem Aufrufer selbst)
GET/basic?ids=JWT—Basisinformationen (nur Name) für mehrere Personen abrufen
GET/names?ids=JWTBeliebige Gemeindeberechtigung[{ id, name: { display, first, last }, photo }], sortiert nach Nachname und dann Vorname, für kommagetrennte IDs, die der Aufrufer bereits kennt. So können Rollen ohne People.View (Spenden, Anwesenheit) Personen beschriften. Keine Suche, kein Verzeichnisfilter
POST/namesJWTBeliebige GemeindeberechtigungWie GET /names. Body: { peopleIds } (oder { ids })
GET/recentJWTPeople.View, Member oder People.ViewNamesKürzlich hinzugefügte Personen. Aufrufer mit People.ViewNames ohne People.View (auch Mitglieder mit Verzeichniszugriff) erhalten das Basismodell (id, name.display, photo, membershipStatus); Personen, die dem Verzeichnis widersprochen haben, werden ausgelassen
GET/guest-register/options?churchId=Öffentlich—Checkliste für die Gästeanmeldung per QR-Code: gibt { email, phone, address, birthDate, gender, maritalStatus, grade, comments } zurück, jeweils "off", "optional" oder "required" (aus der öffentlichen Einstellung guestRegistrationFields ausgelesen; fehlende oder fehlerhafte Werte fallen auf E-Mail/Telefon optional, der Rest aus). Erfordert enableQRGuestRegistration, sofern die Anfrage kein passendes Site- oder Gemeinde-Token mitsendet; ratenbegrenzt (429)
GET/search?term=&email=JWTPeople.View, Member oder People.ViewNamesPersonen nach Name oder E-Mail suchen (bis zu 100, sortiert nach Nachname und dann Vorname). Aufrufer mit People.ViewNames ohne People.View (auch Mitglieder mit Verzeichniszugriff) erhalten bei einer Namenssuche das Basismodell; eine Suche nach email liefert []
GET/search/phone?number=JWTPeople.View oder MemberNach Telefonnummer suchen
GET/search/group?groupId=JWTPeople.View oder MemberPersonen einer bestimmten Gruppe abrufen
GET/household/:householdIdJWT—Alle Personen eines Haushalts abrufen
GET/attendanceJWTPeople.EditTeilnehmer mit Filtern laden (campusId, serviceId, serviceTimeId, groupId, categoryName, startDate, endDate)
GET/timeline?personIds=&groupIds=JWT—Zeitleistendaten für Personen und Gruppen laden
GET/directory/:idJWT—Person für die Verzeichnisansicht abrufen (berücksichtigt die Sichtbarkeitseinstellungen)
GET/claim/:churchIdJWT—Einen Personendatensatz für den aktuellen Benutzer in einer Gemeinde beanspruchen
POST/JWTPeople.Edit oder EditSelfPersonen erstellen oder aktualisieren (als Stapel)
POST/searchJWTPeople.View, Member oder People.ViewNamesPersonen durchsuchen (POST-Variante). Body: { term } oder { email }; gleiche Regeln für reine Namenssuche wie bei GET /search
POST/advancedSearchJWTPeople.View oder MemberSuche mit mehreren Bedingungen (Alter, birthMonth, membershipStatus usw.). Der Body ist ein Array von Bedingungen; ein leerer Body bedeutet keine Bedingungen, jeder andere Nicht-Array-Body liefert 400
POST/loadOrCreateÖffentlich—Eine Person anhand der E-Mail finden oder anlegen. Body: { churchId, email, firstName, lastName }
POST/guest-registerÖffentlich—Gästeanmeldung per QR-Code. Body: { churchId, members: [{ firstName, lastName, email?, phone?, birthDate?, gender?, grade? }], address?, maritalStatus?, comments? } (1–10 Mitglieder; email/phone/maritalStatus gelten nur für das erste Mitglied). Von der Gemeinde deaktivierte Felder werden verworfen; fehlende Pflichtfelder oder ungültige Werte liefern 400. Zuerst werden bestehende Personen wiederverwendet: Ein Mitglied passt, wenn genau eine nicht entfernte Person denselben Vornamen (ohne Berücksichtigung der Groß-/Kleinschreibung) und dieselbe E-Mail oder dieselben Telefonziffern (privat, geschäftlich oder mobil) hat; ein Mitglied ohne E-Mail oder Telefon passt über den Vornamen innerhalb des zugeordneten Haushalts. Passende Personen werden nie verändert. Nicht zugeordnete Mitglieder treten dem passenden Haushalt bei, andernfalls wird ein neuer Haushalt angelegt (benannt nach dem Nachnamen des ersten Mitglieds), als membershipStatus: "Visitor" mit der gemeinsamen address. comments wird als Notiz beim ersten Mitglied gespeichert; alle werden, falls gesetzt, der privaten Gruppe guestRegistrationGroupId hinzugefügt. Ist guestRegistrationRecordAttendance auf "true" gesetzt, wird außerdem die Anwesenheit für die planmäßigen Gottesdienstzeiten dieser Gruppe erfasst, deren Check-in-Fenster gerade geöffnet ist. Gibt { householdId, people: [{ id, name }] } zurück und spiegelt die übermittelten statt der gespeicherten Namen wider. Gleiche Regeln zu Opt-in/Token und Ratenbegrenzung wie beim Options-Aufruf
POST/household/:householdIdJWTPeople.EditHaushaltszuordnungen der Mitglieder aktualisieren
POST/public/emailÖffentlich—Eine E-Mail an eine Person senden. Body: { churchId, personId, subject, body, appName }
POST/apiEmailsIntern—E-Mail-Adressen von Personen anhand von IDs laden (Server-zu-Server, erfordert jwtSecret)
DELETE/:idJWTPeople.EditEine Person löschen

Beispiel: Personen suchen​

GET /membership/people/search?term=John
Authorization: Bearer <token>
[
{
"id": "abc-123",
"name": { "first": "John", "last": "Smith" },
"contactInfo": { "email": "john@example.com" },
"membershipStatus": "Member"
}
]

Beispiel: Person anlegen​

POST /membership/people
Authorization: Bearer <token>

[{ "firstName": "Jane", "lastName": "Doe", "contactInfo": { "email": "jane@example.com" } }]

Benutzer​

Basispfad: /membership/users

Informationen zu den Endpunkten für Anmeldung, Registrierung und Passwortverwaltung finden Sie unter Authentifizierung und Berechtigungen.

MethodePfadAuthBerechtigungBeschreibung
POST/loginÖffentlich—Anmelden (E-Mail/Passwort, JWT-Erneuerung oder authGuid)
POST/registerÖffentlich—Einen neuen Benutzer registrieren
POST/forgotÖffentlich—E-Mail zum Zurücksetzen des Passworts senden
POST/setPasswordGuidÖffentlich—Passwort über die Auth-GUID aus dem E-Mail-Link setzen
POST/verifyCredentialsÖffentlich—E-Mail/Passwort prüfen und zugehörige Gemeinden zurückgeben
POST/loadOrCreateJWT—Einen Benutzer anhand von E-Mail/Benutzer-ID finden oder anlegen
POST/setDisplayNameJWT—Vor- und Nachname des Benutzers aktualisieren
POST/updateEmailJWT—E-Mail-Adresse des Benutzers ändern
POST/updatePasswordJWT—Passwort des Benutzers ändern (mind. 6 Zeichen)
POST/updateOptedOutJWT—Den Status „Verzeichnis widersprochen“ einer Person setzen
POST/sendInviteEmailJWTPeople.EditEine Einladung per E-Mail an eine Person in dieser Gemeinde senden (email, personName, contextName). Die Schaltfläche lautet Sign Up für Personen ohne Konto und Log In für bestehende Benutzer. Ein Benutzer, der sich noch nie angemeldet hat, erhält stattdessen einen Link Set Your Password, der nach 7 Tagen abläuft. Es handelt sich um eine feste Vorlage, daher zählt sie nicht zum täglichen E-Mail-Limit der Gemeinde
GET/search?term=JWTServer.AdminAlle Benutzer nach Name/E-Mail durchsuchen
DELETE/JWT—Das Konto des aktuellen Benutzers löschen

Gemeinden​

Basispfad: /membership/churches

MethodePfadAuthBerechtigungBeschreibung
GET/JWT—Alle Gemeinden des aktuellen Benutzers laden
GET/:idJWT—Gemeinde anhand der ID abrufen
GET/:id/getDomainAdminJWT—Den Domain-Admin-Benutzer einer Gemeinde abrufen
GET/:id/impersonateJWTServer.AdminEine Gemeinde imitieren (nur Server-Admin)
GET/all?term=JWTServer.AdminAlle Gemeinden durchsuchen (Admin)
GET/search/?name=Öffentlich—Gemeinden nach Name durchsuchen
GET/lookup/?subDomain=&id=Öffentlich—Eine Gemeinde anhand der Subdomain oder ID suchen
POST/JWTSettings.EditGemeindedetails aktualisieren
POST/addJWT—Eine neue Gemeinde registrieren. Pflichtfelder: name, address1, city, state, zip, country
POST/searchÖffentlich—Gemeinden nach Name durchsuchen (POST-Variante)
POST/selectJWT—Eine Gemeinde auswählen/wechseln. Body: { churchId } oder { subDomain }
POST/:id/archiveJWTServer.AdminEine Gemeinde archivieren oder das Archiv aufheben
POST/byIdsÖffentlich—Mehrere Gemeinden anhand von IDs laden
DELETE/deleteAbandonedJWTServer.AdminGemeinden löschen, die seit 7 oder mehr Tagen verlassen wurden

Gruppen​

Basispfad: /membership/groups

Erweitert das Standard-CRUD (GET /, GET /:id aus der Basisklasse).

MethodePfadAuthBerechtigungBeschreibung
GET/JWT—Alle Gruppen auflisten
GET/:idJWT—Gruppe anhand der ID abrufen
GET/search?campusId=&serviceId=&serviceTimeId=JWT—Gruppen nach Gottesdienstfiltern durchsuchen
GET/myJWT—Gruppen des aktuellen Benutzers abrufen
GET/my/:tagJWT—Gruppen des aktuellen Benutzers nach Schlagwort gefiltert abrufen
GET/tag/:tagJWT—Alle Gruppen mit einem bestimmten Schlagwort abrufen
GET/public/:churchId/:idÖffentlich—Eine öffentliche Gruppe anhand von Gemeinde und ID abrufen
GET/public/:churchId/tag/:tagÖffentlich—Öffentliche Gruppen nach Schlagwort abrufen
GET/public/:churchId/label?label=Öffentlich—Öffentliche Gruppen nach Bezeichnung abrufen
GET/public/:churchId/slug/:slugÖffentlich—Eine öffentliche Gruppe anhand des Slugs abrufen
POST/JWTGroups.EditGruppen erstellen oder aktualisieren (generiert den Slug automatisch)
DELETE/:idJWTGroups.EditEine Gruppe löschen (löscht bei Dienstbereichsgruppen auch die untergeordneten Teams)

Gruppenmitglieder​

Basispfad: /membership/groupmembers

Erweitert das Standard-CRUD (GET /:id, DELETE /:id aus der Basisklasse).

MethodePfadAuthBerechtigungBeschreibung
GET/:idJWTGroupMembers.ViewGruppenmitglied anhand der ID abrufen
GET/JWTGroupMembers.View*Gruppenmitglieder auflisten. Filtern mit ?groupId=, ?groupIds= oder ?personId=. *Ebenfalls erlaubt, wenn der Benutzer in der Gruppe ist oder die eigene personId abfragt, sowie für ?groupId= jeder nicht vertraulichen Gruppe, wenn der Benutzer Attendance.View oder Attendance.Edit besitzt (Mitglieder unter 13 Jahren werden dann einbezogen)
GET/myJWT—Gruppenmitgliedschaften des aktuellen Benutzers abrufen
GET/basic/:groupIdJWT—Einfache Mitgliederliste einer Gruppe abrufen
GET/public/leaders/:churchId/:groupIdÖffentlich—Gruppenleitungen abrufen (öffentlich)
GET/public/:churchId/:groupIdÖffentlich—Die öffentliche Teilnehmerliste einer Gruppe abrufen (minimale Felder: personId, displayName, leader, Foto). Nur wenn die Gruppe über publicRoster zustimmt; versorgt das Element staffGrid des Website-Builders
POST/JWTGroupMembers.EditGruppenmitglieder hinzufügen oder aktualisieren
DELETE/:idJWTGroupMembers.ViewEin Gruppenmitglied entfernen

Haushalte​

Basispfad: /membership/households

Standard-CRUD-Controller.

MethodePfadAuthBerechtigungBeschreibung
GET/JWT—Alle Haushalte auflisten
GET/:idJWT—Haushalt anhand der ID abrufen
POST/JWTPeople.EditHaushalte erstellen oder aktualisieren
DELETE/:idJWTPeople.EditEinen Haushalt löschen

Rollen​

Basispfad: /membership/roles

MethodePfadAuthBerechtigungBeschreibung
GET/:idJWTRoles.ViewRolle anhand der ID abrufen
GET/church/:churchIdJWTRoles.ViewAlle Rollen einer Gemeinde abrufen. Jede Rolle enthält memberCount, die Anzahl unterschiedlicher Benutzer in ihr
POST/JWTRoles.EditRollen erstellen oder aktualisieren
DELETE/:idJWTRoles.EditEine Rolle löschen (entfernt auch deren Berechtigungen und Mitglieder)

Rollenmitglieder​

Basispfad: /membership/rolemembers

MethodePfadAuthBerechtigungBeschreibung
GET/roles/:idJWTRoles.ViewMitglieder einer Rolle abrufen. Mit ?include=users werden die Benutzerdetails mitgeliefert
POST/JWTRoles.EditMitglieder einer Rolle hinzufügen (legt einen Benutzer an, falls die E-Mail noch nicht existiert)
DELETE/:idJWTRoles.ViewEin Rollenmitglied entfernen
DELETE/self/:churchId/:userIdJWT—Sich selbst aus einer Gemeinde entfernen

Rollenberechtigungen​

Basispfad: /membership/rolepermissions

MethodePfadAuthBerechtigungBeschreibung
GET/roles/:idJWTRoles.ViewBerechtigungen einer Rolle abrufen (null als ID für die Rolle „Everyone“ verwenden)
POST/JWTRoles.EditRollenberechtigungen erstellen oder aktualisieren
DELETE/:idJWTRoles.EditEine Rollenberechtigung löschen

Berechtigungen​

Basispfad: /membership/permissions

MethodePfadAuthBerechtigungBeschreibung
GET/JWT—Die vollständige Liste der verfügbaren Berechtigungen abrufen

Jeder Eintrag enthält apiName, section (Inhaltstyp), action sowie die Bezeichnungen displaySection / displayAction, die der Rollen-Editor von B1Admin anzeigt. Neuere Ergänzungen sind MembershipApi / People / View Names (View People Names Only, unter Personen und Gruppen) und GivingApi / Donations / Enter (Enter Donations, unter Spenden; siehe Spendenstapel).

Formulare​

Basispfad: /membership/forms

MethodePfadAuthBerechtigungBeschreibung
GET/JWTForms.Admin oder Forms.EditAlle Formulare auflisten (Admins sehen alle; Bearbeiter sehen zugewiesene und Nicht-Mitgliederformulare)
GET/:idJWTFormularzugriffEin Formular anhand der ID abrufen
GET/archivedJWTForms.Admin oder Forms.EditArchivierte Formulare auflisten
GET/group/:groupIdJWTGruppenmitglied, Gruppenleitung oder Forms.AdminEigenständige Formulare, die mit der Gruppe verknüpft sind (forms.groupId), ohne archivierte, sortiert nach Name. Gibt id, name, description und open (innerhalb des Verfügbarkeitszeitraums) zurück. Mitglieder erhalten nur geöffnete Formulare; Leitungen und Formularadministratoren erhalten auch geschlossene. Versorgt die verknüpften Formulare auf der Gruppenseite
GET/standalone/:id?churchId=JWT—Ein eigenständiges Formular abrufen (eingeschränkte Formulare erfordern Anmeldung)
POST/JWTForms.Admin oder Forms.EditFormulare erstellen oder aktualisieren. Eigenständige Formulare akzeptieren ein optionales photoUrl (Kopfzeilenfoto über dem Formular) und groupId (verknüpfte Gruppe)
DELETE/:idJWTFormularzugriffEin Formular löschen

Formularübermittlungen​

Basispfad: /membership/formsubmissions

MethodePfadAuthBerechtigungBeschreibung
GET/JWTForms.Admin oder Forms.EditÜbermittlungen auflisten. Filtern mit ?personId= oder ?formId=
GET/my?include=questions,answersJWT—Nur eigene Daten: bis zu 50 eigenständige Formularübermittlungen (keine Personenformulare), die der angemeldete Benutzer abgesendet hat oder die mit seiner Person verknüpft sind (contentType person, contentId = seine Personen-ID — etwa nach einer Änderung durch einen Admin), die neuesten zuerst, jeweils mit form.name. include hängt die Fragen jedes Formulars und die Antworten der Übermittlung an. Gibt 401 zurück, wenn der Benutzer keiner Person zugeordnet ist. Versorgt den Bereich My Forms der Seite B1 Me
GET/group/:groupIdJWTLeitung der GruppeAntworten für die Gruppenleitungen: ein Eintrag pro verknüpftem Formular und pro Gruppenereignis mit Anmeldeformular, jeweils mit form, event (id, title, start; nur bei Ereigniseinträgen), questions und submissions (mit answers und personName, null bei anonymen Übermittlungen)
GET/:idJWTForms.Admin, Forms.Edit oder AnsichtszugriffÜbermittlung anhand der ID abrufen. Mit ?include=form,questions,answers werden Formular, Fragen und Antworten mitgeliefert. Leitungen der verknüpften Gruppe des Formulars sowie Leitungen der Gruppe, zu der eine Ereignisanmeldung gehört, können sie ebenfalls lesen
GET/formId/:formIdJWTFormularzugriff (Ansicht)Alle Übermittlungen eines Formulars abrufen (mit Formular, Fragen und Antworten). Leitungen der verknüpften Gruppe des Formulars haben Ansichtszugriff
POST/JWT—Formularantworten übermitteln (verarbeitet eingeschränkte und nicht eingeschränkte Formulare, versendet E-Mail-Benachrichtigungen). Wenn das Formular autoCreatePerson hat, wird anhand der E-Mail eine Gastperson gesucht oder angelegt und die Übermittlung verknüpft; wenn das Formular außerdem eine groupId hat, wird die Person der Gruppe hinzugefügt; sind followUpSubject/followUpBody gesetzt, wird dem Absender eine vorlagenbasierte Nachfass-E-Mail gesendet. Sofern der Aufrufer das Formular nicht verwalten kann, wird submittedBy immer auf die Person des angemeldeten Mitglieds gesetzt (bei anonymen Übermittlungen leer)
DELETE/:idJWTForms.Admin oder Forms.EditEine Übermittlung und ihre Antworten löschen

Fragen​

Basispfad: /membership/questions

MethodePfadAuthBerechtigungBeschreibung
GET/JWTFormularzugriffFragen eines Formulars auflisten. Erfordert ?formId=
GET/:idJWTFormularzugriffEine Frage anhand der ID abrufen
GET/unrestricted?formId=JWT—Fragen eines nicht eingeschränkten Formulars abrufen
GET/sort/:id/upJWT—Eine Frage in der Sortierreihenfolge nach oben verschieben
GET/sort/:id/downJWT—Eine Frage in der Sortierreihenfolge nach unten verschieben
POST/JWTFormularzugriffFragen erstellen oder aktualisieren (vergibt die Sortierreihenfolge automatisch)
DELETE/:id?formId=JWTFormularzugriffEine Frage löschen

Antworten​

Basispfad: /membership/answers

MethodePfadAuthBerechtigungBeschreibung
GET/JWTForms.Admin oder Forms.EditAntworten auflisten. Filtern mit ?formSubmissionId=
POST/JWTForms.Admin oder Forms.EditAntworten erstellen oder aktualisieren

Mitgliederberechtigungen​

Basispfad: /membership/memberpermissions

Steuert den Zugriff einzelner Mitglieder auf bestimmte Formulare.

MethodePfadAuthBerechtigungBeschreibung
GET/:idJWTFormularzugriffEine Mitgliederberechtigung anhand der ID abrufen
GET/member/:idJWTFormularzugriffAlle Formularberechtigungen eines Mitglieds abrufen
GET/form/:idJWTFormularzugriffAlle Mitgliederberechtigungen eines Formulars abrufen
GET/form/:id/myJWTFormularzugriffBerechtigung des aktuellen Benutzers für ein Formular abrufen
POST/JWTFormularzugriffMitgliederberechtigungen erstellen oder aktualisieren
DELETE/:id?formId=JWTFormularzugriffEine Mitgliederberechtigung löschen
DELETE/member/:id?formId=JWTFormularzugriffAlle Berechtigungen eines Mitglieds für ein Formular löschen

Einstellungen​

Basispfad: /membership/settings

MethodePfadAuthBerechtigungBeschreibung
GET/JWTSettings.EditAlle Einstellungen der Gemeinde abrufen
GET/public/:churchIdÖffentlich—Öffentliche Einstellungen einer Gemeinde abrufen
POST/JWTSettings.EditEinstellungen speichern (unterstützt den Upload von Bildern als Base64)

Domains​

Basispfad: /membership/domains

Erweitert das Standard-CRUD (GET /:id, GET /, DELETE /:id aus der Basisklasse).

MethodePfadAuthBerechtigungBeschreibung
GET/JWT—Alle Domains auflisten
GET/:idJWT—Domain anhand der ID abrufen
GET/lookup/:domainNameJWT—Eine Domain anhand des Namens suchen
GET/public/lookup/:domainNameÖffentlich—Öffentliche Suche einer Domain anhand des Namens
GET/health/checkÖffentlich—Zustandsprüfung für nicht geprüfte Domains ausführen
POST/JWTSettings.EditDomains erstellen oder aktualisieren (löst eine Aktualisierung von Caddy aus)
DELETE/:idJWTSettings.EditEine Domain löschen

Benutzer-Gemeinde-Zuordnung​

Basispfad: /membership/userchurch

Verwaltet die Zuordnung zwischen Benutzern und Gemeinden.

MethodePfadAuthBerechtigungBeschreibung
GET/userid/:userIdJWT—Benutzer-Gemeinde-Datensatz anhand der Benutzer-ID abrufen
GET/personid/:personIdJWT—E-Mail des mit einer Person verknüpften Benutzers abrufen
GET/user/:userIdJWTServer.AdminAlle Gemeinden eines Benutzers laden
POST/JWT—Eine Benutzer-Gemeinde-Zuordnung erstellen
PATCH/:userIdJWT—Zeitpunkt des letzten Zugriffs aktualisieren und den Zugriff protokollieren
DELETE/record/:userId/:churchId/:personIdJWT—Einen Benutzer-Gemeinde-Datensatz löschen

Sichtbarkeitseinstellungen​

Basispfad: /membership/visibilityPreferences

MethodePfadAuthBerechtigungBeschreibung
GET/myJWT—Sichtbarkeitseinstellungen des aktuellen Benutzers abrufen
POST/JWT—Sichtbarkeitseinstellungen speichern (Sichtbarkeit von Adresse, Telefon und E-Mail)

Abfrage​

Basispfad: /membership/query

MethodePfadAuthBerechtigungBeschreibung
POST/membersJWT—Mitgliedersuche in natürlicher Sprache mit KI. Body: { text, subDomain, siteUrl }

Client-Fehler​

Basispfad: /membership/clientErrors

MethodePfadAuthBerechtigungBeschreibung
POST/JWT—Einen clientseitigen Fehler protokollieren

Verwandte Seiten​