Vai al contenuto principale

Endpoint Doing

Il modulo Doing gestisce la pianificazione dei culti, la programmazione dei volontari, la gestione delle attività e le automazioni. Fornisce strumenti per creare piani di servizio con orari e posizioni, assegnare volontari, gestire le date di indisponibilità, costruire gli elementi dell'ordine del culto, collegarsi a fornitori di contenuti esterni e configurare flussi di lavoro automatizzati con condizioni e azioni.

Percorso base: /doing

Piani​

Percorso base: /doing/plans

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Elenca tutti i piani della chiesa
GET/:idJWT—Ottiene un piano per ID
GET/ids?ids=JWT—Ottiene più piani tramite ID separati da virgole
GET/types/:planTypeIdJWT—Ottiene i piani per tipo di piano
GET/textRange?startDate=&endDate=&ministryId=&planTypeId=JWTtexting.send + modifica del ministeroAnteprima della panoramica dei servizi che Invia SMS ai volontari invierebbe: { totalMembers, eligibleCount, optedOutCount, noPhoneCount, capped } per i volontari assegnati nell'intervallo (uno per persona, con i rifiuti e i numeri mancanti saltati, i numeri condivisi deduplicati, limitato a 200)
GET/presenterJWT—Ottiene i piani dei prossimi 7 giorni (vista presentatore)
GET/confirmationWorkflows?ministryId=JWTModifica del ministeroFlussi di lavoro attivi di conferma delle assegnazioni di servizio (workflowType = "assignmentConfirmation") che un piano può selezionare: [{ id, name }]
GET/public/current/:planTypeIdPubblico—Ottiene il piano attuale per un tipo di piano
GET/public/signup/:churchIdPubblico—Piani aperti all'iscrizione autonoma, dal più vicino, ciascuno con le sue posizioni di iscrizione autonoma (ordinate per categoryName, poi per name, più filledCount delle assegnazioni Accettate/Non confermate) e gli orari. Nessun nome di volontario. Quando l'impostazione della chiesa volunteerSignupNextOnly è "true", viene restituito solo il primo piano di ogni tipo. Ogni plan include un signupDeadline calcolato (istante ISO, oppure null): signupDeadlineHours prima dell'orario di tipo service più precoce del piano (qualsiasi orario con data se non c'è un orario di culto; le 9:00 nel fuso orario della chiesa su serviceDate se il piano non ha orari)
GET/signup/:planId/volunteersJWT—[{ positionId, names }] per le posizioni di iscrizione autonoma del piano (nomi visualizzati degli assegnatari Accettati/Non confermati). Restituisce [] a meno che l'opzione showVolunteerNames del piano non sia attiva
POST/JWT—Crea o aggiorna i piani (accetta un singolo oggetto oppure un array). Imposta confirmationWorkflowId per far aderire il piano a un flusso di lavoro di conferma del servizio, oppure null per non aderire alle richieste future. Invia signupDeadlineHours: null per eliminare una scadenza; omettere il campo mantiene il valore salvato
POST/copy/:idJWTModifica del ministeroCopia un piano comprese posizioni, orari, assegnazioni ed elementi dell'ordine del culto. Il corpo include ministryId, serviceDate, copyMode ("none", "positions", "all") e copyServiceOrder (booleano). Senza targetPlanId viene creato un nuovo piano, e notes, signupDeadlineHours, showVolunteerNames e autoReplaceOnDecline vengono ereditati dal piano di origine, a meno che il corpo non li fornisca. Con targetPlanId, la copia riempie invece quel piano esistente (il chiamante deve poterlo modificare). L'opzione Ripeti settimanalmente di B1Admin chiama questo endpoint una volta per settimana, copiando ogni volta dal piano creato la settimana precedente
POST/textRangeJWTtexting.send + modifica del ministeroInvia un SMS a ogni volontario assegnato in un intervallo di date tramite il fornitore di SMS della chiesa. Corpo: { startDate, endDate, ministryId, planTypeId?, message } (messaggio fino a 1600 caratteri; i campi di unione vengono risolti per ciascun destinatario). Restituisce i conteggi dell'anteprima più recipientCount, successCount, failCount e error (no_provider oppure insufficient_credits) quando l'invio si interrompe prima del previsto
POST/:id/issueRequestsJWTModifica del pianoEmette le nuove assegnazioni Non confermate e non ancora notificate del piano tramite il suo flusso di lavoro di conferma: segna ciascuna come notificata e avvia una scheda di flusso di lavoro per ogni assegnazione. Corpo vuoto; restituisce { issued }. Fallisce a meno che il piano non sia pubblicato (non prepared), abbia un confirmationWorkflowId attivo con almeno un passaggio, e la sua scadenza per la risposta non sia già passata
POST/autofill/:idJWT—Compila automaticamente le assegnazioni dei volontari per un piano. Corpo: { teams: [{ positionId, personIds }] }
DELETE/:idJWT—Elimina un piano e tutti gli orari, le assegnazioni, le posizioni e gli elementi del piano collegati

