Listado de Actas - WebService

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 servicio puede incluir el listado de estudiantes inscriptos en cada acta y también los miembros configurados como presidente y vocal, según los parámetros enviados en la consulta.

👥¿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?

Endpoint: GET /api/v1/WSExaminationRecords/getList

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

🧾 PARÁMETROS DISPONIBLES

ParámetroTipoDescripción
schoolYearIdnuméricoFiltra por ciclo lectivo.
careerId[]arregloFiltra por una o más carreras.
callnuméricoFiltra por número de llamado.
subjectId[]arregloFiltra por una o más materias.
year[]arregloFiltra por uno o más años.
withPresidentMembersbooleanoSi se envía en true, agrega presidente y vocales de cada acta. Por defecto es false.
withStudentsbooleanoSi se envía en true, agrega los estudiantes de cada acta. Por defecto es false.
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/getList.
  2. Envíe el header X-API-KEY con una clave válida.
  3. Agregue los filtros que necesite. Todos son opcionales.
  4. Si desea incluir estudiantes, envíe withStudents=true.
  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/getList

Ejemplo con filtros: GET /api/v1/WSExaminationRecords/getList?schoolYearId=1&year[]=1&call=1

Ejemplo con datos ampliados: GET /api/v1/WSExaminationRecords/getList?withStudents=true&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

Students

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

  • recordNumberId
  • lastName
  • firstName

No se incluyen inscripciones eliminadas.

President and Members

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 disponibles de un ciclo lectivo.
  • Obtener actas de determinadas carreras o materias.
  • Filtrar por llamado para procesos administrativos específicos.
  • Recuperar estudiantes asociados a cada acta para cruces de información.
  • Recuperar presidente y vocales para control o seguimiento institucional.

⚠️ CONSIDERACIONES IMPORTANTES

  • Las actas eliminadas no deben aparecer en el listado.
  • Los filtros se combinan entre sí. Es decir, si envía varios filtros, el sistema devuelve solo las actas que cumplen todas las condiciones indicadas.
  • El filtro por número de llamado aplica sobre escenarios donde ese dato exista y haya sido configurado.

Errores:

SituaciónResultado esperado
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.
Filtro sin coincidenciasHTTP 200 con data = [] y paginación en cero.

❓ PREGUNTAS FRECUENTES

¿Puedo consultar el servicio sin enviar filtros?

Sí. En ese caso el sistema devuelve el listado paginado de actas disponibles, respetando el límite máximo por página.

¿El servicio siempre devuelve estudiantes y miembros del acta?

No. Solo los incluye cuando se envían los parámetros withStudents=true o withPresidentMembers=true.

¿Qué ocurre si envío un parámetro incorrecto?

El sistema responde con un error y detalla el inconveniente para que usted pueda corregir la solicitud.

🖼️ EJEMPLOS VISUALES

Ejemplo de respuesta base del servicio

Respuesta base del listado de actas

Ejemplo con estudiantes incluidos

Respuesta con students

Ejemplo con presidente y vocales incluidos

Respuesta con presidentAndMembers

Ejemplo de control de acceso por permiso

Error por falta de permiso
    • Related Articles

    • 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, ...
    • 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, ...
    • 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. ...
    • 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 ...