Status |
---|
colour | RedGreen |
---|
title | En fase de análisis - desarrolloUso |
---|
|
Info |
---|
title | En fase de análisis - desarrolloUso |
---|
|
Cuando un requisito de sistema software tenga el estado En fase de análisis - desarrollo Uso significa que aún no está disponible para su uso. |
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 |
|
(Falta por documentar este servicio)El identificador del colegio (Falta por documentar) | - 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 ( ó 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
|
|
desde esta fecha, teniendo en cuenta (Falta por documentar)- , 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.
|
|
El rango de fecha no debe ser mayor al período transcurrido desde que se activó el ciclo actual.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 |
El listado de usuarios solo debe ser para el ciclo activo- 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 |
httpdesenvXXXXschoolYear":2017, "page":0, "timeModified":" |
20150721T00.000+000020150727T00.000+0000;active=true}} |
Ejemplo de respuesta: | <usersList pageSize="50"> |
<unoUser personRefId ="00000000-0000-1000-0000- |
000003781040 <name> <firstName>ANTONIO RAY</firstName> <middleName/> <lastName>SILVA</lastName> </name> <birthDate>1992-07-09</birthDate> <sex>Male</sex> <userId>rayprogramadorweb1122@gmail.com</userId> <hash>*FA3B8DEC8442EC9F73136320C84DF83B09B97BEB</hash> <active>true</active> <addressList> <address addressType="Physical"> <street> <line1/> </street> <city>Brasilia</city> <neighborhood/> <postalCode/> <buildingSiteNumber/> <county>BRASILIA</county> <stateProvince>DISTRITO FEDERAL</stateProvince> <countyRefId>00000000 <studentRefId>00000000-0000-1000-0000-000005261516</studentRefId> <name> <firstName>JORGE</firstName> Nombre <middleName>CAÑAS</middleName> Primer apellido <lastName>IÑIGUEZ</lastName> Segundo apellido </name> <birthDate></birthDate> Fecha de nacimiento <sex>Male</sex> Sexo (Male, Female, Not selected) <userId>jorge.canas.5</userId> Username <active>true</active> Estado del login del usuario (true/false) <creationInMillis>0</creationInMillis> En preproducción <updateChildrenInMillis>0</updateChildrenInMillis> En preproducción <createPersonLoginId>0</createPersonLoginId> En preproducción <updatePersonLoginId>102737</updatePersonLoginId> En preproducción <personDetailsId>2573810</personDetailsId> En preproducción <countryId>165</countryId> En preproducción <passwordChanged>0</passwordChanged> En preproducción <datePasswordUpdated></datePasswordUpdated> En preproducción <buildingSiteInside></buildingSiteInside> En preproducción <phoneNumberList></phoneNumberList> Listado de teléfonos <schoolEmailList></schoolEmailList> Listado de correos electrónicos <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 <roleDescription>Alumno</roleDescription> Descripción del rol, ver maestro de roles <roleParam>001</roleParam> Identificador del rol, ver maestro de roles <roleActive>true</roleActive> Estado del rol del usuario (true/false) <tenantId>379</tenantId> En preproducción <numberList>0</numberList> En preproducción <noPayment>0</noPayment> En preproducción <noDeliver>0</noDeliver> En preproducción <showBallot>1</showBallot> En preproducción </role> <empresaRefId>00000000-0000-1000-0000- |
000000017389<countyRefId>empresaRefId> En preproducción </ |
address>addressList> <phoneNumberList/> <schoolEmailList> <schoolEmail> <email>lionefv@hotmail.com</email> </schoolEmail> <schoolEmail> <email>lionefv@ </unoUser> <unoUser personRefId ="00000000-0000-1000-0000-000004793999"> <name> <firstName>Virginia Angela</firstName> <middleName>Cobo-Losey</middleName> <lastName>Treviño</lastName> </name> <birthDate></birthDate> <sex>Not selected</sex> <userId>virginia_cobo@hotmail.com</userId> <active>true</active> <creationInMillis>0</creationInMillis> <updateChildrenInMillis>0</updateChildrenInMillis> <createPersonLoginId>0</createPersonLoginId> <updatePersonLoginId>0</updatePersonLoginId> <personDetailsId></personDetailsId> <countryId>165</countryId> <passwordChanged>0</passwordChanged> <datePasswordUpdated></datePasswordUpdated> <buildingSiteInside>56</buildingSiteInside> <phoneNumberList></phoneNumberList> <schoolEmailList> <schoolEmail> <email>virginia_cobo@hotmail.com</email> </schoolEmail> </schoolEmailList> <businessList> <business name=" |
BRCOMP <role> <roleDescription>Profesor</roleDescription> <roleParam>003</roleParam> </role> </business> </businessList></unoUsert>...
<role> <roleDescription>Familiar</roleDescription> <roleParam>002</roleParam> <roleActive>true</roleActive> <tenantId>378</tenantId> </role> <empresaRefId>00000000-0000-1000-0000-000000000001</empresaRefId> </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 |
---|
|
|
...