Vai al contenuto principale

Endpoint Membership

Il modulo Membership gestisce persone, chiese, gruppi, nuclei familiari, ruoli, permessi, moduli e impostazioni. È il modulo più grande e fornisce il livello di identità e autorizzazione di base per tutti gli altri moduli.

Percorso base: /membership

Persone​

Percorso base: /membership/people

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWTPeople.View oppure MemberElenca tutte le persone della chiesa
GET/:idJWTPeople.View oppure il proprio recordOttiene una persona per ID (include le risposte ai moduli)
GET/ids?ids=JWTPeople.View, Member oppure People.ViewNamesOttiene più persone tramite ID separati da virgole. I chiamanti con People.ViewNames senza People.View ricevono il modello base, con le persone che hanno rifiutato escluse (tranne il chiamante)
GET/basic?ids=JWT—Ottiene le informazioni di base (solo nome) per più persone
GET/names?ids=JWTQualsiasi permesso della chiesa[{ id, name: { display, first, last }, photo }], ordinato per cognome e poi per nome, per gli ID separati da virgole che il chiamante già possiede, così i ruoli senza People.View (donazioni, presenze) possono etichettare le persone. Nessuna ricerca, nessun filtro della rubrica
POST/namesJWTQualsiasi permesso della chiesaUguale a GET /names. Corpo: { peopleIds } (oppure { ids })
GET/recentJWTPeople.View, Member oppure People.ViewNamesPersone aggiunte di recente. I chiamanti con People.ViewNames senza People.View (anche i membri con accesso alla rubrica) ricevono il modello base (id, name.display, photo, membershipStatus) con le persone che hanno rifiutato escluse
GET/guest-register/options?churchId=Pubblico—Elenco di controllo per l'iscrizione ospiti tramite QR: restituisce { email, phone, address, birthDate, gender, maritalStatus, grade, comments }, ciascuno "off", "optional" oppure "required" (letto dall'impostazione pubblica guestRegistrationFields; valori mancanti o malformati ricadono su email/telefono facoltativi, gli altri disattivati). Richiede enableQRGuestRegistration a meno che la richiesta non porti un token di sito/chiesa corrispondente; limitato per frequenza (429)
GET/search?term=&email=JWTPeople.View, Member oppure People.ViewNamesCerca persone per nome o email (fino a 100, ordinate per cognome e poi per nome). I chiamanti con People.ViewNames senza People.View (anche i membri con accesso alla rubrica) ricevono una ricerca per nome che restituisce il modello base; una ricerca per email restituisce []
GET/search/phone?number=JWTPeople.View oppure MemberCerca per numero di telefono
GET/search/group?groupId=JWTPeople.View oppure MemberOttiene le persone di un gruppo specifico
GET/household/:householdIdJWT—Ottiene tutte le persone di un nucleo familiare
GET/attendanceJWTPeople.EditCarica i partecipanti con filtri (campusId, serviceId, serviceTimeId, groupId, categoryName, startDate, endDate)
GET/timeline?personIds=&groupIds=JWT—Carica i dati della timeline per persone e gruppi
GET/directory/:idJWT—Ottiene la persona per la vista della rubrica (rispetta le preferenze di visibilità)
GET/claim/:churchIdJWT—Rivendica un record persona per l'utente corrente presso una chiesa
POST/JWTPeople.Edit oppure EditSelfCrea o aggiorna le persone (batch)
POST/searchJWTPeople.View, Member oppure People.ViewNamesRicerca persone (variante POST). Corpo: { term } oppure { email }; stesse regole solo-nomi di GET /search
POST/advancedSearchJWTPeople.View oppure MemberRicerca con più condizioni (età, birthMonth, membershipStatus, ecc.). Il corpo è un array di condizioni; un corpo vuoto significa nessuna condizione, e qualsiasi altro corpo non array restituisce 400
POST/loadOrCreatePubblico—Trova o crea una persona tramite email. Corpo: { churchId, email, firstName, lastName }
POST/guest-registerPubblico—Iscrizione ospiti tramite QR. Corpo: { churchId, members: [{ firstName, lastName, email?, phone?, birthDate?, gender?, grade? }], address?, maritalStatus?, comments? } (da 1 a 10 membri; email/phone/maritalStatus si applicano solo al primo membro). Campi disattivati dalla chiesa vengono scartati; valori obbligatori mancanti o non validi restituiscono 400. Prima riutilizza le persone esistenti: un membro corrisponde quando esattamente una persona non rimossa ha lo stesso nome (senza distinzione tra maiuscole e minuscole) e la stessa email o le stesse cifre del telefono (casa, lavoro o cellulare); un membro senza email o telefono corrisponde per nome all'interno del nucleo familiare abbinato. Le persone abbinate non vengono mai modificate. I membri non abbinati entrano nel nucleo abbinato, oppure in un nuovo nucleo (con il nome del cognome del primo membro), come membershipStatus: "Visitor" con l'address condiviso. Salva comments come nota sul primo membro, aggiunge tutti al gruppo privato guestRegistrationGroupId se impostato e, quando guestRegistrationRecordAttendance è "true", registra la presenza per gli orari di culto programmati di quel gruppo la cui finestra di check-in è aperta in questo momento. Restituisce { householdId, people: [{ id, name }] }, ripetendo i nomi inviati anziché quelli memorizzati. Stesse regole di opt-in/token e di limite di frequenza della chiamata delle opzioni
POST/household/:householdIdJWTPeople.EditAggiorna le assegnazioni dei membri del nucleo familiare
POST/public/emailPubblico—Invia un'email a una persona. Corpo: { churchId, personId, subject, body, appName }
POST/apiEmailsInterno—Carica le email delle persone tramite ID (server-to-server, richiede jwtSecret)
DELETE/:idJWTPeople.EditElimina una persona

