Obtener configuración de Censo
Método: GET
Ejemplo:
Instrucciones.
En la respuesta, están las configuraciones de todos los módulos que se utilizan en la aplicación: ACUERDO, CENSO, STAFF, ARTICULOS, etc.
Para obtener la configuración de CENSO, se debe recorrer el array que se encuentra en la respuesta en campo ´data´ y buscar el item donde el campo ´module´ sea CENSO.
Una vez encontrado este item dentro del array de ´data´, en el campo ´settings´ se encuentran todas las configuraciones de CENSO que deben ser aplicadas para el colegio en el ciclo escolar elegido.
Lista de alumnos
Descargar lista
Todo el colegio
Método: GET
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/censo/empresas/76/ciclos/1188/colegios/17919/reporteAlumnos?descargar=1
Por Nivel / Segmento
Método: GET
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/censo/empresas/76/ciclos/1188/colegios/17919/reporteAlumnos?descargar=1&nivelId=32
Activar/Inactivar Alumno
Método: POST
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/censo/empresas/76/ciclos/1188/colegios/17919/niveles/32/grados/85/grupos/2280/alumnos/26041025/activarInactivar
Payload:
{
"activo": 0,
"razonInactivoId": 0,
"observaciones": ""
}
Activo:
0 - para inactivar
1 - para activar
razonInactivoId: siempre en cero
observaciones: siempre string vacío
Validaciones:
Solo se permite activarInactivar alumnos si se cumplen las siguientes condiciones
El usuario firmado es administrador [SA, CTU, AN] sin importar el status del alumno y si tiene o no documentos aplicados con pago o cancelados
El usuario es gestor colegio [GC] y el alumno esta activo
data[].activo = true
El usuario es gestor colegio [GC] y el alumno está inactivo y no tiene documentos aplicados ya sea con pago o cancelados
data[].activo = false
data[].countDocumento2aplicados = 0
data[].countDocumento2cancelados = 0
Eliminar Alumno
Método: DELETE
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/censo/empresas/76/ciclos/1188/colegios/17919/niveles/33/grados/90/grupos/2280/alumnos/26039193/borrar
Validaciones:
Un alumno puede ser seleccionado para ser eliminado, solo si se cumplen las siguientes condiciones.
La configuración del candado no está prendida
Dentro de la configuración de CENSO, existe el objeto ´candado´. Se considera que el candado está activo solo si se cumplen las siguientes condiciones:
candado.activo = true
candado.fechaInicio <= fecha_actual
candado.fechaFinal > fecha_actual
Si el usuario tiene rol Administrador [SA], entonces NO se aplica el candado sin importar que esté activo.
El alumno NO tiene documentos
data[].documentos = false
El alumno NO tiene historial
data[].promovido = false
El alumno NO tiene Ipad Sincronizada
data[].ipadSincronizada = false
El porcentaje de pago es cero
data[].porcentajePago = 0
El alumno NO tiene observaciones
data[].observaciones = false
Mover Alumno
Método: POST
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/censo/empresas/76/ciclos/1188/colegios/17919/niveles/33/grados/90/grupos/2280/alumnos/26041017/mover
Payload:
{
"nuevoNivelId": 32,
"nuevoGradoId": 85,
"nuevoGrupoId": 2280,
"observaciones": "teste"
}
Editar Alumno
Al elegir la opción de editar alumno, se debe redireccionar al usuario a la vista del Perfil del Alumno
Validaciones:
Siempre se puede consultar el perfil de un alumno, pero solo se debe permitir editar un alumno si se cumplen las siguientes condiciones
El usuario firmado tiene rol Administrador [SA, CTU, AN]
El usuario firmado tiene rol Gestor Colegio [GC] y el alumno no tiene pago asociado y el porcentaje de pago es cero
data[].conPago = false
data[].porcentajePago = 0
Perfil de Alumno
Obtener Alumno por ID
Método: GET
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/prometeo/censo/empresas/76/ciclos/1188/colegios/17919/niveles/33/grados/90/grupos/2281/alumnos/26041387
Datos del Alumno
En base a la respuesta del servicio para obtener el alumno por ID, se obtiene la siguiente información.
Nombre: data.persona.nombreCompleto
Nivel/Segmento: data.nivel.nivel
Grado/Ano: data.grado.grado
Grupo/Turma: data.grupo.grupo
Sexo/Género: data.persona.sexoMoral
M: Masculino
F: Femenino
Activo: data.activo
Fecha de nacimiento: data.persona.fechaNacimiento
Fecha de registro: data.fechaDesde
ID Responsable: data.idResponsable
Debe mostrarse con el formato de CPF
Login: data.login
Información de los sellos
En base a la respuesta del servicio para obtener el alumno por ID, se obtiene la siguiente información.
sellos: data.empresas[].empresa
´empresas´ es un array donde cada item es un sello, se toma el campo ´empresa´ para indicar el nombre del sello.
se puede utilizar el campo ´parametro´ para identificar qué imagen mostrar en cada sello
se debe utilizar el campo ´empresaId´ para los siguientes llamados a la API que corresponden a las acciones en cada sello.
Obtener alumnos vinculados a cada sello
POR DEFINIR
Información del alumno por sello
Se debe realizar el llamado de https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/436306231#Obtener-Alumno-por-ID pero ahora substituyendo el valor de empresaId por el id del sello y el valor del alumnoId por el id del alumno en cada sello.
En base a la respuesta del servicio para obtener el alumno del sello por su ID, se obtiene la siguiente información.
Login: data.login
Descuentos:
Razón descuento: data.razonDescuento.razonDescuentoId
Porcentaje descuento: data.porcentajeDescuento
Las razones que se muestran en el dropdown se obtienen de la misma forma que en el Registro de Alumno único, substituyendo el valor de empresaId por el id del sello y el valor del alumnoId por el id del alumno en cada sello.
Materiales: data.articulos.programa
Los materiales a mostrar en el dropdown se obtienen de la misma forma que en el Registro de Alumno único, substituyendo el valor de empresaId por el id del sello y el valor del alumnoId por el id del alumno en cada sello.
Aplicativos
Método: GET
Ejemplo:
https://homol.uno-internacional.com/pegasus-api/censo/empresas/8/ciclos/785/colegios/13244/niveles/33/personas/13470350/listaArticulosPersona?rolClave=AL
Información
Aplicativo: data[].articulo
Imagen: data[].imagen.urlMiniatura
Info de pago
POR DEFINIR