Esempio: copiare un piano​

POST /doing/plans/copy/abc-123
Authorization: Bearer <token>

{
"serviceDate": "2026-03-01T10:00:00.000Z",
"copyMode": "all",
"copyServiceOrder": true
}
{
"id": "def-456",
"churchId": "church-1",
"serviceDate": "2026-03-01T10:00:00.000Z"
}

Tipi di piano​

Percorso base: /doing/planTypes

Estende la classe base CRUD (GET /, GET /:id, POST /, DELETE /:id — senza controlli dei permessi).

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Elenca tutti i tipi di piano
GET/:idJWT—Ottiene un tipo di piano per ID
GET/ids?ids=JWT—Ottiene più tipi di piano tramite ID separati da virgole
GET/ministryId/:ministryIdJWT—Ottiene i tipi di piano di un ministero
POST/JWT—Crea o aggiorna i tipi di piano
DELETE/:idJWT—Elimina un tipo di piano

Elementi del piano​

Percorso base: /doing/planItems

Gestisce gli elementi dell'ordine del culto (intestazioni, sezioni, canti, ecc.) organizzati in una struttura ad albero genitore-figlio.

MetodoPercorsoAutenticazionePermessoDescrizione
GET/:idJWT—Ottiene un elemento del piano per ID
GET/ids?ids=JWT—Ottiene più elementi del piano tramite ID separati da virgole
GET/plan/:planIdJWT—Ottiene tutti gli elementi del piano per un piano (restituisce la struttura ad albero)
GET/presenter/:churchId/:planIdPubblico—Ottiene gli elementi del piano per la vista presentatore (restituisce la struttura ad albero)
POST/JWT—Crea o aggiorna gli elementi del piano
POST/sortJWT—Aggiorna l'ordinamento di un elemento del piano (riordina i fratelli)
DELETE/:idJWT—Elimina un elemento del piano

Feed del piano​

Percorso base: /doing/planFeed

Fornisce i feed degli elementi del piano per il presentatore. Se non esistono elementi del piano, li popola automaticamente dal feed della venue di Lessons.church usando il contentId del piano.

MetodoPercorsoAutenticazionePermessoDescrizione
GET/presenter/:churchId/:planIdPubblico—Ottiene il feed del piano per il presentatore (si popola automaticamente dal feed della venue se vuoto)

Posizioni​

Percorso base: /doing/positions

Estende la classe base CRUD (GET /:id, POST /, DELETE /:id — senza controlli dei permessi).

MetodoPercorsoAutenticazionePermessoDescrizione
GET/:idJWT—Ottiene una posizione per ID
GET/ids?ids=JWT—Ottiene più posizioni tramite ID separati da virgole
GET/plan/ids?planIds=JWT—Ottiene le posizioni di più piani tramite ID di piano separati da virgole
GET/plan/:planIdJWT—Ottiene tutte le posizioni di un piano
POST/JWT—Crea o aggiorna le posizioni
DELETE/:idJWT—Elimina una posizione

Orari​

Percorso base: /doing/times

