Incorporar calificaciones en actas - WebService

Incorporar calificaciones en actas - WebService

📋 ¿DE QUÉ TRATA ESTE ARTÍCULO?

Este servicio web permite registrar o actualizar la calificación de un estudiante dentro de un acta de examen.

Además de la calificación principal, el servicio también puede guardar libro, folio, observaciones y, cuando la configuración del sistema lo permite, las calificaciones de escrito y oral.

👥 ¿QUIÉN PUEDE UTILIZAR ESTA FUNCIONALIDAD?

  • Usuarios con rol Administrador y permiso 1709 - PERMISO_ACTAS_GESTIONAR_CALIFICACIONES.
  • Usuarios con rol Docente y permiso 1720 - PERMISO_DOCENTE_REGISTRAR_CALIFICACIONES_ACTA.
    • En el caso de usuarios docentes, además del permiso correspondiente, deben estar vinculados al acta como presidente o vocal.

📍 ¿DÓNDE SE ENCUENTRA?

La invocación se realiza por fuera de la interfaz habitual del sistema, por ejemplo desde Postman o desde una integración externa.

Endpoint: PUT /api/v1/WSExaminationRecords/updateStudentGrade

🧾 PARÁMETROS DISPONIBLES

ParámetroTipoObligatorioDescripción
examinationRecordIdnuméricoIdentificador del acta.
studentIdnuméricoIdentificador del estudiante.
gradeIdnuméricoSí, salvo en readonlyIdentificador de la calificación principal. En inscripciones de solo lectura no debe enviarse.
gradeIdWrittennuméricoNoCalificación escrita.
gradeIdOralnuméricoNoCalificación oral.
booktextoNoLibro asociado a la registración.
foliotextoNoFolio asociado a la registración.
observationstextoNoObservaciones vinculadas a la calificación.

🚀 ¿CÓMO UTILIZARLA? — PASO A PASO

  1. Realice una solicitud PUT al endpoint /api/v1/WSExaminationRecords/updateStudentGrade.
  2. Envíe el encabezado X-API-KEY con una clave válida.
  3. Indique el examinationRecordId y el studentId.
  4. Envíe la calificación principal en gradeId, salvo que la inscripción sea de solo lectura.
  5. Si corresponde, complete bookfolio y observations.
  6. Si el sistema tiene habilitada la calificación escrita y oral, también puede enviar gradeIdWritten y gradeIdOral.
  7. Verifique la respuesta del servicio para confirmar que el registro fue actualizado correctamente.

Ejemplo básico:

{
"examinationRecordId": 100,
"studentId": 200,
"gradeId": 50
}

Ejemplo con datos complementarios:

{
"examinationRecordId": 100,
"studentId": 200,
"gradeId": 50,
"book": "12",
"folio": "45",
"observations": "Calificación registrada por integración"
}

Datos que devuelve el servicio

Cuando la operación es correcta, el servicio responde con estado HTTP 200 y una estructura similar a la siguiente:

{
"success": true,
"message": "...",
"data": {
"examinationRecordStudentId": 123,
"studentState": 20
}
}

studentState indica el estado recalculado del estudiante luego del guardado.

⚠️ CONSIDERACIONES IMPORTANTES

Recalculo del estado del estudiante

  • Si la calificación enviada corresponde a sin nota, y no representa ausente ni en proceso, el estudiante queda en estado PENDIENTE.
  • En cualquier otro caso, el estudiante queda en estado CALIFICADO.

Calificación escrita y oral

  • Si el parámetro MANEJO_CALIFICACION_ESCRITO_ORAL_ACTAS está activo, se pueden informar gradeIdWritten y gradeIdOral.
  • Si ese parámetro está desactivado y se envía alguno de esos dos valores, el servicio devuelve error.

Inscripciones de solo lectura

  • Si la inscripción del estudiante está marcada como readonly, solo se pueden actualizar bookfolio y observations.
  • En ese escenario no debe enviarse ninguna calificación.

💡 CASOS DE USO FRECUENTES

  • Registrar una calificación final de un estudiante en un acta de examen.
  • Actualizar libro, folio y observaciones de una inscripción ya existente.
  • Registrar calificación escrita y oral cuando esa modalidad está habilitada en el sistema.
  • Marcar una inscripción como pendiente al guardar una calificación equivalente a “sin nota”.

