/
Servicio /sif/unoSchool/contactRelationship

Servicio /sif/unoSchool/contactRelationship

Jun 07, 2019
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 las entidades ContactRelationship para un Colegio en un Ciclo en específico con la BDC.

Situación actual

Descripción

Consulta las entidades ContactRelationship de los alumnos de un Colegio en un ciclo específico. Opcionalmente se puede filtrar por nivel, grado y grupo. No se enlistan entidades con borrado lógico.

Referencia SIF

contactRelationship (Lista)

Tipo de Petición

GET

Parámetros o Campos

Campos

Descripción

Reglas de negocio

school

  • (Obligatorio) Id del Colegio correspondiente.

  • Los valores se puede consultar 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

  • El colegio debe existir en el año escolar, en caso de no ser válido devuelve:

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

  • Si no se especifica el parámetro, como es obligatorio devuelve:

    •  <code>400</code>
      <message>Debe especificar un ciclo para consultar.</message>

level

  • El nivel debe existir para el colegio, en caso de no ser válido devuelve

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

grade

  • (Opcional) Id del grado que se consulta.



group

  • (Opcional) Id del grupo que se consulta. Ver maestro de Grupos.



keys

  • (Opcional) Indicador de regresar solo llaves de entidades.

  • Valores: true, false.

  • Default: false.



 

 

Ejemplo de llamada o de formulario

https://homol.uno-internacional.com/sif/unoSchool/contactRelationship;contextId={"school":1135, "schoolYear":2017, "level":18, "grade":25, "group":17, "keys":false}

Respuesta

<contactRelationshipList>
<contactRelationship refId="01141968-0000-1000-0000-000005221937" >  persona.persona_id (identificador único en la BDC), alumno.alumno_id (refId asignado para el ciclo escolar)
<relationshipToLearnerType>Mother</relationshipToLearnerType>tipo relacion. Los posibles valores son: Mother, Father y Other.
<unoStudentRefId>00000000-0000-1000-0000-000005221937</unoStudentRefId>  alumno.alumno_id (refId asignado para el ciclo escolar)
<contactPersonRefId>00000000-0000-1000-0000-000001141968</contactPersonRefId> persona.persona_id (identificador único en la BDC)
</contactRelationship>
<contactRelationship refId="03164591-0000-1000-0000-000005221943" >
<relationshipToLearnerType>Father</relationshipToLearnerType>
<unoStudentRefId>00000000-0000-1000-0000-000005221943</unoStudentRefId>
<contactPersonRefId>00000000-0000-1000-0000-000003164591</contactPersonRefId>
</contactRelationship>
<contactRelationship refId="03143861-0000-1000-0000-000005221944" >

......

</contactRelationship>
<resumen> Resumen
<niveles>
<nivel>
<nivel_id>18</nivel_id> nivel.nivel_id
<colegio_nivel_ciclo_id>32132</colegio_nivel_ciclo_id> colegio_nivel_ciclo_id (Identificador único en la BDC asignado para el colegio y nivel por ciclo escolar)
<grados>
<grado>
<grado_id>26</grado_id> grado.grado_id
<total>31</total> Total contactos
</grado>
<grado>
<grado_id>26</grado_id>
<total>25</total>
</grado>
<grado>
<grado_id>27</grado_id>
<total>24</total>
</grado>
<grado>
<grado_id>27</grado_id>
<total>27</total>
</grado>
<grado>
<grado_id>25</grado_id>
<total>19</total>
</grado>
<grado>
<grado_id>25</grado_id>
<total>30</total>
</grado>
<grado>
<grado_id>25</grado_id>
<total>0</total>
</grado>
</grados>
</nivel>
</niveles>
</resumen>
</contactRelationshipList>

¿Quién lo utiliza y cómo?