MetodoPercorsoAutenticazionePermessoDescrizione
GET/allJWT—Elenca tutti gli orari della chiesa
GET/:idJWT—Ottiene un orario per ID
GET/plans?planIds=JWT—Ottiene gli orari di più piani tramite ID di piano separati da virgole
GET/plan/:planIdJWT—Ottiene tutti gli orari di un piano
POST/JWT—Crea o aggiorna gli orari
DELETE/:idJWT—Elimina un orario

Assegnazioni​

Percorso base: /doing/assignments

MetodoPercorsoAutenticazionePermessoDescrizione
GET/myJWT—Ottiene le assegnazioni dell'utente corrente
GET/my/upcomingJWT—Fino a 20 assegnazioni dell'utente corrente su piani con data da ieri in poi (si saltano i piani con penciled-in, oppure prepared), dalla più vicina: { assignmentId, status, positionName, planId, planName, serviceDate }. Alimenta l'anteprima del servizio nella home page del membro
GET/:idJWT—Ottiene un'assegnazione per ID
GET/plan/ids?planIds=JWT—Ottiene le assegnazioni di più piani tramite ID di piano separati da virgole
GET/plan/:planIdJWT—Ottiene tutte le assegnazioni di un piano
POST/JWT—Crea o aggiorna le assegnazioni (imposta di default lo stato su "Unconfirmed")
POST/accept/:idJWT—Accetta un'assegnazione (deve essere la persona assegnata)
POST/decline/:idJWT—Rifiuta un'assegnazione (deve essere la persona assegnata)
POST/signupJWT—Iscrizione autonoma a una posizione. Corpo: { positionId }. La posizione deve consentire l'iscrizione autonoma e avere posto; crea un'assegnazione Accepted. Respinta con "Signup deadline has passed" una volta superata la scadenza di iscrizione del piano (calcolata a ritroso dal suo primo orario di culto, come sopra)
DELETE/signup/:idJWT—Rimuove la propria iscrizione autonoma. Respinta con "Removal deadline has passed" dopo la scadenza di iscrizione del piano
DELETE/:idJWT—Elimina un'assegnazione

Esempio: accettare un'assegnazione​

POST /doing/assignments/accept/assign-123
Authorization: Bearer <token>
{
"id": "assign-123",
"personId": "person-456",
"positionId": "pos-789",
"planId": "plan-abc",
"status": "Accepted"
}

Date di indisponibilità​

Percorso base: /doing/blockoutDates

Estende la classe base CRUD (GET /:id, DELETE /:id — senza controlli dei permessi).

