...
Este servicio será consultado por las aplicaciones que necesiten sincronizar datos de usuarios con la BDC con cierta periodicidad.
Situación actual
| Descripción | Consulta los usuarios que han sido creados/modificados en un rango de fecha determinado. |
| Referencia SIF | Extensión de SIF 3.0.1 |
| Tipo de Petición | GET |
| Parámetros | | Campos | Descripción | Reglas 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:
- 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 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
|
|
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 | http://santillanar4.com/sif/unoSchool/deltaUsers;contextId= {"school":1252,"schoolYear":2016, "page":0, "timeModified":"2016-06-01 00:00:01", "endTimeModified":"2016-06-15 23:00:01", "active":"true"} |
| 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 | |
Tareas realacionadas
| Panel |
|---|
|
| Jira Legacy |
|---|
| server | jiraSystem Jira |
|---|
| serverId | c4591e77487df0e8-9027a840-38bb3c8c-9f88bc14-3c0c61c1557a813b0587c34e |
|---|
| key | SSB-561 |
|---|
|
|