You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 10
Next »
Este servicio será consultado por las aplicaciones que necesiten sincronizar datos de usuarios con la BDC con cierta periodicidad.
Descripción | 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 SIF | Extensión de SIF 3.0.1 |
Tipo de Petición | GET |
Parámetros o Campos | 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 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 | http://desenv.uno-internacional.com/sif/unoSchool/deltaContactRelationship;contextId={"school":1135,"schoolYear":2015,"page":0, "timeModified":"2015-01-01 00:00:01", "endTimeModified":"2016-05-03 23:00:01"} |
Respuesta | <contactRelationshipList pageSize="200"> <contactRelationship refId="03157975-0000-1000-0000-000002657856" > persona. <relationshipToLearnerType>Father</relationshipToLearnerType> <unoStudentRefId>00000000-0000-1000-0000-000002657856</unoStudentRefId> alumno.alumno_id (refId asignado para el ciclo escolar) <contactPersonRefId>00000000-0000-1000-0000-000003157975</contactPersonRefId> persona.persona_id (identificador único en la BDC) </contactRelationship> </contactRelationshipList> |
Quienes lo consumen | |
Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.