Árvore Docs Guia

Motrix

Enviar resultado de avaliações

POST /api/v1/motrix/update_user_result

Este endpoint é responsável pela atualização da avaliação de um usuário.

Atributos

CampoTipoObrigatórioDescrição
user_idnumbersimID de referência da Árvore. Ex: 123
assessment_idnumbersimID de referência da avaliação passado no início da sessão. Ex: 123
statusenumsimStatus do resultado: CLOSED, EXPIRED ou OPEN
degreeenumsimAno escolar do aluno: 15 (EF I), 69 (EF II)
complexity_percentilenumbersimPercentil da complexidade calculada
complexity_indexnumbersimÍndice da complexidade calculada
decodification_percentilenumbersimPercentil da decodificação calculada
decodification_indexnumbersimÍndice da decodificação calculada
comprehension_percentilenumbersimPercentil da compreensão calculada
comprehension_indexnumbersimÍndice da compreensão calculada
successbooleansimIndica se a avaliação foi bem sucedida ou não
reasonstringnãoMotivo do erro, caso a avaliação não tenha sido bem sucedida
Request
POST /api/v1/motrix/update_user_result
Authorization: APIAuth access_key_id:signature
Content-MD5: <hash-content-md5>
DATE: Thu, 03 Dec 2020 16:43:58 GMT
{
    "user_id": 123,
    "assessment_id": 123,
    "degree": "1",
    "complexity_percentile": 12.0,
    "complexity_index": 2.0,
    "decodification_percentile": 12.0,
    "decodification_index": 2.0,
    "comprehension_percentile": 12.0,
    "comprehension_index": 2.0,
    "success": true,
    "status": "CLOSED"
}
Response

200 OK

{
    "success": true,
    "data": {
        "message": "User assessment result updated!"
    }
}

400 Bad Request — quando não envia os campos requeridos corretamente.

{
    "success": false,
    "errors": [
        {"assessment_id": ["can't be blank"]},
        {"complexity_index": ["can't be blank"]},
        {"complexity_percentile": ["can't be blank"]},
        {"comprehension_index": ["can't be blank"]},
        {"comprehension_percentile": ["can't be blank"]},
        {"decodification_index": ["can't be blank"]},
        {"decodification_percentile": ["can't be blank"]},
        {"degree": ["can't be blank"]},
        {"status": ["can't be blank"]},
        {"success": ["can't be blank"]},
        {"user_id": ["can't be blank"]}
    ],
    "status_code": 400
}

400 Bad Request — quando envia um user_id inválido.

{
    "success": false,
    "errors": [
        {"user": ["does not exist"]}
    ],
    "status_code": 400
}