Logo SOAR

Cancelar Avaliação

Descrição

Este endpoint permite cancelar uma avaliação em andamento ou reservada através do ID da licença. A licença é liberada e pode ser reutilizada para outras avaliações.

Verbo

DELETE

Endpoint

/assessment/cancel/{licenceId}

Headers

Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

Parâmetros de URL

licenceId (string) Obrigatório UUID da licença da avaliação a ser cancelada

Exemplo de URL

/assessment/cancel/550e8400-e29b-41d4-a716-446655440000

Resposta de Sucesso (200)

{
  "success": true,
  "message": "Assessment cancelled successfully.",
  "data": {
    "licence_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "cancelled",
    "cancelled_at": "2024-01-15T10:30:00Z",
    "licence_status": "available"
  }
}

Possíveis Erros

400 Bad Request

ID da licença inválido ou malformado

401 Unauthorized

Token JWT inválido ou expirado

403 Forbidden

Usuário não tem permissão para cancelar esta avaliação

404 Not Found

Licença ou avaliação não encontrada

409 Conflict

Avaliação já foi concluída e não pode ser cancelada

Observações

  • Este endpoint requer autenticação JWT válida
  • Apenas o proprietário da licença, practitioner responsável ou administradores podem cancelar
  • Avaliações já concluídas não podem ser canceladas
  • A licença é liberada e retorna ao status "available"
  • O histórico da avaliação é mantido para auditoria
  • Usuários com avaliações canceladas recebem notificação