Esempio: cercare persone​

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

Esempio: creare una persona​

POST /membership/people
Authorization: Bearer <token>

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

Utenti​

Percorso base: /membership/users

Vedi Autenticazione e permessi per gli endpoint di accesso, registrazione e gestione delle password.

MetodoPercorsoAutenticazionePermessoDescrizione
POST/loginPubblico—Accesso (email/password, rinnovo JWT o authGuid)
POST/registerPubblico—Registra un nuovo utente
POST/forgotPubblico—Invia un'email di reimpostazione della password
POST/setPasswordGuidPubblico—Imposta la password usando il GUID di autenticazione del link via email
POST/verifyCredentialsPubblico—Verifica email/password e restituisce le chiese associate
POST/loadOrCreateJWT—Trova o crea un utente tramite email/userId
POST/setDisplayNameJWT—Aggiorna nome e cognome dell'utente
POST/updateEmailJWT—Cambia l'indirizzo email dell'utente
POST/updatePasswordJWT—Cambia la password dell'utente (minimo 6 caratteri)
POST/updateOptedOutJWT—Imposta lo stato di esclusione di una persona
POST/sendInviteEmailJWTPeople.EditInvia via email un invito a una persona di questa chiesa (email, personName, contextName). Il pulsante riporta Sign Up per chi non ha un account e Log In per un utente esistente. Un utente che non ha mai effettuato l'accesso riceve invece un link Set Your Password che scade dopo 7 giorni. È un modello fisso, quindi non conta nel limite giornaliero di email della chiesa
GET/search?term=JWTServer.AdminCerca tutti gli utenti per nome/email
DELETE/JWT—Elimina l'account utente corrente

Chiese​

Percorso base: /membership/churches

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Carica tutte le chiese dell'utente corrente
GET/:idJWT—Ottiene una chiesa per ID
GET/:id/getDomainAdminJWT—Ottiene l'utente amministratore di dominio di una chiesa
GET/:id/impersonateJWTServer.AdminImpersona una chiesa (solo amministratore del server)
GET/all?term=JWTServer.AdminCerca in tutte le chiese (amministratore)
GET/search/?name=Pubblico—Cerca chiese per nome
GET/lookup/?subDomain=&id=Pubblico—Cerca una chiesa per sottodominio o ID
POST/JWTSettings.EditAggiorna i dettagli della chiesa
POST/addJWT—Registra una nuova chiesa. Campi obbligatori: name, address1, city, state, zip, country
POST/searchPubblico—Cerca chiese per nome (variante POST)
POST/selectJWT—Seleziona/passa a una chiesa. Corpo: { churchId } oppure { subDomain }
POST/:id/archiveJWTServer.AdminArchivia o ripristina una chiesa
POST/byIdsPubblico—Carica più chiese tramite ID
DELETE/deleteAbandonedJWTServer.AdminElimina le chiese abbandonate da 7+ giorni

