Hopp til hovedinnhold

Medlemskapsendepunkter

Medlemskapsmodulen administrerer personer, kirker, grupper, husstander, roller, tillatelser, skjemaer og innstillinger. Det er den største modulen, og den gir identitets- og autorisasjonslaget for alle andre moduler.

Basisti: /membership

Personer​

Basisti: /membership/people

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWTPeople.View eller MemberList alle personer for kirken
GET/:idJWTPeople.View eller egen postHent en person etter ID (inkluderer skjemainnsendinger)
GET/ids?ids=JWTPeople.View, Member eller People.ViewNamesHent flere personer etter kommaseparerte ID-er. Innringere med People.ViewNames uten People.View får den grunnleggende modellen, med personer som har reservert seg utelatt (unntatt innringeren)
GET/basic?ids=JWT—Hent grunnleggende info (bare navn) for flere personer
GET/names?ids=JWTEnhver kirkelig tillatelse[{ id, name: { display, first, last }, photo }], sortert etter etternavn og deretter fornavn, for kommaseparerte ID-er som innringeren allerede har tilgang til, slik at roller uten People.View (gaver, oppmøte) kan merke personer. Ingen søk, ingen katalogfilter
POST/namesJWTEnhver kirkelig tillatelseSamme som GET /names. Body: { peopleIds } (eller { ids })
GET/recentJWTPeople.View, Member eller People.ViewNamesNylig lagte personer. Innringere med People.ViewNames uten People.View (selv medlemmer med katalogtilgang) får den grunnleggende modellen (id, name.display, photo, membershipStatus) med personer som har reservert seg utelatt
GET/guest-register/options?churchId=Offentlig—Sjekkliste for QR-gjesteregistrering: returnerer { email, phone, address, birthDate, gender, maritalStatus, grade, comments }, hver med "off", "optional" eller "required" (tolket fra den offentlige innstillingen guestRegistrationFields; manglende eller ugyldige verdier faller tilbake til e-post/telefon valgfritt, resten av). Krever enableQRGuestRegistration med mindre forespørselen bærer et samsvarende nettsted- eller kirketoken; hastighetsbegrenset (429)
GET/search?term=&email=JWTPeople.View, Member eller People.ViewNamesSøk etter personer på navn eller e-post (opptil 100, sortert etter etternavn og deretter fornavn). Innringere med People.ViewNames uten People.View (selv medlemmer med katalogtilgang) får et navnesøk som returnerer den grunnleggende modellen; et email-søk returnerer []
GET/search/phone?number=JWTPeople.View eller MemberSøk etter telefonnummer
GET/search/group?groupId=JWTPeople.View eller MemberHent personer i en bestemt gruppe
GET/household/:householdIdJWT—Hent alle personer i en husstand
GET/attendanceJWTPeople.EditLast deltakere med filtre (campusId, serviceId, serviceTimeId, groupId, categoryName, startDate, endDate)
GET/timeline?personIds=&groupIds=JWT—Last tidslinjedata for personer og grupper
GET/directory/:idJWT—Hent person for katalogvisningen (respekterer synlighetsinnstillinger)
GET/claim/:churchIdJWT—Knytt en personpost til den innloggede brukeren i en kirke
POST/JWTPeople.Edit eller EditSelfOpprett eller oppdater personer (bunt)
POST/searchJWTPeople.View, Member eller People.ViewNamesSøk etter personer (POST-variant). Body: { term } eller { email }; samme regler for kun navn som GET /search
POST/advancedSearchJWTPeople.View eller MemberSøk med flere betingelser (alder, birthMonth, membershipStatus osv.). Body er en matrise med betingelser; en tom body betyr ingen betingelser, og enhver annen body som ikke er en matrise returnerer 400
POST/loadOrCreateOffentlig—Finn eller opprett en person etter e-post. Body: { churchId, email, firstName, lastName }
POST/guest-registerOffentlig—QR-gjesteregistrering. Body: { churchId, members: [{ firstName, lastName, email?, phone?, birthDate?, gender?, grade? }], address?, maritalStatus?, comments? } (1–10 medlemmer; email/phone/maritalStatus gjelder bare for det første medlemmet). Felt kirken har slått av fjernes; manglende påkrevde eller ugyldige verdier gir 400. Først gjenbrukes eksisterende personer: et medlem samsvarer når nøyaktig én ikke-fjernet person har samme fornavn (uten hensyn til store/små bokstaver) og samme e-post eller telefonsiffer (hjem, jobb eller mobil); et medlem uten e-post eller telefon samsvarer på fornavn innenfor den samsvarende husstanden. Samsvarende personer redigeres aldri. Ikke-samsvarende medlemmer blir med i den samsvarende husstanden, eller ellers en ny husstand (oppkalt etter det første medlemmets etternavn), som membershipStatus: "Visitor" med den delte address. Lagrer comments som et notat på det første medlemmet, legger alle til i den private gruppen guestRegistrationGroupId hvis den er satt, og — når guestRegistrationRecordAttendance er "true" — registrerer oppmøte for gruppens planlagte gudstjenestetider som har et åpent innsjekkingsvindu nå. Returnerer { householdId, people: [{ id, name }] }, og gjentar de innsendte navnene i stedet for de lagrede. Samme samtykke-/tokenregler og hastighetsbegrensning som for alternativkallet
POST/household/:householdIdJWTPeople.EditOppdater tilordninger av husstandsmedlemmer
POST/public/emailOffentlig—Send en e-post til en person. Body: { churchId, personId, subject, body, appName }
POST/apiEmailsIntern—Last personers e-poster etter ID-er (server-til-server, krever jwtSecret)
DELETE/:idJWTPeople.EditSlett en person

