Logo SOAR

Listar Avaliações

Descrição

Retorna uma lista paginada de avaliações do sistema, com informações detalhadas incluindo usuário, practitioner, tipo de avaliação, status e organizações. Suporta busca por nome, sobrenome ou email do usuário, e 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.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/assessment/list?page=1&limit=12&search=john&status=pending

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Parâmetros de Consulta

Parâmetro Tipo Obrigatório Descrição
page integer Não Número da página. Padrão: 1.
limit integer Não Quantidade de registros por página. Padrão: 12.
search string Não Termo de busca para filtrar por nome, sobrenome ou email do usuário.
status string Não Filtro por status da avaliação. Valores aceitos: "completed", "pending", "reserved".

Sucesso - 200

{
  "status": "success",
  "message": "Assessments retrieved successfully.",
  "page": 1,
  "limit": 12,
  "total": 45,
  "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": "124",
      "licence": "LIC002",
      "assessment_type": "family",
      "user_id": "457",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "jane.smith@example.com",
      "avatarUrl": null,
      "practitioner_id": "789",
      "practitioner_first_name": "Dr. Jane",
      "practitioner_last_name": "Smith",
      "org_names": ["OneFactory"],
      "status": "completed",
      "date_assignment": "2024-01-10T09:30:00Z",
      "date_conclusion": "2024-01-12T14:20: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 paginação padrão retorna 12 registros por página.
  • O filtro de status aceita apenas os valores: "completed", "pending" ou "reserved".
  • Todos os filtros (search, status) podem ser combinados com a paginação.