⚠️ CONSIDERACIONES IMPORTANTES

  • El servicio registra cambios sobre la inscripción del estudiante en el acta y también deja historial en la tabla de auditoría correspondiente.
  • Si el acta está cerrada, no se permite guardar cambios.
  • Si el estudiante no está inscripto en el acta o la inscripción fue eliminada, la operación no se realiza.
  • La validez de gradeIdgradeIdWritten y gradeIdOral depende del grupo de calificaciones configurado en el acta.

Errores:

SituaciónResultado esperado
Falta examinationRecordId o studentIdHTTP 400 con errorCode 1001.
Falta gradeId en una inscripción que no es readonlyHTTP 400 con errorCode 1001.
Parámetro no permitidoHTTP 400 con errorCode 1002.
Tipo de parámetro inválidoHTTP 400 con errorCode 1004.
Usuario sin rol habilitado o sin acceso suficienteHTTP 403 con errorCode 1003.
Docente con permiso pero no vinculado al acta como presidente o vocalHTTP 403 con errorCode 1003.
Calificación escrita u oral enviada con parámetro desactivadoHTTP 400 con errorCode 4001.
Acta cerradaHTTP 400 con errorCode 4002.
Inscripción readonly con intento de modificar calificacionesHTTP 400 con errorCode 4003.
Acta inexistenteHTTP 404 con errorCode 3001.
Estudiante no inscripto o inscripción eliminadaHTTP 404 con errorCode 3002.
Calificación inexistenteHTTP 404 con errorCode 3003.

❓ PREGUNTAS FRECUENTES

¿Siempre debo enviar gradeId?

Sí, excepto cuando la inscripción del estudiante sea de solo lectura. En ese caso, solo puede informar libro, folio y observaciones.

¿Puedo enviar calificación escrita y oral en cualquier caso?

No. Solo puede hacerlo cuando la configuración correspondiente esté habilitada en el sistema.

¿Qué ocurre si la calificación corresponde a “sin nota”?

El servicio guarda la información y deja al estudiante en estado pendiente, siempre que esa calificación no represente ausente ni en proceso.

🖼️ EJEMPLOS VISUALES

Ejemplo de request y respuesta exitosa

Request de actualización de calificación Respuesta exitosa del servicio

Ejemplo de calificación que deja al estudiante pendiente

Asignación de calificación sin nota 

Ejemplo de uso con calificación escrita y oral habilitada

Request y response con escrito y oral

Ejemplo de error por acta cerrada

Error por acta cerrada

Ejemplo de error por falta de datos o tipo inválido

Error por falta de gradeId Error por tipo inválido
    • Related Articles

    • Listado de Actas - WebService

      ? ¿DE QUÉ TRATA ESTE ARTÍCULO? Este artículo describe el servicio web que permite consultar un listado de actas por fuera del sistema ALPHA. La consulta puede realizarse con filtros opcionales y devuelve información general de cada acta. Además, el ...
    • Consultar actas de un estudiante - WebService

      ? ¿DE QUÉ TRATA ESTE ARTÍCULO? Este artículo describe el servicio web que permite consultar las actas asociadas a un estudiante. La consulta se realiza a partir del identificador del estudiante y puede complementarse con filtros adicionales. Además, ...
    • Cerrar cursada - WebService

      ? ¿DE QUÉ TRATA ESTE ARTÍCULO? Esta funcionalidad le permite ejecutar el cierre de una cursada desde un servicio web, sin necesidad de realizar el proceso manualmente dentro del sistema. El servicio utiliza la misma lógica de cierre ya existente en ...
    • Portal Docentes - Listado y descarga de actas y carga de calificaciones

      En el Portal Docentes, los profesores pueden visualizar las mesas o actas en las que están asignados como presidente o vocal. Estas se encuentran disponibles accediendo a la opción "Mis Actas de Examen" o "Mis P.O.E.C y Mesas" en el menú principal. ...
    • Visualización de deuda del alumno en la planilla de calificaciones

      El sistema permite visualizar la deuda total de un estudiante y el detalle de las cuotas que la componen directamente desde la planilla de calificaciones de una cursada. Esta funcionalidad facilita que el equipo académico tenga una visión clara de la ...