Aller au contenu principal

Points de terminaison Doing

Le module Doing gère la planification des services, la planification des bénévoles, la gestion des tâches et les automatisations. Il fournit des outils pour créer des plans de service avec des horaires et des postes, affecter des bénévoles, gérer les dates d'indisponibilité, construire les éléments de l'ordre de service, se connecter à des fournisseurs de contenu externes et configurer des flux de travail automatisés avec des conditions et des actions.

Chemin de base : /doing

Plans​

Chemin de base : /doing/plans

MéthodeCheminAuthAutorisationDescription
GET/JWT—Lister tous les plans de l'église
GET/:idJWT—Obtenir un plan par ID
GET/ids?ids=JWT—Obtenir plusieurs plans par ID séparés par des virgules
GET/types/:planTypeIdJWT—Obtenir les plans d'un type de plan
GET/textRange?startDate=&endDate=&ministryId=&planTypeId=JWTtexting.send + modification du ministèrePrévisualiser l'envoi Textos aux bénévoles du survol du service : { totalMembers, eligibleCount, optedOutCount, noPhoneCount, capped } pour les bénévoles affectés dans la plage (une personne par bénévole, les personnes désabonnées et sans numéro sont ignorées, les numéros partagés sont dédoublonnés, limité à 200)
GET/presenterJWT—Obtenir les plans des 7 prochains jours (vue présentateur)
GET/confirmationWorkflows?ministryId=JWTModification du ministèreFlux de travail actifs de confirmation d'affectation de service (workflowType = "assignmentConfirmation") qu'un plan peut sélectionner : [{ id, name }]
GET/public/current/:planTypeIdPublique—Obtenir le plan actuel d'un type de plan
GET/public/signup/:churchIdPublique—Plans ouverts à l'inscription en libre-service, les plus proches en premier, chacun avec ses postes d'inscription libre-service (triés par categoryName, puis name, plus filledCount des affectations Acceptées/Non confirmées) et les horaires. Aucun nom de bénévole. Lorsque le paramètre d'église volunteerSignupNextOnly vaut "true", seul le premier plan de chaque type est renvoyé. Chaque plan comprend un signupDeadline calculé (instant ISO, ou null) : signupDeadlineHours avant l'horaire service le plus tôt du plan (n'importe quel horaire daté s'il n'y a pas d'horaire de service ; 9 h dans le fuseau horaire de l'église à serviceDate si le plan n'a aucun horaire)
GET/signup/:planId/volunteersJWT—[{ positionId, names }] pour les postes d'inscription libre-service du plan (noms affichés des assignés Acceptés/Non confirmés). Renvoie [] sauf si showVolunteerNames du plan est activé
POST/JWT—Créer ou mettre à jour des plans (accepte un objet unique ou un tableau). Définissez confirmationWorkflowId pour inscrire le plan à un flux de travail de confirmation de service, ou null pour le désinscrire des demandes futures. Envoyez signupDeadlineHours: null pour effacer une date limite ; omettre le champ conserve la valeur enregistrée
POST/copy/:idJWTModification du ministèreCopier un plan avec ses postes, horaires, affectations et éléments d'ordre de service. Le corps comprend ministryId, serviceDate, copyMode (« none », « positions », « all ») et copyServiceOrder (booléen). Sans targetPlanId, un nouveau plan est créé, et notes, signupDeadlineHours, showVolunteerNames et autoReplaceOnDecline sont repris du plan source, sauf si le corps les fournit. Avec targetPlanId, la copie remplit ce plan existant à la place (l'appelant doit pouvoir le modifier). L'option Répéter chaque semaine de B1Admin appelle cette route une fois par semaine, en copiant chaque fois à partir du plan créé la semaine précédente
POST/textRangeJWTtexting.send + modification du ministèreEnvoyer un texte à chaque bénévole affecté dans une plage de dates via le fournisseur de messages texte de l'église. Corps : { startDate, endDate, ministryId, planTypeId?, message } (message jusqu'à 1600 caractères ; les champs de fusion sont résolus pour chaque destinataire). Renvoie les décomptes de prévisualisation ainsi que recipientCount, successCount, failCount et error (no_provider ou insufficient_credits) lorsque l'envoi s'arrête prématurément
POST/:id/issueRequestsJWTModification du planÉmettre les nouvelles affectations Non confirmées et non encore notifiées du plan par son flux de travail de confirmation : marque chacune comme notifiée et démarre une carte de flux de travail par affectation. Corps vide ; renvoie { issued }. Échoue sauf si le plan est publié (pas prepared), a un confirmationWorkflowId actif avec au moins une étape, et que sa date limite de réponse n'est pas dépassée
POST/autofill/:idJWT—Remplir automatiquement les affectations de bénévoles d'un plan. Corps : { teams: [{ positionId, personIds }] }
DELETE/:idJWT—Supprimer un plan ainsi que tous ses horaires, affectations, postes et éléments de plan associés