Eksempel: Søk etter personer​

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

Eksempel: Opprett en person​

POST /membership/people
Authorization: Bearer <token>

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

Brukere​

Basisti: /membership/users

Se Autentisering og tillatelser for endepunkter for innlogging, registrering og passordhåndtering.

MetodeStiAutentiseringTillatelseBeskrivelse
POST/loginOffentlig—Logg inn (e-post/passord, fornying av JWT eller authGuid)
POST/registerOffentlig—Registrer en ny bruker
POST/forgotOffentlig—Send e-post for tilbakestilling av passord
POST/setPasswordGuidOffentlig—Sett passord med auth-GUID fra e-postlenken
POST/verifyCredentialsOffentlig—Verifiser e-post/passord og returner tilknyttede kirker
POST/loadOrCreateJWT—Finn eller opprett en bruker etter e-post/bruker-ID
POST/setDisplayNameJWT—Oppdater brukerens fornavn og etternavn
POST/updateEmailJWT—Endre brukerens e-postadresse
POST/updatePasswordJWT—Endre brukerens passord (minst 6 tegn)
POST/updateOptedOutJWT—Sett en persons reservasjonsstatus
POST/sendInviteEmailJWTPeople.EditSend en invitasjon til en person i denne kirken (email, personName, contextName). Knappen står på Registrer deg for en person uten konto og Logg inn for en eksisterende bruker. En bruker som aldri har logget inn, får i stedet en lenke Sett ditt passord som utløper om 7 dager. En fast mal, så den teller ikke mot kirkens daglige e-postgrense
GET/search?term=JWTServer.AdminSøk etter alle brukere på navn/e-post
DELETE/JWT—Slett den innloggede brukerens konto

Kirker​

Basisti: /membership/churches

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWT—Last alle kirker for den innloggede brukeren
GET/:idJWT—Hent kirke etter ID
GET/:id/getDomainAdminJWT—Hent domeneadministratoren for en kirke
GET/:id/impersonateJWTServer.AdminUtgi deg for en kirke (kun serveradministrator)
GET/all?term=JWTServer.AdminSøk i alle kirker (admin)
GET/search/?name=Offentlig—Søk etter kirker på navn
GET/lookup/?subDomain=&id=Offentlig—Slå opp en kirke etter underdomene eller ID
POST/JWTSettings.EditOppdater kirkedetaljer
POST/addJWT—Registrer en ny kirke. Obligatoriske felt: name, address1, city, state, zip, country
POST/searchOffentlig—Søk etter kirker på navn (POST-variant)
POST/selectJWT—Velg/bytt til en kirke. Body: { churchId } eller { subDomain }
POST/:id/archiveJWTServer.AdminArkiver eller opphev arkivering av en kirke
POST/byIdsOffentlig—Last flere kirker etter ID-er
DELETE/deleteAbandonedJWTServer.AdminSlett kirker som har vært forlatt i 7+ dager

