Iniciar Avaliação

Descrição

Este endpoint inicia uma nova avaliação, vinculando uma licença a um usuário e, opcionalmente, a um practitioner (profissional). A licença é marcada como reservada e a avaliação fica pendente até ser concluída.

Verbo

POST

URL Base

https://api.soargi.com

Endpoint

/assessment/start

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token
Content-Type application/json

Campos Esperados

Campo Tipo Obrigatório Descrição
licence string Sim ID da licença a ser utilizada na avaliação.
user_id string Sim ID do usuário que irá realizar a avaliação.
practitioner_id string Não ID do practitioner vinculado à avaliação.
assessment_type string Não Tipo da avaliação (ex: diagnóstico, final, etc).
user_view_results string Não Controle de visualização dos resultados pelo usuário (none, partial, full). Valor padrão: none.

Corpo da Requisição

{
    "licence": "123456",
    "user_id": "78910",
    "practitioner_id": "555",
    "assessment_type": "diagnóstico",
    "user_view_results": "partial"
}

Sucesso - 201

{
    "status": "success",
    "assessment_id": 42
}

Erro - 400 (Campos obrigatórios não enviados)

{
    "status": 400,
    "error": 400,
    "messages": "licence and user_id are required."
}

Erro - 404 (Licença inválida ou já utilizada)

{
    "status": 404,
    "error": 404,
    "messages": "Invalid or already used licence."
}

Erro - 500 (Erro interno)

{
    "status": 500,
    "error": 500,
    "messages": "Failed to start assessment."
}

Códigos de Resposta

  • 201 - Avaliação criada com sucesso
  • 400 - Campos obrigatórios não enviados
  • 404 - Licença inválida ou já utilizada
  • 500 - Erro interno ao iniciar avaliação

Observações

  • É necessário estar autenticado para acessar este endpoint.
  • O campo user_view_results aceita valores como none, partial ou full. Se não informado, o padrão é none.
  • O campo practitioner_id é opcional e pode ser omitido caso não haja um practitioner vinculado.
  • O endpoint só permite iniciar avaliações com licenças válidas e ativas.