Exemple : copier un plan​

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"
}

Types de plans​

Chemin de base : /doing/planTypes

Hérite de la classe CRUD de base (GET /, GET /:id, POST /, DELETE /:id — sans vérifications d'autorisations).

MéthodeCheminAuthAutorisationDescription
GET/JWT—Lister tous les types de plans
GET/:idJWT—Obtenir un type de plan par ID
GET/ids?ids=JWT—Obtenir plusieurs types de plans par ID séparés par des virgules
GET/ministryId/:ministryIdJWT—Obtenir les types de plans d'un ministère
POST/JWT—Créer ou mettre à jour des types de plans
DELETE/:idJWT—Supprimer un type de plan

Éléments de plan​

Chemin de base : /doing/planItems

Gère les éléments de l'ordre de service (en-têtes, sections, chants, etc.) organisés dans une structure arborescente parent-enfant.

MéthodeCheminAuthAutorisationDescription
GET/:idJWT—Obtenir un élément de plan par ID
GET/ids?ids=JWT—Obtenir plusieurs éléments de plan par ID séparés par des virgules
GET/plan/:planIdJWT—Obtenir tous les éléments d'un plan (renvoie une structure en arbre)
GET/presenter/:churchId/:planIdPublique—Obtenir les éléments du plan pour la vue présentateur (renvoie une structure en arbre)
POST/JWT—Créer ou mettre à jour des éléments de plan
POST/sortJWT—Mettre à jour l'ordre de tri d'un élément de plan (réordonne les frères et sœurs)
DELETE/:idJWT—Supprimer un élément de plan

Flux du plan​

Chemin de base : /doing/planFeed

Fournit les flux d'éléments de plan pour le présentateur. S'il n'existe aucun élément de plan, il se remplit automatiquement à partir du flux de lieu de Lessons.church à l'aide du contentId du plan.

MéthodeCheminAuthAutorisationDescription
GET/presenter/:churchId/:planIdPublique—Obtenir le flux du plan pour le présentateur (se remplit automatiquement à partir du flux de lieu s'il est vide)

Postes​

Chemin de base : /doing/positions

Hérite de la classe CRUD de base (GET /:id, POST /, DELETE /:id — sans vérifications d'autorisations).

MéthodeCheminAuthAutorisationDescription
GET/:idJWT—Obtenir un poste par ID
GET/ids?ids=JWT—Obtenir plusieurs postes par ID séparés par des virgules
GET/plan/ids?planIds=JWT—Obtenir les postes de plusieurs plans par ID de plan séparés par des virgules
GET/plan/:planIdJWT—Obtenir tous les postes d'un plan
POST/JWT—Créer ou mettre à jour des postes
DELETE/:idJWT—Supprimer un poste

Horaires​

Chemin de base : /doing/times

MéthodeCheminAuthAutorisationDescription
GET/allJWT—Lister tous les horaires de l'église
GET/:idJWT—Obtenir un horaire par ID
GET/plans?planIds=JWT—Obtenir les horaires de plusieurs plans par ID de plan séparés par des virgules
GET/plan/:planIdJWT—Obtenir tous les horaires d'un plan
POST/JWT—Créer ou mettre à jour des horaires
DELETE/:idJWT—Supprimer un horaire

Affectations​

Chemin de base : /doing/assignments

MéthodeCheminAuthAutorisationDescription
GET/myJWT—Obtenir les affectations de l'utilisateur actuel
GET/my/upcomingJWT—Jusqu'à 20 affectations de l'utilisateur actuel sur des plans datés à partir d'hier (les plans pré-affectés, ou prepared, sont ignorés), les plus proches en premier : { assignmentId, status, positionName, planId, planName, serviceDate }. Alimente l'aperçu des services sur la page d'accueil du membre
GET/:idJWT—Obtenir une affectation par ID
GET/plan/ids?planIds=JWT—Obtenir les affectations de plusieurs plans par ID de plan séparés par des virgules
GET/plan/:planIdJWT—Obtenir toutes les affectations d'un plan
POST/JWT—Créer ou mettre à jour des affectations (le statut est réglé par défaut sur « Unconfirmed », soit Non confirmé)
POST/accept/:idJWT—Accepter une affectation (doit être la personne assignée)
POST/decline/:idJWT—Refuser une affectation (doit être la personne assignée)
POST/signupJWT—Inscription en libre-service à un poste. Corps : { positionId }. Le poste doit autoriser l'inscription libre-service et avoir de la place ; crée une affectation Acceptée. Rejetée avec « Signup deadline has passed » (la date limite d'inscription est dépassée) une fois la date limite d'inscription du plan dépassée (décomptée à partir de son premier horaire de service, comme ci-dessus)
DELETE/signup/:idJWT—Retirer sa propre inscription en libre-service. Rejetée avec « Removal deadline has passed » (la date limite de retrait est dépassée) après la date limite d'inscription du plan
DELETE/:idJWT—Supprimer une affectation

Exemple : accepter une affectation​

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

Dates d'indisponibilité​

Chemin de base : /doing/blockoutDates

Hérite de la classe CRUD de base (GET /:id, DELETE /:id — sans vérifications d'autorisations).

MéthodeCheminAuthAutorisationDescription
GET/:idJWT—Obtenir une date d'indisponibilité par ID
GET/ids?ids=JWT—Obtenir plusieurs dates d'indisponibilité par ID séparés par des virgules
GET/myJWT—Obtenir les dates d'indisponibilité de l'utilisateur actuel
GET/upcomingJWT—Obtenir toutes les dates d'indisponibilité à venir de l'église
POST/JWT—Créer ou mettre à jour des dates d'indisponibilité (règle personId sur l'utilisateur actuel si non fourni)
DELETE/:idJWT—Supprimer une date d'indisponibilité

Tâches​

Chemin de base : /doing/tasks

MéthodeCheminAuthAutorisationDescription
GET/JWT—Obtenir les tâches ouvertes de l'utilisateur actuel
GET/:idJWT—Obtenir une tâche par ID
GET/:id/contactJWTPeut voir la carteCoordonnées de la personne concernée par une carte de flux de travail : { personId, displayName, mobilePhone, email }. Permet à un appelant assigné sans accès aux Personnes de joindre la personne
GET/closedJWT—Obtenir les tâches fermées de l'utilisateur actuel
GET/timeline?taskIds=JWT—Obtenir les données de chronologie des tâches par ID de tâche séparés par des virgules
GET/directoryUpdate/:personIdJWT—Obtenir la tâche de mise à jour de répertoire d'une personne
POST/JWT—Créer ou mettre à jour des tâches. Ajoutez ?type=directoryUpdate pour traiter les tâches de mise à jour de répertoire (téléverse automatiquement les photos)
POST/:id/conversationJWTtasks.edit ou assigné de la carteJoindre la conversation de notes à une carte. Corps : { conversationId }. La première conversation jointe l'emporte ; les appels suivants renvoient la carte sans modification
POST/loadForGroupsJWT—Charger les tâches de groupes précis. Corps : { groupIds: [], status: "Open" }

Automatisations​

Chemin de base : /doing/automations

MéthodeCheminAuthAutorisationDescription
GET/JWT—Lister toutes les automatisations de l'église
GET/:idJWT—Obtenir une automatisation par ID
GET/checkPublique—Déclencher une vérification de toutes les automatisations
POST/JWT—Créer ou mettre à jour des automatisations
DELETE/:idJWT—Supprimer une automatisation

Actions​

Chemin de base : /doing/actions

Les actions définissent ce qui se produit lorsqu'une automatisation est déclenchée.

MéthodeCheminAuthAutorisationDescription
GET/:idJWT—Obtenir une action par ID
GET/automation/:idJWT—Obtenir toutes les actions d'une automatisation
POST/JWT—Créer ou mettre à jour des actions
DELETE/:idJWT—Supprimer une action

Conditions​

Chemin de base : /doing/conditions

Les conditions définissent les critères qui déclenchent une automatisation.

MéthodeCheminAuthAutorisationDescription
GET/:idJWT—Obtenir une condition par ID
GET/automation/:idJWT—Obtenir toutes les conditions d'une automatisation
POST/JWT—Créer ou mettre à jour des conditions
DELETE/:idJWT—Supprimer une condition

Conjonctions​

Chemin de base : /doing/conjunctions

Les conjonctions relient plusieurs conditions dans une automatisation (logique ET/OU).

MéthodeCheminAuthAutorisationDescription
GET/:idJWT—Obtenir une conjonction par ID
GET/automation/:idJWT—Obtenir toutes les conjonctions d'une automatisation
POST/JWT—Créer ou mettre à jour des conjonctions
DELETE/:idJWT—Supprimer une conjonction

Authentifications des fournisseurs de contenu​

Chemin de base : /doing/contentProviderAuths

Hérite de la classe CRUD de base (GET /, GET /:id, POST /, DELETE /:id — sans vérifications d'autorisations).

Gère les enregistrements d'authentification OAuth pour les fournisseurs de contenu externes (par exemple les intégrations de logiciels de présentation).

accessToken et refreshToken sont chiffrés au repos avec EncryptionHelper et déchiffrés à la lecture, de sorte que l'API renvoie toujours des jetons en clair. Les lignes enregistrées avant le chiffrement contiennent du texte brut (qui ne contient jamais de |) ; elles sont renvoyées telles quelles, et chiffrées la prochaine fois qu'elles sont enregistrées.

MéthodeCheminAuthAutorisationDescription
GET/JWT—Lister toutes les authentifications de fournisseurs de contenu
GET/:idJWT—Obtenir une authentification de fournisseur de contenu par ID
GET/ids?ids=JWT—Obtenir plusieurs authentifications de fournisseurs de contenu par ID séparés par des virgules
GET/ministry/:ministryIdJWT—Obtenir toutes les authentifications de fournisseurs de contenu d'un ministère
GET/ministry/:ministryId/:providerIdJWT—Obtenir l'enregistrement d'authentification d'un ministère et d'un fournisseur précis
POST/JWT—Créer ou mettre à jour des authentifications de fournisseurs de contenu
DELETE/:idJWT—Supprimer une authentification de fournisseur de contenu

Mandataire de fournisseur​

Chemin de base : /doing/providerProxy

Transmet les requêtes aux fournisseurs de contenu externes (par exemple ProPresenter, EasyWorship). Renouvelle automatiquement les jetons lorsqu'ils expirent.

MéthodeCheminAuthAutorisationDescription
POST/browseJWT—Parcourir les fichiers du fournisseur de contenu. Corps : { ministryId, providerId, path }
POST/getPresentationsJWT—Obtenir les présentations d'un fournisseur de contenu. Corps : { ministryId, providerId, path }
POST/getPlaylistJWT—Obtenir une liste de lecture d'un fournisseur de contenu. Corps : { ministryId, providerId, path, resolution }
POST/getInstructionsJWT—Obtenir les instructions d'un élément de contenu. Corps : { ministryId, providerId, path }
POST/getExpandedInstructionsJWT—Obtenir les instructions détaillées d'un élément de contenu. Corps : { ministryId, providerId, path }

Pages connexes​