Servicio /sif/unoStudent/contactRelationship

Owned by Samara Carmona. CCORP
Last updated: Nov 23, 2018 by Christian Romo


Estado

<EN USO>

En Uso

Cuando un requisito de sistema software tenga el estado En Uso significa que está disponible para su uso.


Este servicio será consultado por las aplicaciones que necesiten sincronizar la lista de familiares de un alumno con la BDC.

Situación actual

DescripciónConsulta la lista de Familiares de un Alumno
Referencia SIFExtensión de SIF 3.0.1
Entidad SIFExtensión de la entidad contactRelationship (CEDS_K12.xsd)
Tipo de PeticiónGET
Parámetros
Campos
Descripción
Reglas de negocio
UUID del Alumno
  • El identificador debe existir.
  • En caso de ser un ID de alumno no válido o con borrado lógico entrega el siguiente mensaje:

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

keys
  • Indicador de regresar solo llaves de entidades 
  • Opcional (default false).
 
Ejemplo de llamada o de formulario

https://homol.uno-internacional.com/sif/unoStudent/contactRelationship;contextId={"student":1000190, "keys":false}

Respuesta

<contactRelationshipList>
<contactRelationship refId="02023156-0000-1000-0000-000001000190" > persona.persona_id (identificador único en la BDC), alumno.alumno_id (refId asignado para el ciclo escolar)
<relationshipToLearnerType>Father</relationshipToLearnerType> Tipo relación. Los posibles valores son: Mother, Father y Other.
<unoStudentRefId>00000000-0000-1000-0000-000001000190</unoStudentRefId>  alumno.alumno_id (refId asignado para el ciclo escolar)
<contactPersonRefId>00000000-0000-1000-0000-000002023156</contactPersonRefId> persona.persona_id (identificador único en la BDC)
</contactRelationship>
<contactRelationship refId="01088856-0000-1000-0000-000001000190" >persona.persona_id (identificador único en la BDC), alumno.alumno_id (refId asignado para el ciclo escolar)
<relationshipToLearnerType>Mother</relationshipToLearnerType>  Tipo relación. Los posibles valores son: Mother, Father y Other.
<unoStudentRefId>00000000-0000-1000-0000-000001000190</unoStudentRefId> alumno.alumno_id (refId asignado para el ciclo escolar)
<contactPersonRefId>00000000-0000-1000-0000-000001088856</contactPersonRefId> persona.persona_id (identificador único en la BDC)
</contactRelationship>
</contactRelationshipList>

¿Quién lo utiliza y cómo?