Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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: GETNombre de aplicativo: data[].articulo

    • Imagen: data[].imagen.urlMiniatura

  • Información de pago

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

...

Información

  • Aplicativo: data[].articulo

  • Imagen: data[].imagen.urlMiniatura

...

Info de pago

  • Status
    colourYellow
    titlePor definir

Actualizar login del alumno por sello / empresa

...

/grados/89/grupos/580/alumnos/26041477/updateLogin

Payload

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

Validaciones

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/censodashboard/empresas/8/ciclos/785/colegios/17388/niveles/33/grados/89/grupos/580/alumnos/26041477/updateLoginvalidarLogin

Payload

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

Validaciones

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

Método: POST

Ejemplo:

...

,
  "personaId": 0,
  "gradoId": 0
}
  • login: el login que se quiere usar

  • personaId: siempre con valor cero

  • gradoId: siempre con valor cero

Actualizar descuento del alumno por sello / empresa

Método: PUT

Ejemplo:

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

Payload

Code Block
{
  "loginrazonDescuentoId": "alfredo.testllamados.9.test"4214,
  "personaIdporcentajeDescuento": 049,
  "gradoIdpadreId": 0
}
  • login: el login que se quiere usar

  • personaId: siempre con valor cero

  • gradoId: siempre con valor cero

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

Code Block
{
  "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:

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

  • 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

Validaciones

Para validar si se debe mostrar o no el dropdown con la lista de profesores que tienen rol de padre de familia:

Se debe obtener la configuración del módulo https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/

...

436306231#Configuraci%C3%B3n-de-

...

Censo-

...

para-

...

editar-

...

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

Validaciones

Para validar si se debe mostrar o no el dropdown con la lista de profesores que tienen rol de padre de familia:

Se debe obtener la configuración del módulo https://project-tools-santillana.atlassian.net/wiki/spaces/CCORP/pages/edit-v2/436306231#Configuraci%C3%B3n-de-Censo-para-editar-alumnos

En la respuesta de ese servicio, en el elemento ´componentes´ está el array ´secciones´, se debe buscar la sección que corresponde a “descuento”

...

Dentro de la sección “descuento” está el elemento ´formulario´ y dentro del objeto ´formulario´ hay una bandera que se llama ´useFn´:

...

  • true: significa que si se debe mostrar la lista de padres de familia

  • false: significa que no es necesario mostrar la lista de padres de familia

Actualizar material del alumno por sello / empresa

alumnos

En la respuesta de ese servicio, en el elemento ´componentes´ está el array ´secciones´, se debe buscar la sección que corresponde a “descuento”

...

Dentro de la sección “descuento” está el elemento ´formulario´ y dentro del objeto ´formulario´ hay una bandera que se llama ´useFn´:

...

  • true: significa que si se debe mostrar la lista de padres de familia

  • false: significa que no es necesario mostrar la lista de padres de familia

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

Code Block
{
  "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/1324017388/niveles/33/grados/8889/grupos/553580/alumnos/2603573126041477/asignarMaterialreleasedAlumno

Payload

Code Block
{
  "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

  • 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#Materiales-contratados devuelve solo un material, no se debe permitir la edición del material

Liberar aplicaciones del alumno por sello / empresa

Método: POST436306231#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/censodashboard/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

...

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

...

...

...

...

...

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

...

Ya que tienen todas las categorías de descuento 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://

...

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.

...

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

Lista de aplicaciones por alumno y sello / empresa

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 de pago por alumno y sello / empresa

Método: GET

Ejemplo:

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

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

...

servicio

...

programa

...

26041410/getAlumnoDocumento