Descrição

Retorna uma lista paginada de avaliações filtradas por nome, sobrenome ou email do usuário. Suporta também filtro por status (completed, pending, reserved). Os dados são filtrados de acordo com o role do usuário autenticado. Retorna 12 registros por página por padrão.

Cabeçalhos

Parâmetros de Consulta

Sucesso - 200

{
  "status": "success",
  "message": "Assessments retrieved successfully.",
  "page": 1,
  "limit": 12,
  "total": 15,
  "assessments": [
    {
      "assessment_id": "123",
      "licence": "LIC001",
      "assessment_type": "work",
      "user_id": "456",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "avatarUrl": "https://api.soargi.com/avatar.jpg",
      "practitioner_id": "789",
      "practitioner_first_name": "Dr. Jane",
      "practitioner_last_name": "Smith",
      "org_names": ["OneFactory", "TechCorp"],
      "status": "pending",
      "date_assignment": "2024-01-15T10:00:00Z",
      "date_conclusion": null
    },
    {
      "assessment_id": "125",
      "licence": "LIC003",
      "assessment_type": "family",
      "user_id": "458",
      "first_name": "Johnny",
      "last_name": "Walker",
      "email": "johnny.walker@example.com",
      "avatarUrl": null,
      "practitioner_id": "789",
      "practitioner_first_name": "Dr. Jane",
      "practitioner_last_name": "Smith",
      "org_names": ["TechCorp"],
      "status": "completed",
      "date_assignment": "2024-01-05T08:00:00Z",
      "date_conclusion": "2024-01-08T16:30:00Z"
    }
  ]
}

Erro - 401 (Token inválido)

{
  "status": 401,
  "error": "Invalid or expired token."
}

Erro - 403 (Sem permissão)

{
  "status": 403,
  "error": "You do not have permission to access these assessments."
}

Códigos de Resposta

• 200 - Lista de avaliações retornada com sucesso
• 401 - Token inválido ou expirado
• 403 - Sem permissão para acessar avaliações

Controle de Acesso por Role

• Individual: Ve apenas suas próprias avaliações
• Practitioner/Master Practitioner/Institutional: Ve suas avaliações e as de usuários vinculados
• Admin/Super Admin: Ve todas as avaliações do sistema

Observações

• É necessário estar autenticado para acessar este endpoint.
• Os dados são filtrados automaticamente baseado no role do usuário.
• O campo org_names retorna um array com os nomes das organizações do usuário.
• As avaliações são ordenadas por data de criação (mais recentes primeiro).
• A busca funciona com LIKE, encontrando correspondências parciais.
• O parâmetro search busca em três campos: first_name, last_name e email.
• É possível combinar search com filtro de status para buscas mais específicas.
• A paginação padrão retorna 12 registros por página.

Exemplos de Uso