Grupper​

Basisti: /membership/groups

Utvider standard CRUD (GET /, GET /:id fra basisklassen).

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWT—List alle grupper
GET/:idJWT—Hent gruppe etter ID
GET/search?campusId=&serviceId=&serviceTimeId=JWT—Søk etter grupper med gudstjenestefiltre
GET/myJWT—Hent grupper for den innloggede brukeren
GET/my/:tagJWT—Hent den innloggede brukerens grupper filtrert etter merkelapp
GET/tag/:tagJWT—Hent alle grupper med en bestemt merkelapp
GET/public/:churchId/:idOffentlig—Hent en offentlig gruppe etter kirke og ID
GET/public/:churchId/tag/:tagOffentlig—Hent offentlige grupper etter merkelapp
GET/public/:churchId/label?label=Offentlig—Hent offentlige grupper etter etikett
GET/public/:churchId/slug/:slugOffentlig—Hent en offentlig gruppe etter slug
POST/JWTGroups.EditOpprett eller oppdater grupper (genererer slug automatisk)
DELETE/:idJWTGroups.EditSlett en gruppe (sletter også underordnede team for tjenestegrupper)

Gruppemedlemmer​

Basisti: /membership/groupmembers

Utvider standard CRUD (GET /:id, DELETE /:id fra basisklassen).

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWTGroupMembers.ViewHent gruppemedlem etter ID
GET/JWTGroupMembers.View*List gruppemedlemmer. Filtrer med ?groupId=, ?groupIds= eller ?personId=. *Også tillatt hvis brukeren er i gruppen eller spør etter egen personId, og for ?groupId= i enhver ikke-konfidensiell gruppe når brukeren har Attendance.View eller Attendance.Edit (medlemmer under 13 år er inkludert for dem)
GET/myJWT—Hent gjeldende brukers gruppemedlemskap
GET/basic/:groupIdJWT—Hent grunnleggende medlemsliste for en gruppe
GET/public/leaders/:churchId/:groupIdOffentlig—Hent gruppeledere (offentlig)
GET/public/:churchId/:groupIdOffentlig—Hent en gruppes offentlige liste (minimale felt: personId, displayName, leader, bilde). Bare når gruppen velger det via publicRoster; driver elementet staffGrid i nettstedsbyggeren
POST/JWTGroupMembers.EditLegg til eller oppdater gruppemedlemmer
DELETE/:idJWTGroupMembers.ViewFjern et gruppemedlem

Husstander​

Basisti: /membership/households

Standard CRUD-kontroller.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWT—List alle husstander
GET/:idJWT—Hent husstand etter ID
POST/JWTPeople.EditOpprett eller oppdater husstander
DELETE/:idJWTPeople.EditSlett en husstand

Roller​

Basisti: /membership/roles

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWTRoles.ViewHent rolle etter ID
GET/church/:churchIdJWTRoles.ViewHent alle roller for en kirke. Hver rolle inkluderer memberCount, antall distinkte brukere i den
POST/JWTRoles.EditOpprett eller oppdater roller
DELETE/:idJWTRoles.EditSlett en rolle (fjerner også dens tillatelser og medlemmer)

Rollemedlemmer​

Basisti: /membership/rolemembers

MetodeStiAutentiseringTillatelseBeskrivelse
GET/roles/:idJWTRoles.ViewHent medlemmer av en rolle. Legg til ?include=users for å inkludere brukerdetaljer
POST/JWTRoles.EditLegg til medlemmer i en rolle (oppretter bruker hvis e-posten ikke finnes)
DELETE/:idJWTRoles.ViewFjern et rollemedlem
DELETE/self/:churchId/:userIdJWT—Fjern deg selv fra en kirke

