Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleEstado
Status
colourGreen
titlelISTO PARA PASE A pro

 

Note
titlePetición de cambio
  • Cuando un requisito de sistema software tenga el estado LISTO PARA PASAR A PRO, significa que aun no esta disponible para su uso.

 

 

...

titleImpacto
  •  

...

titlePetición de cambio

...

Este servicio será consultado por las aplicaciones que necesiten sincronizar datos de usuarios con la BDC con cierta periodicidad.

Situación actual

Descripción<Se describe el uso que se le da al requisito de sistema software. >Referencia SIF<Si es un webservice, se especifica la referencia SIF>Entrega listado de personas de tipo FAMILIAR modificadas o creadas en un rango de fechas determinados y vinculadas a un colegio y ciclo escolar.
Referencia SIFExtensión de SIF 3.0.1
Tipo de Petición<Si es un webservice, se especifica el tipo de petición: GET, POST, PUT>
Parámetros o Campos<Se especifican los campos del formulario o parámetros del servicio con las reglas de negocio que se aplican>
  • <Se describen todas las reglas de negocio aplicadas al campo o parámetro>
  • Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a libero placerat, commodo risus vel, gravida lectus. Vestibulum purus nunc, commodo at metus in, commodo suscipit magna. Aliquam felis odio, iaculis ut eros eget, lacinia blandit massa. Nam tempor augue nisl, quis volutpat lorem varius a. Phasellus quam nisl, sagittis et commodo in, aliquam non massa
    CamposDescripciónReglas de negocio<nombre del campo>
    • <Posibles valores>
    • <Obligatorio / No obligatorio>
    school(Obligatorio) Identificador del colegio a consultar. Los valores de este campo se consultan con el servicio /sif/unoSchool/schools
      • El identificador del colegio debe existir, en caso de no ser válido devuelve:
        •  

          <code>404</code>
          <message>No se encontraron datos con los parámetros especificados.</message>

      • Si no ese especifica el parámetro, como es obligatorio devuelve:
        •  <code>400</code>
          <message>Debe especificar el identificador del colegio.</message>
    schoolYear(Obligatorio) Ciclo escolar
    • Se devuelven datos del ciclo escolar especificado. En caso de no encontrar datos regresa:
      <error><code>404</code><message>No se encontraron datos con los parametros especificados.</message></error>
    page(Obligatorio) La página de resultados a consultar, valor inicial 0
    • Se devuelven como máximo 200 resultados por página, si la página devuelve menos de 200 resultados, significa que ha llegado a su fin.
    timeModified(Obligatorio) Fecha UTC desde la cuál se solicitan las creaciones/actualizaciones de usuarios
    • Se consultan las personas tipo FAMILIAR creadas y modificadas, consultando el valor persona_rol.fecha_actualizacion (se actualiza la fecha con cualquier campo modificado del registro)
    • En caso de no encontrar datos regresa:
      <error><code>404</code><message>No se encontraron datos con los parametros especificados.</message></error>
    endTimeModified(Obligatorio) Fecha UTC hasta la cuál se solicitan las creaciones/actualizaciones de usuarios
    • Se consultan los usuarios creados y modificados hasta esta fecha, teniendo en cuenta las mismas reglas de negocio de timeModified.

     

     

    Ejemplo de llamada o de formulario

    <ejemplo de llamada o diseño del formulario>

    Respuesta

    <ejemplo de respuesta o descripción del resultado>

    ¿Quién lo utiliza y cómo?

    <qué aplicación utiliza el requisito de sistema software o el webservice, cómo lo utiliza>

    ...