MetodoPercorsoAutenticazionePermessoDescrizione
GET/:idJWT—Ottiene una data di indisponibilità per ID
GET/ids?ids=JWT—Ottiene più date di indisponibilità tramite ID separati da virgole
GET/myJWT—Ottiene le date di indisponibilità dell'utente corrente
GET/upcomingJWT—Ottiene tutte le prossime date di indisponibilità della chiesa
POST/JWT—Crea o aggiorna le date di indisponibilità (imposta di default personId sull'utente corrente se non fornito)
DELETE/:idJWT—Elimina una data di indisponibilità

Attività​

Percorso base: /doing/tasks

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Ottiene le attività aperte per l'utente corrente
GET/:idJWT—Ottiene un'attività per ID
GET/:id/contactJWTPuò visualizzare la schedaInformazioni di contatto della persona a cui si riferisce una scheda di flusso di lavoro: { personId, displayName, mobilePhone, email }. Permette a un chiamante assegnato senza accesso a Persone di raggiungere la persona
GET/closedJWT—Ottiene le attività chiuse per l'utente corrente
GET/timeline?taskIds=JWT—Ottiene i dati della timeline per le attività tramite ID separati da virgole
GET/directoryUpdate/:personIdJWT—Ottiene l'attività di aggiornamento della rubrica per una persona
POST/JWT—Crea o aggiorna le attività. Aggiungi ?type=directoryUpdate per gestire le attività di aggiornamento della rubrica (carica automaticamente le foto)
POST/:id/conversationJWTtasks.edit oppure assegnatario della schedaAllega la conversazione di note a una scheda. Corpo: { conversationId }. Vince la prima conversazione allegata; le chiamate successive restituiscono la scheda invariata
POST/loadForGroupsJWT—Carica le attività per gruppi specifici. Corpo: { groupIds: [], status: "Open" }

Automazioni​

Percorso base: /doing/automations

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Elenca tutte le automazioni della chiesa
GET/:idJWT—Ottiene un'automazione per ID
GET/checkPubblico—Avvia un controllo di tutte le automazioni
POST/JWT—Crea o aggiorna le automazioni
DELETE/:idJWT—Elimina un'automazione

Azioni​

Percorso base: /doing/actions

Le azioni definiscono cosa succede quando un'automazione viene attivata.

MetodoPercorsoAutenticazionePermessoDescrizione
GET/:idJWT—Ottiene un'azione per ID
GET/automation/:idJWT—Ottiene tutte le azioni di un'automazione
POST/JWT—Crea o aggiorna le azioni
DELETE/:idJWT—Elimina un'azione

Condizioni​

Percorso base: /doing/conditions

Le condizioni definiscono i criteri che attivano un'automazione.

MetodoPercorsoAutenticazionePermessoDescrizione
GET/:idJWT—Ottiene una condizione per ID
GET/automation/:idJWT—Ottiene tutte le condizioni di un'automazione
POST/JWT—Crea o aggiorna le condizioni
DELETE/:idJWT—Elimina una condizione

Congiunzioni​

Percorso base: /doing/conjunctions

Le congiunzioni collegano più condizioni in un'automazione (logica AND/OR).

MetodoPercorsoAutenticazionePermessoDescrizione
GET/:idJWT—Ottiene una congiunzione per ID
GET/automation/:idJWT—Ottiene tutte le congiunzioni di un'automazione
POST/JWT—Crea o aggiorna le congiunzioni
DELETE/:idJWT—Elimina una congiunzione

Autorizzazioni dei fornitori di contenuti​

Percorso base: /doing/contentProviderAuths

Estende la classe base CRUD (GET /, GET /:id, POST /, DELETE /:id — senza controlli dei permessi).

Gestisce i record di autenticazione OAuth per i fornitori di contenuti esterni (ad esempio le integrazioni con software di presentazione).

accessToken e refreshToken sono cifrati a riposo con EncryptionHelper e decifrati alla lettura, quindi l'API restituisce comunque i token in chiaro. I record salvati prima della cifratura contengono testo in chiaro (che non contiene mai |); vengono restituiti così come sono e cifrati la volta successiva in cui vengono salvati.

MetodoPercorsoAutenticazionePermessoDescrizione
GET/JWT—Elenca tutte le autorizzazioni dei fornitori di contenuti
GET/:idJWT—Ottiene un'autorizzazione del fornitore di contenuti per ID
GET/ids?ids=JWT—Ottiene più autorizzazioni dei fornitori di contenuti tramite ID separati da virgole
GET/ministry/:ministryIdJWT—Ottiene tutte le autorizzazioni dei fornitori di contenuti di un ministero
GET/ministry/:ministryId/:providerIdJWT—Ottiene il record di autorizzazione per un ministero e un fornitore specifici
POST/JWT—Crea o aggiorna le autorizzazioni dei fornitori di contenuti
DELETE/:idJWT—Elimina un'autorizzazione del fornitore di contenuti

Proxy del fornitore​

Percorso base: /doing/providerProxy

Inoltra le richieste ai fornitori di contenuti esterni (ad esempio ProPresenter, EasyWorship). Gestisce automaticamente il rinnovo dei token quando scadono.

MetodoPercorsoAutenticazionePermessoDescrizione
POST/browseJWT—Sfoglia i file del fornitore di contenuti. Corpo: { ministryId, providerId, path }
POST/getPresentationsJWT—Ottiene le presentazioni da un fornitore di contenuti. Corpo: { ministryId, providerId, path }
POST/getPlaylistJWT—Ottiene una playlist da un fornitore di contenuti. Corpo: { ministryId, providerId, path, resolution }
POST/getInstructionsJWT—Ottiene le istruzioni per un elemento di contenuto. Corpo: { ministryId, providerId, path }
POST/getExpandedInstructionsJWT—Ottiene le istruzioni espanse per un elemento di contenuto. Corpo: { ministryId, providerId, path }

Pagine correlate​