Gruppi​

Percorso base: /membership/groups

Estende il CRUD standard (GET /, GET /:id dalla classe base).

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Elenca tutti i gruppi
GET/:idJWT—Ottiene un gruppo per ID
GET/search?campusId=&serviceId=&serviceTimeId=JWT—Cerca gruppi tramite filtri sui culti
GET/myJWT—Ottiene i gruppi dell'utente corrente
GET/my/:tagJWT—Ottiene i gruppi dell'utente corrente filtrati per tag
GET/tag/:tagJWT—Ottiene tutti i gruppi con un tag specifico
GET/public/:churchId/:idPubblico—Ottiene un gruppo pubblico per chiesa e ID
GET/public/:churchId/tag/:tagPubblico—Ottiene i gruppi pubblici per tag
GET/public/:churchId/label?label=Pubblico—Ottiene i gruppi pubblici per etichetta
GET/public/:churchId/slug/:slugPubblico—Ottiene un gruppo pubblico tramite slug
POST/JWTGroups.EditCrea o aggiorna i gruppi (genera automaticamente lo slug)
DELETE/:idJWTGroups.EditElimina un gruppo (elimina anche le squadre figlie per i gruppi di ministero)

Membri del gruppo​

Percorso base: /membership/groupmembers

Estende il CRUD standard (GET /:id, DELETE /:id dalla classe base).

MetodoPercorsoAutenticazionePermessoDescrizione
GET/:idJWTGroupMembers.ViewOttiene un membro del gruppo per ID
GET/JWTGroupMembers.View*Elenca i membri del gruppo. Filtra con ?groupId=, ?groupIds= oppure ?personId=. *Consentito anche se l'utente è nel gruppo o chiede il proprio personId, e per ?groupId= di qualsiasi gruppo non riservato quando l'utente ha Attendance.View oppure Attendance.Edit (sono inclusi i membri under 13 per loro)
GET/myJWT—Ottiene le appartenenze ai gruppi dell'utente corrente
GET/basic/:groupIdJWT—Ottiene l'elenco base dei membri di un gruppo
GET/public/leaders/:churchId/:groupIdPubblico—Ottiene i leader di un gruppo (pubblico)
GET/public/:churchId/:groupIdPubblico—Ottiene l'elenco pubblico di un gruppo (campi minimi: personId, displayName, leader, foto). Solo quando il gruppo aderisce tramite publicRoster; alimenta l'elemento staffGrid del costruttore di siti web
POST/JWTGroupMembers.EditAggiunge o aggiorna i membri del gruppo
DELETE/:idJWTGroupMembers.ViewRimuove un membro del gruppo

Nuclei familiari​

Percorso base: /membership/households

Controller CRUD standard.

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Elenca tutti i nuclei familiari
GET/:idJWT—Ottiene un nucleo familiare per ID
POST/JWTPeople.EditCrea o aggiorna i nuclei familiari
DELETE/:idJWTPeople.EditElimina un nucleo familiare

Ruoli​

Percorso base: /membership/roles

MetodoPercorsoAutenticazionePermessoDescrizione
GET/:idJWTRoles.ViewOttiene un ruolo per ID
GET/church/:churchIdJWTRoles.ViewOttiene tutti i ruoli di una chiesa. Ogni ruolo include memberCount, il numero di utenti distinti che vi appartengono
POST/JWTRoles.EditCrea o aggiorna i ruoli
DELETE/:idJWTRoles.EditElimina un ruolo (rimuove anche i suoi permessi e i suoi membri)

Membri dei ruoli​

Percorso base: /membership/rolemembers

MetodoPercorsoAutenticazionePermessoDescrizione
GET/roles/:idJWTRoles.ViewOttiene i membri di un ruolo. Aggiungi ?include=users per includere i dettagli degli utenti
POST/JWTRoles.EditAggiunge membri a un ruolo (crea l'utente se l'email non esiste)
DELETE/:idJWTRoles.ViewRimuove un membro di un ruolo
DELETE/self/:churchId/:userIdJWT—Rimuove se stessi da una chiesa

