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.
1701 - PERMISO_ACTAS_ACCESO_ACTAS.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ámetro | Tipo | Descripción |
|---|---|---|
schoolYearId | numérico | Filtra por ciclo lectivo. |
careerId[] | arreglo | Filtra por una o más carreras. |
call | numérico | Filtra por número de llamado. |
subjectId[] | arreglo | Filtra por una o más materias. |
year[] | arreglo | Filtra por uno o más años. |
withPresidentMembers | booleano | Si se envía en true, agrega presidente y vocales de cada acta. Por defecto es false. |
withStudents | booleano | Si se envía en true, agrega los estudiantes de cada acta. Por defecto es false. |
page | numérico | Número de página. La primera página es la 1. |
limit | numérico | Cantidad máxima por página. Si no se envía, se usa 500. Nunca devuelve más de 500 registros por página. |
GET al endpoint /api/v1/WSExaminationRecords/getList.X-API-KEY con una clave válida.withStudents=true.withPresidentMembers=true.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
| Campo | Descripción |
|---|---|
examinationRecordId | Identificador del acta. |
schoolYearId | Identificador del ciclo. |
periodId | Identificador del período. |
careerId | Identificador de la carrera. |
subjectId | Identificador de la materia. |
year | Año. |
callNumber | Número de llamado. |
gradeGroupId | Identificador del grupo de calificación. |
description | Descripción del acta. |
examinationRecordDate | Fecha del acta. |
examinationRecordHour | Hora del acta. |
type | Tipo de acta. |
status | Estado del acta. |
Si la consulta se realiza con withStudents=true, cada acta puede incluir el arreglo students con estos datos:
recordNumberIdlastNamefirstNameNo se incluyen inscripciones eliminadas.
Si la consulta se realiza con withPresidentMembers=true, cada acta puede incluir el arreglo presidentAndMembers con estos datos:
individualIdlastNamefirstNametypeTipos de miembro:
1: Presidente2: Vocallimit, el servicio utiliza 500.500, el sistema lo ajusta a 500.page, limit, total y total_pages.| Situación | Resultado esperado |
|---|---|
| Usuario sin rol administrador | HTTP 403 con error_code 1003. |
| Administrador sin permiso 1701 | HTTP 403 con error_code 1003. |
| Parámetro no permitido | HTTP 400 con error_code 1002. |
| Tipo de parámetro inválido | HTTP 400 con error_code 1004. |
| Filtro sin coincidencias | HTTP 200 con data = [] y paginación en cero. |
¿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.



