Pular para o conteúdo principal

Endpoints de Doing

O módulo Doing gerencia o planejamento de cultos, a escala de voluntários, o gerenciamento de tarefas e as automações. Ele oferece ferramentas para criar planos de culto com horários e posições, designar voluntários, gerenciar datas de indisponibilidade, montar itens da ordem do culto, conectar-se a provedores externos de conteúdo e configurar fluxos automatizados com condições e ações.

Caminho base: /doing

Planos​

Caminho base: /doing/plans

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Lista todos os planos da igreja
GET/:idJWT—Obtém um plano pelo ID
GET/ids?ids=JWT—Obtém vários planos por IDs separados por vírgula
GET/types/:planTypeIdJWT—Obtém os planos de um tipo de plano
GET/textRange?startDate=&endDate=&ministryId=&planTypeId=JWTtexting.send + edição do ministérioPrévia da mensagem de Enviar texto aos voluntários da visão geral de atendimento: { totalMembers, eligibleCount, optedOutCount, noPhoneCount, capped } para os voluntários designados no intervalo (um por pessoa, pulando os que cancelaram a inscrição e os sem número, números compartilhados deduplicados, limitado a 200)
GET/presenterJWT—Obtém os planos dos próximos 7 dias (visão de apresentador)
GET/confirmationWorkflows?ministryId=JWTEdição do ministérioFluxos de trabalho ativos de confirmação de atribuição de atendimento (workflowType = "assignmentConfirmation") que um plano pode selecionar: [{ id, name }]
GET/public/current/:planTypeIdPública—Obtém o plano atual de um tipo de plano
GET/public/signup/:churchIdPública—Planos abertos para inscrição própria, do mais próximo para o mais distante, cada um com suas posições de inscrição própria (ordenadas por categoryName e depois name, mais filledCount das atribuições Aceitas/Não confirmadas) e horários. Sem nomes de voluntários. Quando a configuração da igreja volunteerSignupNextOnly é "true", só o primeiro plano de cada tipo é retornado. Cada plan inclui um signupDeadline calculado (instante ISO, ou null): signupDeadlineHours antes do horário service mais cedo do plano (qualquer horário com hora, se não houver horário de culto; 9:00 no fuso horário da igreja em serviceDate se o plano não tiver horários)
GET/signup/:planId/volunteersJWT—[{ positionId, names }] para as posições de inscrição própria do plano (nomes de exibição dos designados Aceitos/Não confirmados). Retorna [] a menos que o showVolunteerNames do plano esteja ativado
POST/JWT—Cria ou atualiza planos (aceita um objeto único ou uma lista). Defina confirmationWorkflowId para aderir a um fluxo de confirmação de atendimento, ou null para sair nas próximas solicitações. Envie signupDeadlineHours: null para limpar um prazo; omitir o campo mantém o valor salvo
POST/copy/:idJWTEdição do ministérioCopia um plano, incluindo posições, horários, atribuições e itens da ordem do culto. O corpo inclui ministryId, serviceDate, copyMode ("none", "positions", "all") e copyServiceOrder (booleano). Sem targetPlanId, um novo plano é criado, e notes, signupDeadlineHours, showVolunteerNames e autoReplaceOnDecline são herdados do plano de origem, a menos que o corpo os informe. Com targetPlanId, a cópia preenche esse plano existente (quem chama precisa poder editá-lo). A opção Repetir semanalmente do B1Admin chama isso uma vez por semana, copiando sempre do plano criado na semana anterior
POST/textRangeJWTtexting.send + edição do ministérioEnvia mensagem de texto a todos os voluntários designados em um intervalo de datas pelo provedor de SMS da igreja. Corpo: { startDate, endDate, ministryId, planTypeId?, message } (mensagem de até 1600 caracteres; campos de mesclagem resolvidos por destinatário). Retorna as contagens da prévia, além de recipientCount, successCount, failCount e error (no_provider ou insufficient_credits) quando o envio é interrompido antes do fim
POST/:id/issueRequestsJWTEdição do planoEmite as novas atribuições Não confirmadas e ainda não notificadas do plano pelo seu fluxo de confirmação: marca cada uma como notificada e inicia um cartão de fluxo de trabalho por atribuição. Corpo vazio; retorna { issued }. Falha a menos que o plano esteja publicado (não prepared), tenha um confirmationWorkflowId ativo com pelo menos uma etapa, e o prazo de resposta não tenha passado
POST/autofill/:idJWT—Preenche automaticamente as atribuições de voluntários de um plano. Corpo: { teams: [{ positionId, personIds }] }
DELETE/:idJWT—Exclui um plano e todos os horários, atribuições, posições e itens do plano relacionados

Exemplo: copiar um plano​

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

Tipos de plano​

Caminho base: /doing/planTypes

