Estado

En Uso

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

Este servicio será utilizado por las aplicaciones que necesiten insertar entidades ContactRelationship en la BDC.

Situación actual

Descripción

Inserta una entidad ContactRelationship. Valida que el unoStudentRefId y contactPersonRefId no tengan borrado lógico.

Referencia SIF

contactRelationship (Lista)

Tipo de Petición

POST

Parámetros en XML Payload

Campos

Descripción

Reglas de negocio

relationshipToLearnerType

Tipo de relación: Mother, Father y Other.
Obligatorio

Sino se especifica el parámetro, como es obligatorio devuelve:
- <code>400</code>
  <message>El xml del payload no se encuentra bien formado.</message>

unoStudentRefId

Identificador del alumno: alumno.alumno_id (Identificador único en la BDC, asignado para el ciclo escolar)
Obligatorio

Sino se especifica el parámetro, como es obligatorio devuelve:

- <code>400</code>
  <message>El xml del payload no se encuentra bien formado.</message>
El identificador del alumno debe existir, en caso de no ser válido devuelve:
- <code>400</code>
  <message>El identificador propocionado no es válido.</message>
En caso de que el alumno tenga borrado lógico, devuelve:
- <code>409</code>
  <message>Ocurrió un error al guardar la información del alumno.</message>
En caso que el usuario que invoca el servicio (generatorId) no tenga permisos en la empresa donde esta relacionado el alumno_id, devuelve:
- <code>403</code>
  <message>No tiene permiso para insertar o modificar en la empresa a la que pertenece el alumno.</message>

contactPersonRefId

Identificador del contacto: persona.persona_id (identificador único en la BDC)
Obligatorio

Sino se especifica el parámetro, como es obligatorio devuelve:

- <code>400</code>
  <message>El xml del payload no se encuentra bien formado.</message>
El identificador del alumno debe existir, en caso de no ser válido devuelve:
- <code>400</code>
  <message>El identificador propocionado no es válido.</message>
En caso que el usuario que invoca el servicio (generatorId) no tenga permisos en la empresa donde esta relacionado el familiar, devuelve:
- <code>403</code>
  <message>No tiene permiso para insertar o modificar en la empresa a la que pertenece el familiar.</message>

Ejemplo de llamada o de formulario

https://homol.uno-internacional.com/sif/contactRelationship

Ejemplo XML payload

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

Respuesta

¿Quién lo utiliza y cómo?

Browser not supported