Rolletillatelser​

Basisti: /membership/rolepermissions

MetodeStiAutentiseringTillatelseBeskrivelse
GET/roles/:idJWTRoles.ViewHent tillatelser for en rolle (bruk null som ID for rollen "Everyone")
POST/JWTRoles.EditOpprett eller oppdater rolletillatelser
DELETE/:idJWTRoles.EditSlett en rolletillatelse

Tillatelser​

Basisti: /membership/permissions

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWT—Hent hele listen over tilgjengelige tillatelser

Hver oppføring har apiName, section (innholdstype), action, og etikettene displaySection / displayAction som B1Admins rolleredigeringsprogram viser. Nye tillegg: MembershipApi / People / View Names (Se kun navn på personer, under Personer og grupper) og GivingApi / Donations / Enter (Registrer gaver, under Gaver; se Gavebunter).

Skjemaer​

Basisti: /membership/forms

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWTForms.Admin eller Forms.EditList alle skjemaer (admin ser alle; redaktører ser tildelte + ikke-medlemsskjemaer)
GET/:idJWTSkjematilgangHent et skjema etter ID
GET/archivedJWTForms.Admin eller Forms.EditList arkiverte skjemaer
GET/group/:groupIdJWTGruppemedlem, gruppeleder eller Forms.AdminFrittstående skjemaer knyttet til gruppen (forms.groupId), unntatt arkiverte, sortert etter navn. Returnerer id, name, description og open (innenfor tilgjengelighetsvinduet). Medlemmer får bare åpne skjemaer; ledere og skjemaadministratorer får også stengte. Driver gruppesidens koblede skjemaer
GET/standalone/:id?churchId=JWT—Hent et frittstående skjema (begrensede skjemaer krever autentisering)
POST/JWTForms.Admin eller Forms.EditOpprett eller oppdater skjemaer. Frittstående skjemaer godtar valgfri photoUrl (overskriftsbilde vist over skjemaet) og groupId (koblet gruppe)
DELETE/:idJWTSkjematilgangSlett et skjema

Skjemainnsendinger​

Basisti: /membership/formsubmissions

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWTForms.Admin eller Forms.EditList innsendinger. Filtrer med ?personId= eller ?formId=
GET/my?include=questions,answersJWT—Selvavgrenset: opptil 50 frittstående skjemainnsendinger (ikke personskjemaer) som den innloggede medlemmen sendte inn, eller som er knyttet til deres person (contentType person, contentId = deres personid — for eksempel etter en administrators endring av person), nyeste først, hver med form.name. include legger til hvert skjemas spørsmål og innsendingens svar. Returnerer 401 hvis brukeren ikke er knyttet til en person. Driver seksjonen Mine skjemaer på B1 Meg-siden
GET/group/:groupIdJWTLeder av gruppenSvar for gruppens ledere: én oppføring per koblet skjema og per gruppearrangement med et påmeldingsskjema, hver med form, event (id, title, start; bare arrangementsoppføringer), questions og submissions (med answers og personName, null når anonym)
GET/:idJWTForms.Admin, Forms.Edit eller visningstilgangHent innsending etter ID. Legg til ?include=form,questions,answers. Ledere av skjemaets koblede gruppe, og ledere av gruppen en arrangementspåmelding tilhører, kan også lese den
GET/formId/:formIdJWTSkjematilgang (visning)Hent alle innsendinger for et skjema (inkluderer skjema, spørsmål, svar). Ledere av skjemaets koblede gruppe har visningstilgang
POST/JWT—Send inn skjemasvar (håndterer begrensede/ubegrensede skjemaer, sender e-postvarsler). Når skjemaet har autoCreatePerson, finner eller oppretter den en gjestperson etter e-post og knytter innsendingen; når skjemaet også har en groupId, legges personen til i gruppen; når followUpSubject/followUpBody er satt, sendes en mal-basert oppfølgings-e-post til innsenderen. Med mindre den som kaller kan administrere skjemaet, settes submittedBy alltid til den innloggede medlemmets person (eller tomt for anonyme innsendinger)
DELETE/:idJWTForms.Admin eller Forms.EditSlett en innsending og dens svar