Estende a classe base CRUD (GET /, GET /:id, POST /, DELETE /:id — sem verificações de permissão).

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Lista todos os tipos de plano
GET/:idJWT—Obtém um tipo de plano pelo ID
GET/ids?ids=JWT—Obtém vários tipos de plano por IDs separados por vírgula
GET/ministryId/:ministryIdJWT—Obtém os tipos de plano de um ministério
POST/JWT—Cria ou atualiza tipos de plano
DELETE/:idJWT—Exclui um tipo de plano

Itens do plano​

Caminho base: /doing/planItems

Gerencia os itens da ordem do culto (cabeçalhos, seções, músicas etc.), organizados em uma estrutura de árvore pai-filho.

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/:idJWT—Obtém um item do plano pelo ID
GET/ids?ids=JWT—Obtém vários itens do plano por IDs separados por vírgula
GET/plan/:planIdJWT—Obtém todos os itens do plano (retorna estrutura de árvore)
GET/presenter/:churchId/:planIdPública—Obtém os itens do plano para a visão de apresentador (retorna estrutura de árvore)
POST/JWT—Cria ou atualiza itens do plano
POST/sortJWT—Atualiza a ordem de um item do plano (reordena os irmãos)
DELETE/:idJWT—Exclui um item do plano

Feed do plano​

Caminho base: /doing/planFeed

Fornece os feeds de itens do plano para o apresentador. Se não houver itens do plano, preenche automaticamente a partir do feed de venue do Lessons.church usando o contentId do plano.

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/presenter/:churchId/:planIdPública—Obtém o feed do plano para o apresentador (preenche automaticamente a partir do feed de venue se estiver vazio)

Posições​

Caminho base: /doing/positions

Estende a classe base CRUD (GET /:id, POST /, DELETE /:id — sem verificações de permissão).

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/:idJWT—Obtém uma posição pelo ID
GET/ids?ids=JWT—Obtém várias posições por IDs separados por vírgula
GET/plan/ids?planIds=JWT—Obtém as posições de vários planos por IDs de planos separados por vírgula
GET/plan/:planIdJWT—Obtém todas as posições de um plano
POST/JWT—Cria ou atualiza posições
DELETE/:idJWT—Exclui uma posição

Horários​

Caminho base: /doing/times

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/allJWT—Lista todos os horários da igreja
GET/:idJWT—Obtém um horário pelo ID
GET/plans?planIds=JWT—Obtém os horários de vários planos por IDs de planos separados por vírgula
GET/plan/:planIdJWT—Obtém todos os horários de um plano
POST/JWT—Cria ou atualiza horários
DELETE/:idJWT—Exclui um horário

Atribuições​

Caminho base: /doing/assignments

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/myJWT—Obtém as atribuições do usuário atual
GET/my/upcomingJWT—Até 20 atribuições do usuário atual em planos com data a partir de ontem (planos reservados, ou prepared, são ignorados), das mais próximas para as mais distantes: { assignmentId, status, positionName, planId, planName, serviceDate }. Alimenta a prévia de atendimento na página inicial do membro
GET/:idJWT—Obtém uma atribuição pelo ID
GET/plan/ids?planIds=JWT—Obtém as atribuições de vários planos por IDs de planos separados por vírgula
GET/plan/:planIdJWT—Obtém todas as atribuições de um plano
POST/JWT—Cria ou atualiza atribuições (define o status como "Unconfirmed" por padrão)
POST/accept/:idJWT—Aceita uma atribuição (deve ser a pessoa designada)
POST/decline/:idJWT—Recusa uma atribuição (deve ser a pessoa designada)
POST/signupJWT—Inscrição própria em uma posição. Corpo: { positionId }. A posição precisa permitir inscrição própria e ter vaga; cria uma atribuição Aceita. Rejeitada com "Signup deadline has passed" depois que o prazo de inscrição do plano (contado a partir do primeiro horário de culto, como acima) passa
DELETE/signup/:idJWT—Remove a sua própria inscrição. Rejeitada com "Removal deadline has passed" depois do prazo de inscrição do plano
DELETE/:idJWT—Exclui uma atribuição

Exemplo: aceitar uma atribuição​

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

Datas de indisponibilidade​

Caminho base: /doing/blockoutDates

Estende a classe base CRUD (GET /:id, DELETE /:id — sem verificações de permissão).

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/:idJWT—Obtém uma data de indisponibilidade pelo ID
GET/ids?ids=JWT—Obtém várias datas de indisponibilidade por IDs separados por vírgula
GET/myJWT—Obtém as datas de indisponibilidade do usuário atual
GET/upcomingJWT—Obtém todas as datas de indisponibilidade futuras da igreja
POST/JWT—Cria ou atualiza datas de indisponibilidade (define o personId como o usuário atual se não informado)
DELETE/:idJWT—Exclui uma data de indisponibilidade

