Pular para o conteúdo principal

Get dashboard notifications and pending actions

GET 
/company/notifications/dashboard

Recupera informações consolidadas para o dashboard de notificações da empresa, incluindo notificações não lidas e alertas de ações pendentes, como leilões sem assinatura.

Objetivo​

Permitir que as empresas visualizem em um único endpoint todos os alertas críticos e notificações pendentes, otimizando a experiência do usuário no dashboard principal.

Casos de uso​

  • Dashboard principal: Carregamento inicial do dashboard empresarial
  • Atualização em tempo real: Atualização periódica de notificações
  • Alertas de assinatura: Lembrete de leilões pendentes de assinatura pela empresa
  • Monitor de atividade: Acompanhamento de notificações não lidas

Fluxo de dados​

O endpoint implementa um sistema de priorização com slots limitados (máximo de 6 itens):

flowchart TD
    A[Solicitar Dashboard] --> B{Usuário Autenticado?}
    B -->|Não| C[404 USER_NOT_FOUND]
    B -->|Sim| D{Empresa Existe?}
    D -->|Não| E[401 CIA_NOT_FOUND]
    D -->|Sim| F[Obter Dados da Empresa]
    F --> G{Assinatura Ausente?}
    G -->|Sim| H[companyMissingSignature: true]
    G -->|Não| I[companyMissingSignature: false]
    H --> J[Encontrar Leilões Sem Assinatura]
    I --> J
    J --> K{Contagem > 6?}
    K -->|Sim| L[Limite: 6 Leilões]
    K -->|Não| M[Usar Todos os Leilões]
    L --> N[Calcular Slots Disponíveis]
    M --> N
    N --> O{Slots > 0?}
    O -->|Não| P[Retornar Dashboard]
    O -->|Sim| Q[Obter Notificações Não Lidas]
    Q --> R[Preencher Slots Disponíveis]
    R --> S[Retornar Dashboard - 200]

Campos de resposta​

companyMissingSignature (booleano):

  • true: A empresa não completou seu processo

Request​

Responses​

Dashboard de notificações recuperado com sucesso.

O objeto de resposta contém até 6 elementos distribuídos entre:

  • Leilões pendentes de assinatura (prioridade máxima)
  • Notificações não lidas (preenchem os slots restantes)