Эндпоинты Doing
Модуль Doing управляет планированием служений, расписанием волонтёров, задачами и автоматизациями. Он предоставляет инструменты для создания планов служения с временами и позициями, назначения волонтёров, управления датами недоступности, составления элементов порядка служения, подключения к внешним поставщикам контента и настройки автоматизированных рабочих процессов с условиями и действиями.
Базовый путь: /doing
Планы
Базовый путь: /doing/plans
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | / | JWT | — | Список всех планов церкви |
| GET | /:id | JWT | — | Получить план по ID |
| GET | /ids?ids= | JWT | — | Получить несколько планов по ID, перечисленным через запятую |
| GET | /types/:planTypeId | JWT | — | Получить планы по типу плана |
| GET | /textRange?startDate=&endDate=&ministryId=&planTypeId= | JWT | texting.send + право на редактирование служения | Предпросмотр того, кому отправит Text Volunteers обзор служений: { totalMembers, eligibleCount, optedOutCount, noPhoneCount, capped } для волонтёров, назначенных в диапазоне (по одному на человека, отказавшиеся и без номера пропускаются, общие номера дедуплицируются, не более 200) |
| GET | /presenter | JWT | — | Планы на ближайшие 7 дней (вид презентатора) |
| GET | /confirmationWorkflows?ministryId= | JWT | Право на редактирование служения | Активные рабочие процессы подтверждения назначений служения (workflowType = "assignmentConfirmation"), которые может выбрать план: [{ id, name }] |
| GET | /public/current/:planTypeId | Public | — | Получить текущий план для типа плана |
| GET | /public/signup/:churchId | Public | — | Планы, открытые для самостоятельной записи, ближайшие первыми; у каждого — его позиции для самозаписи (отсортированы по categoryName, затем по name, плюс filledCount назначений со статусом Accepted/Unconfirmed) и времена. Имена волонтёров не возвращаются. Если настройка церкви volunteerSignupNextOnly равна "true", возвращается только первый план каждого типа. Каждый plan включает вычисляемое поле signupDeadline (ISO-момент или null): signupDeadlineHours до самого раннего времени типа service плана (если времени служения нет — любое время с отметкой; если времён нет вообще — 9:00 по часовому поясу церкви в день serviceDate) |
| GET | /signup/:planId/volunteers | JWT | — | [{ positionId, names }] для позиций самозаписи плана (отображаемые имена назначенных со статусом Accepted/Unconfirmed). Возвращает [], если у плана не включён showVolunteerNames |
| POST | / | JWT | — | Создать или обновить планы (принимает один объект или массив). Задайте confirmationWorkflowId, чтобы подключить план к рабочему процессу подтверждения служения, или null, чтобы отключить его для будущих запросов. Передайте signupDeadlineHours: null, чтобы убрать срок; если поле не передано, сохранённое значение остаётся |
| POST | /copy/:id | JWT | Право на редактирование служения | Скопировать план вместе с позициями, временами, назначениями и элементами порядка служения. Тело содержит ministryId, serviceDate, copyMode ("none", "positions", "all") и copyServiceOrder (boolean). Без targetPlanId создаётся новый план, а notes, signupDeadlineHours, showVolunteerNames и autoReplaceOnDecline переносятся из исходного плана, если тело их не задаёт. С targetPlanId копия заполняет уже существующий план (вызывающий должен иметь право его редактировать). Опция Repeat weekly в B1Admin вызывает этот эндпоинт по разу на каждую неделю, каждый раз копируя из плана, созданного неделей раньше |
| POST | /textRange | JWT | texting.send + право на редактирование служения | Отправить SMS каждому волонтёру, назначенному в диапазоне дат, через провайдера SMS церкви. Тело: { startDate, endDate, ministryId, planTypeId?, message } (сообщение до 1600 символов; поля подстановки подставляются для каждого получателя). Возвращает счётчики предпросмотра, а также recipientCount, successCount, failCount и error (no_provider или insufficient_credits), если отправка прервалась досрочно |
| POST | /:id/issueRequests | JWT | Право на редактирование плана | Выдать новые назначения плана со статусом Unconfirmed, которые ещё не получили уведомление, через его рабочий процесс подтверждения: отмечает каждое назначение как уведомлённое и создаёт по одной карточке рабочего процесса на назначение. Пустое тело; возвращает { issued }. Выполняется только если план опубликован (не prepared), имеет активный confirmationWorkflowId с хотя бы одним шагом и срок ответа ещё не истёк |
| POST | /autofill/:id | JWT | — | Автоматически заполнить назначения волонтёров для плана. Тело: { teams: [{ positionId, personIds }] } |
| DELETE | /:id | JWT | — | Удалить план и все связанные времена, назначения, позиции и элементы плана |
Пример: копирование плана
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"
}
Типы планов
Базовый путь: /doing/planTypes
Наследует базовый класс CRUD (GET /, GET /:id, POST /, DELETE /:id — без проверок прав).
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | / | JWT | — | Список всех типов планов |
| GET | /:id | JWT | — | Получить тип плана по ID |
| GET | /ids?ids= | JWT | — | Получить несколько типов планов по ID, перечисленным через запятую |
| GET | /ministryId/:ministryId | JWT | — | Получить типы планов для служения |
| POST | / | JWT | — | Создать или обновить типы планов |
| DELETE | /:id | JWT | — | Удалить тип плана |
Элементы плана
Базовый путь: /doing/planItems
Управляет элементами порядка служения (заголовками, разделами, песнями и т. д.), организованными в древовидную структуру «родитель — потомки».
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить элемент плана по ID |
| GET | /ids?ids= | JWT | — | Получить несколько элементов плана по ID, перечисленным через запятую |
| GET | /plan/:planId | JWT | — | Получить все элементы плана (возвращается древовидная структура) |
| GET | /presenter/:churchId/:planId | Public | — | Получить элементы плана для вида презентатора (древовидная структура) |
| POST | / | JWT | — | Создать или обновить элементы плана |
| POST | /sort | JWT | — | Обновить порядок сортировки элемента плана (пересортировывает соседние элементы) |
| DELETE | /:id | JWT | — | Удалить элемент плана |
Лента плана
Базовый путь: /doing/planFeed
Предоставляет ленты элементов плана для презентатора. Если элементов плана нет, автоматически заполняет их из ленты площадки Lessons.church по contentId плана.
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | /presenter/:churchId/:planId | Public | — | Получить ленту плана для презентатора (автоматически заполняется из ленты площадки, если она пуста) |
Позиции
Базовый путь: /doing/positions
Наследует базовый класс CRUD (GET /:id, POST /, DELETE /:id — без проверок прав).
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить позицию по ID |
| GET | /ids?ids= | JWT | — | Получить несколько позиций по ID, перечисленным через запятую |
| GET | /plan/ids?planIds= | JWT | — | Получить позиции нескольких планов по ID планов, перечисленным через запятую |
| GET | /plan/:planId | JWT | — | Получить все позиции плана |
| POST | / | JWT | — | Создать или обновить позиции |
| DELETE | /:id | JWT | — | Удалить позицию |
Времена
Базовый путь: /doing/times
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | /all | JWT | — | Список всех времён церкви |
| GET | /:id | JWT | — | Получить время по ID |
| GET | /plans?planIds= | JWT | — | Получить времена нескольких планов по ID планов, перечисленным через запятую |
| GET | /plan/:planId | JWT | — | Получить все времена плана |
| POST | / | JWT | — | Создать или обновить времена |
| DELETE | /:id | JWT | — | Удалить время |
Назначения
Базовый путь: /doing/assignments
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | /my | JWT | — | Получить назначения текущего пользователя |
| GET | /my/upcoming | JWT | — | До 20 назначений текущего пользователя в планах с датой от вчерашнего дня и позже (планы в статусе penciled-in или prepared пропускаются), ближайшие первыми: { assignmentId, status, positionName, planId, planName, serviceDate }. Используется для превью служения на домашней странице участника |
| GET | /:id | JWT | — | Получить назначение по ID |
| GET | /plan/ids?planIds= | JWT | — | Получить назначения нескольких планов по ID планов, перечисленным через запятую |
| GET | /plan/:planId | JWT | — | Получить все назначения плана |
| POST | / | JWT | — | Создать или обновить назначения (статус по умолчанию — "Unconfirmed") |
| POST | /accept/:id | JWT | — | Принять назначение (только назначенный человек) |
| POST | /decline/:id | JWT | — | Отклонить назначение (только назначенный человек) |
| POST | /signup | JWT | — | Самостоятельная запись на позицию. Тело: { positionId }. Позиция должна разрешать самозапись и иметь свободные места; создаёт назначение со статусом Accepted. Отклоняется с сообщением "Signup deadline has passed", если срок самозаписи плана (отсчитываемый от его первого времени служения, как описано выше) уже прошёл |
| DELETE | /signup/:id | JWT | — | Отменить собственную самозапись. Отклоняется с сообщением "Removal deadline has passed" после срока самозаписи плана |
| DELETE | /:id | JWT | — | Удалить назначение |
Пример: принятие назначения
POST /doing/assignments/accept/assign-123
Authorization: Bearer <token>
{
"id": "assign-123",
"personId": "person-456",
"positionId": "pos-789",
"planId": "plan-abc",
"status": "Accepted"
}
Даты недоступности
Базовый путь: /doing/blockoutDates
Наследует базовый класс CRUD (GET /:id, DELETE /:id — без проверок прав).
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить дату недоступности по ID |
| GET | /ids?ids= | JWT | — | Получить несколько дат недоступности по ID, перечисленным через запятую |
| GET | /my | JWT | — | Получить даты недоступности текущего пользователя |
| GET | /upcoming | JWT | — | Получить все предстоящие даты недоступности церкви |
| POST | / | JWT | — | Создать или обновить даты недоступности (если personId не передан, по умолчанию — текущий пользователь) |
| DELETE | /:id | JWT | — | Удалить дату недоступности |
Задачи
Базовый путь: /doing/tasks
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | / | JWT | — | Получить открытые задачи текущего пользователя |
| GET | /:id | JWT | — | Получить задачу по ID |
| GET | /:id/contact | JWT | Право видеть карточку | Контактные данные человека, к которому относится карточка рабочего процесса: { personId, displayName, mobilePhone, email }. Позволяет назначенному исполнителю без доступа к People связаться с этим человеком |
| GET | /closed | JWT | — | Получить закрытые задачи текущего пользователя |
| GET | /timeline?taskIds= | JWT | — | Получить данные временной шкалы для задач по ID задач, перечисленным через запятую |
| GET | /directoryUpdate/:personId | JWT | — | Получить задачу обновления каталога для человека |
| POST | / | JWT | — | Создать или обновить задачи. Добавьте ?type=directoryUpdate, чтобы обрабатывать задачи обновления каталога (фото загружаются автоматически) |
| POST | /:id/conversation | JWT | tasks.edit или исполнитель карточки | Прикрепить беседу с заметками к карточке. Тело: { conversationId }. Побеждает первая прикреплённая беседа; последующие вызовы возвращают карточку без изменений |
| POST | /loadForGroups | JWT | — | Загрузить задачи для конкретных групп. Тело: { groupIds: [], status: "Open" } |
Автоматизации
Базовый путь: /doing/automations
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | / | JWT | — | Список всех автоматизаций церкви |
| GET | /:id | JWT | — | Получить автоматизацию по ID |
| GET | /check | Public | — | Запустить проверку всех автоматизаций |
| POST | / | JWT | — | Создать или обновить автоматизации |
| DELETE | /:id | JWT | — | Удалить автоматизацию |
Действия
Базовый путь: /doing/actions
Действия определяют, что происходит при срабатывании автоматизации.
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить действие по ID |
| GET | /automation/:id | JWT | — | Получить все действия автоматизации |
| POST | / | JWT | — | Создать или обновить действия |
| DELETE | /:id | JWT | — | Удалить действие |
Условия
Базовый путь: /doing/conditions
Условия задают критерии, по которым срабатывает автоматизация.
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить условие по ID |
| GET | /automation/:id | JWT | — | Получить все условия автоматизации |
| POST | / | JWT | — | Создать или обновить условия |
| DELETE | /:id | JWT | — | Удалить условие |
Связки условий
Базовый путь: /doing/conjunctions
Связки объединяют несколько условий в автоматизации (логика И/ИЛИ).
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить связку по ID |
| GET | /automation/:id | JWT | — | Получить все связки автоматизации |
| POST | / | JWT | — | Создать или обновить связки |
| DELETE | /:id | JWT | — | Удалить связку |
Аутентификации поставщиков контента
Базовый путь: /doing/contentProviderAuths
Наследует базовый класс CRUD (GET /, GET /:id, POST /, DELETE /:id — без проверок прав).
Управляет записями OAuth-аутентификации для внешних поставщиков контента (например, интеграций с программами для презентаций).
Поля accessToken и refreshToken шифруются при хранении с помощью EncryptionHelper и расшифровываются при чтении, поэтому API по-прежнему возвращает токены в открытом виде. Записи, сохранённые до введения шифрования, содержат токены в открытом виде (которые никогда не содержат |); они возвращаются как есть и шифруются при следующем сохранении.
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| GET | / | JWT | — | Список всех аутентификаций поставщиков контента |
| GET | /:id | JWT | — | Получить аутентификацию поставщика контента по ID |
| GET | /ids?ids= | JWT | — | Получить несколько аутентификаций по ID, перечисленным через запятую |
| GET | /ministry/:ministryId | JWT | — | Получить все аутентификации поставщиков контента для служения |
| GET | /ministry/:ministryId/:providerId | JWT | — | Получить запись аутентификации для конкретных служения и поставщика |
| POST | / | JWT | — | Создать или обновить аутентификации поставщиков контента |
| DELETE | /:id | JWT | — | Удалить аутентификацию поставщика контента |
Прокси поставщика
Базовый путь: /doing/providerProxy
Перенаправляет запросы внешним поставщикам контента (например, ProPresenter, EasyWorship). Автоматически обновляет токены, когда они истекают.
| Метод | Путь | Auth | Права | Описание |
|---|---|---|---|---|
| POST | /browse | JWT | — | Просмотр файлов поставщика контента. Тело: { ministryId, providerId, path } |
| POST | /getPresentations | JWT | — | Получить презентации от поставщика контента. Тело: { ministryId, providerId, path } |
| POST | /getPlaylist | JWT | — | Получить плейлист от поставщика контента. Тело: { ministryId, providerId, path, resolution } |
| POST | /getInstructions | JWT | — | Получить инструкции для элемента контента. Тело: { ministryId, providerId, path } |
| POST | /getExpandedInstructions | JWT | — | Получить развёрнутые инструкции для элемента контента. Тело: { ministryId, providerId, path } |
Связанные страницы
- Эндпоинты Membership — люди, группы, роли и права
- Эндпоинты Attendance — учёт служений и посещений
- Структура модулей — организация кода