Logo SOAR

Reservar Avaliação por Email

Descrição

Este endpoint permite reservar uma avaliação para um usuário específico através do email. É usado quando um practitioner ou administrador quer atribuir uma avaliação a alguém que ainda não possui conta no sistema.

Verbo

POST

Endpoint

/assessment/reserve

Headers

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

Campos Obrigatórios

email (string) Obrigatório Email do usuário para quem a avaliação será reservada
assessment_type (string) Obrigatório Tipo de avaliação (ex: "personality", "skills")
licence_id (string) Obrigatório ID da licença que será utilizada

Campos Opcionais

first_name (string) Opcional Nome do usuário (se conhecido)
last_name (string) Opcional Sobrenome do usuário (se conhecido)
group_id (integer) Opcional ID do grupo (se aplicável)

Exemplo de Request Body

{
  "email": "usuario@exemplo.com",
  "assessment_type": "personality",
  "licence_id": "uuid-licenca-123",
  "first_name": "João",
  "last_name": "Silva",
  "group_id": 456
}

Resposta de Sucesso (201)

{
  "success": true,
  "message": "Assessment reserved successfully.",
  "data": {
    "reservation_id": "uuid-reserva-789",
    "email": "usuario@exemplo.com",
    "assessment_type": "personality",
    "licence_id": "uuid-licenca-123",
    "status": "reserved",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Possíveis Erros

400 Bad Request

Dados inválidos ou campos obrigatórios ausentes

401 Unauthorized

Token JWT inválido ou expirado

403 Forbidden

Usuário não tem permissão para reservar avaliações

409 Conflict

Licença já está em uso ou email já possui avaliação reservada

Observações

  • Este endpoint requer autenticação JWT válida
  • Apenas practitioners, master practitioners e administradores podem reservar avaliações
  • A licença deve estar disponível (status "available")
  • Uma avaliação reservada pode ser iniciada posteriormente pelo usuário
  • O sistema pode enviar email de notificação para o usuário