Spørsmål​

Basisti: /membership/questions

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWTSkjematilgangList spørsmål for et skjema. Krever ?formId=
GET/:idJWTSkjematilgangHent et spørsmål etter ID
GET/unrestricted?formId=JWT—Hent spørsmål for et ubegrenset skjema
GET/sort/:id/upJWT—Flytt et spørsmål opp i sorteringsrekkefølgen
GET/sort/:id/downJWT—Flytt et spørsmål ned i sorteringsrekkefølgen
POST/JWTSkjematilgangOpprett eller oppdater spørsmål (tildeler sorteringsrekkefølge automatisk)
DELETE/:id?formId=JWTSkjematilgangSlett et spørsmål

Svar​

Basisti: /membership/answers

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWTForms.Admin eller Forms.EditList svar. Filtrer med ?formSubmissionId=
POST/JWTForms.Admin eller Forms.EditOpprett eller oppdater svar

Medlemstillatelser​

Basisti: /membership/memberpermissions

Styrer tilgang per medlem til bestemte skjemaer.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWTSkjematilgangHent en medlemstillatelse etter ID
GET/member/:idJWTSkjematilgangHent alle skjematillatelser for et medlem
GET/form/:idJWTSkjematilgangHent alle medlemstillatelser for et skjema
GET/form/:id/myJWTSkjematilgangHent gjeldende brukers tillatelse for et skjema
POST/JWTSkjematilgangOpprett eller oppdater medlemstillatelser
DELETE/:id?formId=JWTSkjematilgangSlett en medlemstillatelse
DELETE/member/:id?formId=JWTSkjematilgangSlett alle tillatelser for et medlem på et skjema

Innstillinger​

Basisti: /membership/settings

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWTSettings.EditHent alle innstillinger for kirken
GET/public/:churchIdOffentlig—Hent offentlige innstillinger for en kirke
POST/JWTSettings.EditLagre innstillinger (støtter base64-bildeopplasting)

Domener​

Basisti: /membership/domains

Utvider standard CRUD (GET /:id, GET /, DELETE /:id fra basisklassen).

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWT—List alle domener
GET/:idJWT—Hent domene etter ID
GET/lookup/:domainNameJWT—Slå opp et domene etter navn
GET/public/lookup/:domainNameOffentlig—Offentlig domeneoppslag etter navn
GET/health/checkOffentlig—Kjør helsesjekk på ukontrollerte domener
POST/JWTSettings.EditOpprett eller oppdater domener (utløser oppdatering av Caddy)
DELETE/:idJWTSettings.EditSlett et domene

Brukerkirke​

Basisti: /membership/userchurch

Administrerer koblingen mellom brukere og kirker.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/userid/:userIdJWT—Hent bruker-kirke-post etter bruker-ID
GET/personid/:personIdJWT—Hent e-post for en persons koblede bruker
GET/user/:userIdJWTServer.AdminLast alle kirker for en bruker
POST/JWT—Opprett en kobling mellom bruker og kirke
PATCH/:userIdJWT—Oppdater tidspunkt for sist tilgang og logg tilgangen
DELETE/record/:userId/:churchId/:personIdJWT—Slett en bruker-kirke-post

Synlighetsinnstillinger​

Basisti: /membership/visibilityPreferences

MetodeStiAutentiseringTillatelseBeskrivelse
GET/myJWT—Hent gjeldende brukers synlighetsinnstillinger
POST/JWT—Lagre synlighetsinnstillinger (synlighet for adresse, telefon og e-post)

Spørring​

Basisti: /membership/query

MetodeStiAutentiseringTillatelseBeskrivelse
POST/membersJWT—Naturlig språk-søk etter medlemmer med AI. Body: { text, subDomain, siteUrl }

Klientfeil​

Basisti: /membership/clientErrors

MetodeStiAutentiseringTillatelseBeskrivelse
POST/JWT—Logg en feil på klientsiden

Relaterte sider​