Permessi dei ruoli​

Percorso base: /membership/rolepermissions

MetodoPercorsoAutenticazionePermessoDescrizione
GET/roles/:idJWTRoles.ViewOttiene i permessi di un ruolo (usa null come ID per il ruolo "Everyone")
POST/JWTRoles.EditCrea o aggiorna i permessi di un ruolo
DELETE/:idJWTRoles.EditElimina un permesso di ruolo

Permessi​

Percorso base: /membership/permissions

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Ottiene l'elenco completo dei permessi disponibili

Ogni voce ha apiName, section (tipo di contenuto), action e le etichette displaySection / displayAction che mostra l'editor dei ruoli di B1Admin. Aggiunte recenti: MembershipApi / People / View Names (Visualizza solo i nomi delle persone, in Persone e gruppi) e GivingApi / Donations / Enter (Inserisci donazioni, in Donazioni; vedi Lotti di donazioni).

Moduli​

Percorso base: /membership/forms

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWTForms.Admin oppure Forms.EditElenca tutti i moduli (l'amministratore vede tutto; gli editor vedono quelli assegnati + i moduli non di membri)
GET/:idJWTAccesso al moduloOttiene un modulo per ID
GET/archivedJWTForms.Admin oppure Forms.EditElenca i moduli archiviati
GET/group/:groupIdJWTMembro del gruppo, leader del gruppo oppure Forms.AdminModuli indipendenti collegati al gruppo (forms.groupId), esclusi quelli archiviati, ordinati per nome. Restituisce id, name, description e open (entro la finestra di disponibilità). I membri ottengono solo i moduli aperti; i leader e gli amministratori dei moduli ottengono anche quelli chiusi. Alimenta i moduli collegati della pagina del gruppo
GET/standalone/:id?churchId=JWT—Ottiene un modulo indipendente (i moduli riservati richiedono l'autenticazione)
POST/JWTForms.Admin oppure Forms.EditCrea o aggiorna i moduli. I moduli indipendenti accettano un photoUrl facoltativo (foto di intestazione mostrata sopra il modulo) e un groupId (gruppo collegato)
DELETE/:idJWTAccesso al moduloElimina un modulo

Risposte ai moduli​

Percorso base: /membership/formsubmissions

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWTForms.Admin oppure Forms.EditElenca le risposte. Filtra con ?personId= oppure ?formId=
GET/my?include=questions,answersJWT—Limitato a sé stessi: fino a 50 risposte a moduli indipendenti (non moduli per persone) inviate dal membro connesso o collegate alla sua persona (contentType person, contentId = il suo id persona -- per esempio, dopo una modifica della persona da parte di un amministratore), dalla più recente, ciascuna con form.name. include allega le domande di ciascun modulo e le risposte della risposta. Restituisce 401 se l'utente non è collegato a una persona. Alimenta la sezione I miei moduli della pagina Io di B1
GET/group/:groupIdJWTLeader del gruppoRisposte per i leader del gruppo: una voce per ogni modulo collegato e per ogni evento del gruppo con un modulo di iscrizione, ciascuna con form, event (id, title, start; solo per le voci evento), questions e submissions (con answers e personName, null se anonima)
GET/:idJWTForms.Admin, Forms.Edit oppure accesso di visualizzazioneOttiene una risposta per ID. Aggiungi ?include=form,questions,answers. Anche i leader del gruppo collegato al modulo e i leader del gruppo a cui appartiene un'iscrizione a un evento possono leggerla
GET/formId/:formIdJWTAccesso al modulo (visualizzazione)Ottiene tutte le risposte di un modulo (include modulo, domande, risposte). I leader del gruppo collegato al modulo hanno accesso in visualizzazione
POST/JWT—Invia le risposte del modulo (gestisce moduli riservati/non riservati, invia notifiche email). Quando il modulo ha autoCreatePerson, trova o crea una persona Ospite tramite email e collega la risposta; quando il modulo ha anche un groupId, aggiunge quella persona al gruppo; quando followUpSubject/followUpBody sono impostati, invia all'autore una email di follow-up da modello. A meno che il chiamante non possa gestire il modulo, submittedBy è sempre impostato sulla persona del membro connesso (oppure lasciato vuoto per le risposte anonime)
DELETE/:idJWTForms.Admin oppure Forms.EditElimina una risposta e le sue risposte alle domande

Domande​

Percorso base: /membership/questions

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWTAccesso al moduloElenca le domande di un modulo. Richiede ?formId=
GET/:idJWTAccesso al moduloOttiene una domanda per ID
GET/unrestricted?formId=JWT—Ottiene le domande di un modulo non riservato
GET/sort/:id/upJWT—Sposta una domanda in su nell'ordinamento
GET/sort/:id/downJWT—Sposta una domanda in giù nell'ordinamento
POST/JWTAccesso al moduloCrea o aggiorna le domande (assegna automaticamente l'ordine)
DELETE/:id?formId=JWTAccesso al moduloElimina una domanda

Risposte alle domande​

Percorso base: /membership/answers

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWTForms.Admin oppure Forms.EditElenca le risposte. Filtra con ?formSubmissionId=
POST/JWTForms.Admin oppure Forms.EditCrea o aggiorna le risposte

Permessi dei membri​

Percorso base: /membership/memberpermissions

Controlla l'accesso di ciascun membro a moduli specifici.

MetodoPercorsoAutenticazionePermessoDescrizione
GET/:idJWTAccesso al moduloOttiene un permesso di membro per ID
GET/member/:idJWTAccesso al moduloOttiene tutti i permessi sui moduli di un membro
GET/form/:idJWTAccesso al moduloOttiene tutti i permessi dei membri su un modulo
GET/form/:id/myJWTAccesso al moduloOttiene il permesso dell'utente corrente su un modulo
POST/JWTAccesso al moduloCrea o aggiorna i permessi dei membri
DELETE/:id?formId=JWTAccesso al moduloElimina un permesso di membro
DELETE/member/:id?formId=JWTAccesso al moduloElimina tutti i permessi di un membro su un modulo

Impostazioni​

Percorso base: /membership/settings

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWTSettings.EditOttiene tutte le impostazioni della chiesa
GET/public/:churchIdPubblico—Ottiene le impostazioni pubbliche di una chiesa
POST/JWTSettings.EditSalva le impostazioni (supporta il caricamento di immagini in base64)

Domini​

Percorso base: /membership/domains

Estende il CRUD standard (GET /:id, GET /, DELETE /:id dalla classe base).

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Elenca tutti i domini
GET/:idJWT—Ottiene un dominio per ID
GET/lookup/:domainNameJWT—Cerca un dominio per nome
GET/public/lookup/:domainNamePubblico—Ricerca pubblica di un dominio per nome
GET/health/checkPubblico—Esegue il controllo di stato sui domini non verificati
POST/JWTSettings.EditCrea o aggiorna i domini (attiva l'aggiornamento di Caddy)
DELETE/:idJWTSettings.EditElimina un dominio

Utente-chiesa​

Percorso base: /membership/userchurch

Gestisce l'associazione tra utenti e chiese.

MetodoPercorsoAutenticazionePermessoDescrizione
GET/userid/:userIdJWT—Ottiene il record utente-chiesa tramite ID utente
GET/personid/:personIdJWT—Ottiene l'email dell'utente collegato a una persona
GET/user/:userIdJWTServer.AdminCarica tutte le chiese di un utente
POST/JWT—Crea un'associazione utente-chiesa
PATCH/:userIdJWT—Aggiorna l'ultimo accesso e registra l'accesso
DELETE/record/:userId/:churchId/:personIdJWT—Elimina un record utente-chiesa

Preferenze di visibilità​

Percorso base: /membership/visibilityPreferences

MetodoPercorsoAutenticazionePermessoDescrizione
GET/myJWT—Ottiene le preferenze di visibilità dell'utente corrente
POST/JWT—Salva le preferenze di visibilità (visibilità di indirizzo, telefono, email)

Query​

Percorso base: /membership/query

MetodoPercorsoAutenticazionePermessoDescrizione
POST/membersJWT—Ricerca di membri in linguaggio naturale tramite IA. Corpo: { text, subDomain, siteUrl }

Errori del client​

Percorso base: /membership/clientErrors

MetodoPercorsoAutenticazionePermessoDescrizione
POST/JWT—Registra un errore lato client

Pagine correlate​