Agenda - Agendamento de Atendimentos
O Agenda é o serviço de agendamento. As organizações configuram recursos disponíveis, horários e feriados. Cidadãos agendam atendimentos online ou via totem.
Conceitos Principais
Agendas
Uma Agenda é o container de configuração de agendamento. Cada agenda tem suas próprias regras de disponibilidade, recursos e categorias.
Categorias e Recursos
- Categoria: Tipo de serviço que pode ser agendado (ex.: "Certidão de Nascimento", "Registro de Imóvel")
- Recurso: Unidade específica de agendamento dentro de uma categoria (ex.: "Guichê 1 - Documentos", "Cartório A")
- Localização: Local físico onde o serviço é prestado
Tipos de Documento
Se for necessária verificação de identidade, configure Tipos de Documento (ex.: CPF, RG, Passaporte).
Disponibilidade
A disponibilidade é determinada por:
| Configuração | Descrição |
|---|---|
| Turnos de Trabalho | Dias da semana e horários em que cada recurso aceita agendamentos |
| Cota Diária | Máximo de agendamentos por dia por recurso |
| Feriados | Datas em que nenhum agendamento está disponível |
Agendamentos
Um registro de Agendamento inclui:
| Campo | Descrição |
|---|---|
name | Nome do cidadão |
email | E-mail de contato |
phone | Telefone de contato |
documentId | Número do documento |
date | Data do agendamento (YYYY-MM-DD) |
time | Horário (HH:MM) |
resource | Recurso reservado |
location | Local de atendimento |
status | scheduled, confirmed, canceled, attended |
code | Código único de agendamento (para referência do cidadão) |
printingInfo | Texto para imprimir na confirmação |
Guia do Operador
Configurar uma Categoria
- Vá em Admin → Categorias → Nova
- Defina nome, descrição e tipo de documento exigido (opcional)
- Salve
Configurar um Recurso
- Vá em Admin → Recursos → Novo
- Selecione a categoria e a localização
- Defina os Turnos de Trabalho (dias e horários)
- Defina a Cota Diária (máximo de agendamentos por dia)
- Salve
Gerenciar Feriados
- Vá em Configurações → Feriados
- Adicione datas de feriado - todos os recursos ficarão indisponíveis nessas datas
Visualizar Agendamentos
- Vá em Agendamentos para uma lista com filtros (data, localização, status)
- Vá em Calendário para uma visão calendário de todas as reservas
Exportação
A lista de agendamentos suporta exportação para CSV/Excel para relatórios.
Fluxo de Agendamento pelo Cidadão
- Cidadão acessa o portal de agendamento (ou totem)
- Seleciona categoria e recurso
- A API retorna datas disponíveis (
GET /api/agendas/{id}/dates) - Cidadão seleciona a data
- A API retorna horários disponíveis (
GET /api/agendas/{id}/times?date=YYYY-MM-DD) - Cidadão preenche dados pessoais e confirma
- Agendamento é criado (
POST /api/appointments) - Código de confirmação e resumo imprimível são retornados
Cancelamento
O cidadão pode cancelar usando o código de agendamento:
bash
DELETE /api/appointments/{id}?code=CODIGO_DO_AGENDAMENTOOperadores também podem cancelar pelo painel de administração.
