Versions Compared

Key

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

Status
colourGreen
titleEn Uso

...

DescripciónConsulta los usuarios que han sido creados/modificados en un rango de fecha determinado.
Referencia SIFExtensión de SIF 3.0.1
Tipo de PeticiónGET
Parámetros


CamposDescripciónReglas de negocio
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 escolarCiclo escolar  ( ó Id del 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 50 resultados por página, si la página devuelve menos de 50 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 los usuarios creados y modificados, consultando el valor persona_rol.fecha_actualizacion, persona.fecha_actualizacion y persona_login.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.
active (Opcional) true/false Campo activo de la tabla persona.
  • Según el valor de este parámetro:
    • true: los usuarios con login o roles activos modificados
    • false: los usuarios con login o roles no activos modificados
    • no se especifica: todos los usuarios modificados
sessionId
  • (Opcional) Id del ciclo escolar dónde se desea crear. Ver maestro de Ciclo Escolar
El parámetro se adiciona para aquellas empresas que cuentan con ciclos escolares semestrales.



Lógica de negocio

agregada

  • Se informan los usuarios que han sido modificados segun rango de fechas indicadas, el colegio y ciclo escolar.
  • La respuesta devuelve usuarios de tres roles SIF distintos: students, parentGuardian y Staff. Para los student el primer campo devuelto es <studentRefId>, el resto de datos son iguales.

Ejemplo de llamada

https://homol.uno-internacional.com/sif/unoSchool/deltaUsers;contextId= {"school":1252,"schoolYear":2017, "page":0, "timeModified":"2016-06-01 00:00:01", "endTimeModified":"2016-06-15 23:00:01"}

Ejemplo de respuesta:

<usersList pageSize="50">
<unoUser personRefId ="00000000-0000-1000-0000-000001028615"> Identificador único en la BDC
<name>
<firstName>COLEGIO EL CAMINO</firstName> Nombre
<middleName></middleName> Primer apellido
<lastName></lastName> Segundo apellido
</name>
<birthDate></birthDate> Fecha de nacimiento
<sex>Not selected</sex> Sexo (Male, Female, Not selected)
<userId>C.CAMINO-K</userId> Username
<active>true</active> Estado del login del usuario (true/false)
<phoneNumberList> Listado de teléfonos
<phoneNumber phoneNumberType="Home">
<number>(624) 143 2100</number>
</phoneNumber>
</phoneNumberList>
<schoolEmailList>  Listado de correos electrónicos
<schoolEmail>
<email>alma@colegioelcamino.com, carmenp@colegioelcamino.com, danylu@colegioelcamino.com</email>
</schoolEmail>
<schoolEmail>
<email>----</email>
</schoolEmail>
</schoolEmailList>
<businessList> Listado de empresas a las que pertenece
<business name="MX/UNOI"> Identificador de la empresa, ver maestro de empresas.
<role> Por cada rol se presenta la estructura rol, como en el caso del ejemplo

<role>
<roleDescription>Administrador</roleDescription>Descripción del rol, ver maestro de roles
<roleParam>111</roleParam>Identificador del rol, ver maestro de roles
<roleActive>true</roleActive> Estado del rol del usuario (true/false)
</role>

</business>
</businessList>
</unoUser>

<usersList>

Clientes que lo consumen

...