Consultar actas de un estudiante - WebService

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, de forma opcional, el servicio puede incluir la información de presidente y vocales configurados en cada acta.

👥 ¿QUIÉN PUEDE UTILIZAR ESTA FUNCIONALIDAD?

  • Usuarios con rol administrador que además tengan habilitado el permiso 1701 - PERMISO_ACTAS_ACCESO_ACTAS.

📍 ¿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: GET /api/v1/WSExaminationRecords/getListByStudent

🧾 PARÁMETROS DISPONIBLES

ParámetroTipoDescripción
recordNumberIdnuméricoIdentificador del estudiante. Es obligatorio.
schoolYearIdnuméricoFiltra por ciclo lectivo. Es opcional.
careerIdnuméricoFiltra por carrera. Es opcional y admite un único valor.
withPresidentMembersbooleanoSi se envía en true, agrega presidente y vocales de cada acta.
pagenuméricoNúmero de página. La primera página es la 1.
limitnuméricoCantidad máxima por página. Si no se envía, se usa 500. Nunca devuelve más de 500 registros por página.

🚀 ¿CÓMO UTILIZARLA? — PASO A PASO

  1. Realice una solicitud GET al endpoint /api/v1/WSExaminationRecords/getListByStudent.
  2. Envíe el header X-API-KEY con una clave válida.
  3. Indique el parámetro obligatorio recordNumberId.
  4. Si lo necesita, agregue filtros por ciclo o carrera.
  5. Si desea incluir presidente y vocales, envíe withPresidentMembers=true.
  6. Revise la respuesta paginada y avance de página si necesita más resultados.

Ejemplo básico: GET /api/v1/WSExaminationRecords/getListByStudent?recordNumberId=123

Ejemplo con filtros: GET /api/v1/WSExaminationRecords/getListByStudent?recordNumberId=123&schoolYearId=1&careerId=5

Ejemplo con miembros del acta: GET /api/v1/WSExaminationRecords/getListByStudent?recordNumberId=123&withPresidentMembers=true

Datos que devuelve el servicio

CampoDescripción
examinationRecordIdIdentificador del acta.
schoolYearIdIdentificador del ciclo.
periodIdIdentificador del período.
careerIdIdentificador de la carrera.
subjectIdIdentificador de la materia.
yearAño.
callNumberNúmero de llamado.
gradeGroupIdIdentificador del grupo de calificación.
descriptionDescripción del acta.
examinationRecordDateFecha del acta.
examinationRecordHourHora del acta.
typeTipo de acta.
statusEstado del acta.

Datos adicionales opcionales

Si la consulta se realiza con withPresidentMembers=true, cada acta puede incluir el arreglo presidentAndMembers con estos datos:

  • individualId
  • lastName
  • firstName
  • type

Tipos de miembro:

  • 1: Presidente
  • 2: Vocal

Paginación

  • Si no se informa limit, el servicio utiliza 500.
  • Si se informa un valor mayor a 500, el sistema lo ajusta a 500.
  • La respuesta incluye datos de paginación como pagelimittotal y total_pages.

💡 CASOS DE USO FRECUENTES

  • Consultar todas las actas asociadas a un estudiante.
  • Filtrar las actas de un estudiante por ciclo lectivo.
  • Filtrar las actas de un estudiante por carrera.
  • Obtener el detalle de presidente y vocales vinculados a cada acta.
  • Usar la información para procesos administrativos externos al sistema.

⚠️ CONSIDERACIONES IMPORTANTES

  • El parámetro recordNumberId es obligatorio.
  • El parámetro careerId admite un único valor. No debe enviarse como arreglo.
  • Las actas eliminadas o las inscripciones eliminadas no aparecen en el resultado.
  • Si el estudiante no tiene actas, el servicio responde correctamente con una lista vacía.

Errores

SituaciónResultado esperado
Falta recordNumberIdHTTP 400 con error_code 1001.
Usuario sin rol administradorHTTP 403 con error_code 1003.
Administrador sin permiso 1701HTTP 403 con error_code 1003.
Parámetro no permitidoHTTP 400 con error_code 1002.
Tipo de parámetro inválidoHTTP 400 con error_code 1004.

❓ PREGUNTAS FRECUENTES

¿Puedo consultar este servicio sin indicar el estudiante?

No. El parámetro recordNumberId es obligatorio.

¿Qué ocurre si el estudiante no tiene actas?

El sistema responde correctamente con data = [] y la paginación en cero.

¿El servicio siempre devuelve presidente y vocales?

No. Solo los incluye cuando se envía withPresidentMembers=true.

🖼️ EJEMPLOS VISUALES

Ejemplo de respuesta base por estudiante


Ejemplo con presidente y vocales incluidos


Ejemplo de validación por parámetro obligatorio faltante

Error por falta de recordNumberId

Ejemplo de control de acceso por permiso

Error por falta de permiso
    • 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 ...
    • 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, ...
    • Vincular Actas de Examen con Moodle

      Vincular Actas de Examen con Moodle Esta guía explica cómo habilitar, vincular y gestionar las actas de examen directamente con el Campus Virtual (Moodle), permitiendo sincronizar docentes y estudiantes de manera automática. Requisitos Previos ...
    • Exportación del listado de actas a Excel

      ? ¿DE QUÉ TRATA ESTE ARTÍCULO? Esta funcionalidad le permite exportar a Excel el listado de actas para trabajar la información fuera del sistema. La exportación respeta el criterio de búsqueda aplicado en pantalla, de modo que el usuario pueda ...
    • 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. ...