Exportar Avaliações em CSV
Descrição
Este endpoint permite exportar todas as avaliações do sistema em formato CSV, incluindo informações detalhadas como usuário, practitioner, tipo de avaliação, status, datas e resultados. Os dados são filtrados de acordo com o role do usuário autenticado.
Verbo
GET
URL Base
https://api.soargi.com
Endpoint
/assessment/export/csv
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer Token |
Parâmetros de Consulta
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| search | string | Não | Termo de busca para filtrar avaliações por nome, sobrenome ou email do usuário. |
| status | string | Não | Filtrar por status da avaliação (pending, completed, cancelled). |
| date_from | string | Não | Data de início para filtrar avaliações (formato: YYYY-MM-DD). |
| date_to | string | Não | Data de fim para filtrar avaliações (formato: YYYY-MM-DD). |
Exemplo de URL
/assessment/export/csv?status=completed&date_from=2024-01-01&date_to=2024-12-31
Sucesso - 200
Retorna um arquivo CSV com o seguinte cabeçalho:
Assessment ID,Licence,User ID,First Name,Last Name,Email,Practitioner ID,Practitioner Name,Assessment Type,Status,Date Assignment,Date Conclusion,Organizations
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 export assessments."
}Códigos de Resposta
- 200 - Arquivo CSV gerado e retornado com sucesso
- 401 - Token inválido ou expirado
- 403 - Sem permissão para exportar avaliações
Estrutura do CSV
- Assessment ID: Identificador único da avaliação
- Licence: Código da licença utilizada
- User ID: ID do usuário que realizou a avaliação
- First Name: Primeiro nome do usuário
- Last Name: Último nome do usuário
- Email: Email do usuário
- Practitioner ID: ID do practitioner responsável
- Practitioner Name: Nome completo do practitioner
- Assessment Type: Tipo da avaliação
- Status: Status atual da avaliação
- Date Assignment: Data de atribuição da avaliação
- Date Conclusion: Data de conclusão (se aplicável)
- Organizations: Organizações do usuário (separadas por vírgula)
Controle de Acesso por Role
- Individual: Pode exportar apenas suas próprias avaliações
- Practitioner/Master Practitioner/Institutional: Pode exportar suas avaliações e as de usuários vinculados
- Admin/Super Admin: Pode exportar todas as avaliações do sistema
Observações
- É necessário estar autenticado para acessar este endpoint.
- O arquivo CSV é gerado dinamicamente baseado nos filtros aplicados.
- Os dados são filtrados automaticamente baseado no role do usuário.
- O arquivo pode ser baixado diretamente no navegador ou salvo localmente.
- Ideal para relatórios e análises em ferramentas como Excel, Google Sheets, etc.