Versions Compared

Version Old Version 2 New Version 3
Changes made by

Samara Carmona. CCORP

Samara Carmona. CCORP

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


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

Situación actual

Descripción

Inserta una entidad ContactRelationship

Referencia SIFcontactRelationship (Lista)
Tipo de Petición
GET
POST
Parámetros
o Campos
  • (Obligatorio) UUID del ContactRelationship  que se consulta
    • Esta formado por
    en XML Payload
    CamposDescripciónReglas de negocio
    UUID del ContactRelationship
    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>

    contactPersonRefId
    • Identificador del contacto:  persona.persona_id (identificador único en la BDC)
    del contacto y alumno.alumno_id (refId 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
    del
    • alumno
    y contacto deben
    • debe existir, en caso de no ser válido devuelve: 
    <code>404<

      • <code>400</code>

    <message>No se encontraron datos con los parámetros especificados

      • <message>El identificador propocionado no es válido.</message>

    Ejemplo de llamada o de formulario

    http://desenv.uno-internacional.com/sif/contactRelationship

    /01088856-0000-1000-0000-000001000190Respuesta

    Ejemplo XML payload

    <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 relacion

     Tipo relación. Los posibles valores son: Mother, Father y Other.
    <unoStudentRefId>00000000-0000-1000-0000-

    000001000190</unoStudentRefId>

    000001000190 alumno.alumno_id (refId asignado para el ciclo escolar)
    </unoStudentRefId>
    <contactPersonRefId>00000000-0000-1000-0000-

    000001088856</contactPersonRefId>

    000001089324  persona.persona_id del contacto (identificador único en la BDC)
    </contactPersonRefId>
    </contactRelationship>

    Respuesta

    <createResponse>
    <creates>
    <create id="01089324-0000-1000-0000-000001000190" statusCode="200" />
    </creates>
    </createResponse>

    ¿Quién lo utiliza y cómo?