Tarefas​

Caminho base: /doing/tasks

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Obtém as tarefas abertas do usuário atual
GET/:idJWT—Obtém uma tarefa pelo ID
GET/:id/contactJWTPode ver o cartãoInformações de contato da pessoa a que um cartão de fluxo de trabalho se refere: { personId, displayName, mobilePhone, email }. Permite que quem chama designado, sem acesso a Pessoas, alcance a pessoa
GET/closedJWT—Obtém as tarefas fechadas do usuário atual
GET/timeline?taskIds=JWT—Obtém os dados de linha do tempo das tarefas por IDs separados por vírgula
GET/directoryUpdate/:personIdJWT—Obtém a tarefa de atualização de diretório de uma pessoa
POST/JWT—Cria ou atualiza tarefas. Adicione ?type=directoryUpdate para tratar tarefas de atualização de diretório (envia fotos automaticamente)
POST/:id/conversationJWTtasks.edit ou responsável pelo cartãoAnexa a conversa de notas ao cartão. Corpo: { conversationId }. A primeira conversa anexada prevalece; chamadas posteriores retornam o cartão sem alteração
POST/loadForGroupsJWT—Carrega tarefas de grupos específicos. Corpo: { groupIds: [], status: "Open" }

Automações​

Caminho base: /doing/automations

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Lista todas as automações da igreja
GET/:idJWT—Obtém uma automação pelo ID
GET/checkPública—Dispara uma verificação de todas as automações
POST/JWT—Cria ou atualiza automações
DELETE/:idJWT—Exclui uma automação

Ações​

Caminho base: /doing/actions

As ações definem o que acontece quando uma automação é disparada.

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/:idJWT—Obtém uma ação pelo ID
GET/automation/:idJWT—Obtém todas as ações de uma automação
POST/JWT—Cria ou atualiza ações
DELETE/:idJWT—Exclui uma ação

Condições​

Caminho base: /doing/conditions

As condições definem os critérios que disparam uma automação.

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/:idJWT—Obtém uma condição pelo ID
GET/automation/:idJWT—Obtém todas as condições de uma automação
POST/JWT—Cria ou atualiza condições
DELETE/:idJWT—Exclui uma condição

Conjunções​

Caminho base: /doing/conjunctions

As conjunções vinculam várias condições em uma automação (lógica E/OU).

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/:idJWT—Obtém uma conjunção pelo ID
GET/automation/:idJWT—Obtém todas as conjunções de uma automação
POST/JWT—Cria ou atualiza conjunções
DELETE/:idJWT—Exclui uma conjunção

Autenticações de provedores de conteúdo​

Caminho base: /doing/contentProviderAuths

Estende a classe base CRUD (GET /, GET /:id, POST /, DELETE /:id — sem verificações de permissão).

Gerencia os registros de autenticação OAuth de provedores externos de conteúdo (por exemplo, integrações com softwares de apresentação).

accessToken e refreshToken são criptografados em repouso com EncryptionHelper e descriptografados na leitura, então a API ainda retorna os tokens em texto simples. Registros salvos antes da criptografia contêm texto simples (que nunca contém |); eles são retornados como estão e criptografados na próxima vez que forem salvos.

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Lista todas as autenticações de provedores de conteúdo
GET/:idJWT—Obtém uma autenticação de provedor de conteúdo pelo ID
GET/ids?ids=JWT—Obtém várias autenticações de provedores de conteúdo por IDs separados por vírgula
GET/ministry/:ministryIdJWT—Obtém todas as autenticações de provedores de conteúdo de um ministério
GET/ministry/:ministryId/:providerIdJWT—Obtém o registro de autenticação de um ministério e provedor específicos
POST/JWT—Cria ou atualiza autenticações de provedores de conteúdo
DELETE/:idJWT—Exclui uma autenticação de provedor de conteúdo

Proxy de provedor​

Caminho base: /doing/providerProxy

Encaminha requisições para provedores externos de conteúdo (por exemplo, ProPresenter, EasyWorship). Renova os tokens automaticamente quando expiram.

MétodoCaminhoAutenticaçãoPermissãoDescrição
POST/browseJWT—Navega pelos arquivos do provedor de conteúdo. Corpo: { ministryId, providerId, path }
POST/getPresentationsJWT—Obtém as apresentações de um provedor de conteúdo. Corpo: { ministryId, providerId, path }
POST/getPlaylistJWT—Obtém uma playlist de um provedor de conteúdo. Corpo: { ministryId, providerId, path, resolution }
POST/getInstructionsJWT—Obtém as instruções de um item de conteúdo. Corpo: { ministryId, providerId, path }
POST/getExpandedInstructionsJWT—Obtém as instruções expandidas de um item de conteúdo. Corpo: { ministryId, providerId, path }

Páginas relacionadas​