Page Comparison

...

Configuración de Censo por colegio y ciclo escolar

Método: GET

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/dashboard/empresas/8/config?cicloEscolarId=785&colegioId=13244

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.

...

Contiene la configuración a usar en el módulo de editar un alumno, desde las secciones a mostrar hasta las validaciones a realizar, además de los permisos en este módulo

Método: GET

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/dashboard/empresas/8/ciclos/785/moduleConfig/CENSO.ALUMNO.EDITAR?colegioId=17388

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": ""
}

...

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.

...

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"
}

...

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.

...

Obtener alumnos vinculados a cada sello/empresa

Método: GET

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/censo/empresas/76/ciclos/1188/colegios/17919/niveles/33/grados/88/grupos/2280/alumnos/26041434/alumnoUnificados

Instrucciones:

En la respuesta de este servicio, en el campo ´data´ se encuentra un array donde cada elemento del array contiene los datos del alumno correspondientes a cada sello, a partir de este momento, estos son los datos que se deben utilizar para las distintas acciones en la sección de Perfil de alumno - Gestión de Sellos:

...

Actualizar login del alumno por sello / empresa

Método: PUT

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/censo/empresas/8/ciclos/785/colegios/17388/niveles/33/grados/89/grupos/580/alumnos/26041477/updateLogin

Payload

{
  "login": "alfredo.testllamados.9.test"
}

...

Antes de actualizar el login, se debe validar el login informado en el formulario con el siguiente servicio

Método: POST

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/dashboard/empresas/8/validarLogin

Payload

{
  "login": "alfredo.testllamados.9.test",
  "personaId": 0,
  "gradoId": 0
}

...

Actualizar descuento del alumno por sello / empresa

Método: PUT

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/censo/empresas/8/ciclos/785/colegios/17388/niveles/33/grados/89/grupos/580/alumnos/26041477/descuento

Payload

{
  "razonDescuentoId": 4214,
  "porcentajeDescuento": 49,
  "padreId": 0
}

• razonDescuentoId: Id de la razón de descuento seleccionada en el dropdown

  • El listado de razones de descuento que se debe mostrar, se obtiene de la siguiente forma: https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/436306231#Razones-de-descuento-filtradas-por-configuraci%C3%B3n

• porcentajeDescuento: Valor del porcentaje de pago asignado

• padreId:

  • 0: Si la configuración para mostrar la lista de profesores está inactiva

  • padreId: Si la configuración para mostrar la lista de profesores está inactiva, se envía el personaId del padre seleccionado en el dropdown correspondiente

...

Actualizar material del alumno por sello / empresa

Método: POST

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/censo/empresas/8/ciclos/785/colegios/13240/niveles/33/grados/88/grupos/553/alumnos/26035731/asignarMaterial

Payload

{
  "tipo": "programa",
  "articulos": [
    106102
  ]
}

• tipo: dependiendo el tipo de material que se quiere asignar puede ser

  • programa

  • servicio

  • digital

• articulos: es un array que contiene el id del material seleccionado

Validaciones

Si el servicio https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/436306231#Materiales-contratados devuelve solo un material, no se debe permitir la edición del material

Liberar aplicaciones del alumno por sello / empresa

Método: POST

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/censo/empresas/8/ciclos/785/colegios/17388/niveles/33/grados/89/grupos/580/alumnos/26041477/releasedAlumno

Payload

• se envía un body vacío en el request

Catálogos

Razones de descuento

Para obtener las razones de descuento a mostrar en el dropdown, primero se debe obtener la lista de todas las razones de descuento disponibles en una empresa

Categorías de descuento disponibles en la configuración

Se debe obtener la https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/436306231#Configuraci%C3%B3n-de-Censo-por-colegio-y-ciclo-escolar en el elemento ´settings´ se encuentra el elemento ´categoriasDescuentos´

...

Lista de razones de descuento

Método: GET

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/dashboard/empresas/8/razones?parametroTrans=DCTO&parametro%5B%5D=FFS&parametro%5B%5D=AMB2&parametro%5B%5D=DEC&parametro%5B%5D=AVCA&parametro%5B%5D=ALIN&parametro%5B%5D=ALRE&parametro%5B%5D=DMU&parametro%5B%5D=DALN&parametro%5B%5D=DSA&parametro%5B%5D=DAMA&parametro%5B%5D=DECO&parametro%5B%5D=HP&parametro%5B%5D=DEDC

Parametros en la URL

• parametroTrans: DCTO - indica que se van a obtener las razones de descuento

• parametro: Es un array donde se indican todas las categorías de descuento que se quieren obtener, estas categorías se obtienen de la configuración https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/436306231#Razones-de-descuento-disponibles-en-la-configuraci%C3%B3n

Razones de descuento filtradas por configuración

Ya que tienen todas las categorías de descuento https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/436306231#Lista-de-razones-de-descuento, en el dropdown solo se deben mostrar las razones de descuento indicadas en la configuración de censo https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/436306231#Configuraci%C3%B3n-de-Censo-por-colegio-y-ciclo-escolar.

Dentro de la configuración del elemento ‘settings’ está el objeto “descuentos”, en este objeto se encuentra el array ´descuentosDisponibles´ que contiene los id’s de las razones de descuento que se deben mostrar en el dropdown de la asignación de descuentos.

Materiales contratados

Método: GET

Ejemplo:

https://homol.uno-internacional.com/pegasus-api/censo/empresas/8/ciclos/785/colegios/17388/niveles/33/grados/89/grupos/580/materialContratado

El servicio devuelve los tipos de material y los materiales por cada tipo, los tipos de material pueden ser:

• servicio

• programa

• digital