Versions Compared

Version Old Version 23 New Version Current
Changes made by

Samara Carmona. CCORP

Tania Romo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Import Link Fixer

...

Panel
titleEstado

<

Status
colourGreen
titleEn uso
>

Info
titleEn Uso

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



Este servicio será consultado utilizado por las aplicaciones que necesiten sincronizar la lista de consultar, actualizar o insertar familiares de un alumno con la BDC.

Situación actual

DescripciónGET - Consulta al familiar de un alumno por su id. PUT - Actualiza uno o varios familiares de un alumno por su id. POST - Inserta un Familiar de Alumno en la base de datos.
Referencia SIFExtensión de SIF 3.0.1
Entidad BDCPersona
Entidad SIFEntidad parentGuardian (CEDS_Common.xsd)
Tipo de Petición

GET para consultar, PUT para actualizar , y POST para insertar.

Parámetros


Campos en URL
Descripción
Reglas de negocio
UUID del Familiar que se consulta
  • UUID del Familiar que se consulta
  • Obligatorio (en caso de GET o PUT de un solo familiar)
  • El identificador debe existir.
  • En caso de ser un ID de alumno persona 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>


Campos en PayloadDescripciónReglas de negocio
parentGuardian refId
  • Identificador único en la BDC persona.persona_id
  • Obligatorio (En caso de GET y PUT)
  • El identificador debe existir.
  • Para método GET, el identificador debe ser familiar de algun alumno.
  • En caso de ser un ID de alumno persona no válido o con borrado lógico entrega el siguiente mensaje:

  • <code>404</code>
    <message>No existe la entidad con el id especificado.</message>

firstName
  • Nombre
 

middleName
  • Apellido paterno
 

lastName
  • Apellido materno
 
birthDate
  • Fecha de nacimiento
  • Formato: aaaa-mm-dd
  • Obligatorio

  • En caso de no indicar valor entrega el siguiente mensaje:
    <code>400</code>
    <message>El formato de la fecha es incorrecto.</message>

Sexo
  • Valores: Male, Female, Not selected
 

userId
  • username
  • En caso de indicarlo, debe tener 6 o más caracteres.

  • Antes de insertar, valida que no exista otro usuario con el mismo username, entregando mensaje:

    <creates>
    <create id="" statusCode="409" >
    <error id="00000000-0000-1000-0000-001682490178" >
    <code>409</code>
    <message>Ya existe una persona con el login proporcionado.</message>
    </error>
    </create>
    </creates>

  • Si el usuario previamente tiene login y no se indica valor entonces entrega mensaje:
    <code>409</code>
    <message>Ocurrió un error al guardar la información de login.</message>

  • En caso de ser indicado y tener menos de 6 caracteres entrega el siguiente mensaje:

    <code>400</code>
    <message>El userId no es válido. Debe tener 6 o más caracteres.</message>

  • Los campos userId y password deben tener valor para que sea creado el login.
password
  • Contraseña
  • En caso de tener valor el campo userId, debe indicar password para que sea creado el login.
language


zona_horaria_id
  • Identificador único en la BDC
 
  • zona_horaria.zona_horaria_id
  • Obligatorio
  • Valores: ver maestro de zona_horaria.

curp
  • Curp
 

addressType
  • Tipo domicilio
  • Valores: Physical, Mailing, Shipping
 

street line1
  • Calle
 

city
  • Ciudad
 
neighborhood
  • Colonia
 
postalCode
  • Código postal
 
buildingSiteNumber
  • Número
 

county 
stateProvince
  • Estado
 

countyRefId
  • Identificador único en la BDC municipio.municipio_id
  • Obligatorio
  • Valores: ver maestro de municipios.
 

phoneNumberType
  • Tipo
  • Valores: Home, Mobile
 

number
  • Teléfono
 
email
  • Correo electrónico
 


Ejemplo de llamada o de formulario

Para GET y PUT de un solo familar:

httphttps://desenvhomol.uno-internacional.comsifcom/sif/parentGuardian/00000000-0000-1000-0000-000001803089

Para PUT de varios familiares y POST de un familiar:

httphttps://desenvhomol.uno-internacional.com/sif/parentGuardian

<parentGuardianList> (Se agrega esta etiqueta cuando se van a actualizar varios familiares)

<parentGuardian refId="00000000-0000-1000-0000-000001803089"> persona.persona_id (Identificador único en la BDC)
<name>
<firstName>Terezinha</firstName> Nombre
<middleName>Niehues</middleName>  Apellido paterno
<lastName></lastName> Apellido materno
</name>
<birthDate>1999-11-30</birthDate> Fecha de nacimiento
<sex>Female</sex> (Male, Female, Not selected)
<language>ES</language> Idioma

<zona_horaria_id>16</zona_horaria_id> Zona Horaria
<curp></curp> Curp
<addressList>  Listado de domicilios
<address addressType="Physical"> Tipo de dirección (Physical, Mailing, Shipping)
<street>
<line1>CALLE 8 DE MAYO</line1> Calle
</street>
<city>MEXICO</city> Ciudad
<neighborhood>PLANETARIO LINDAVISTA</neighborhood> Colonia
<postalCode>07300</postalCode> Código postal
<buildingSiteNumber>2</buildingSiteNumber> Número
<county>GUSTAVO A MADERO</county> Municipio
<stateProvince>Ciudad de México</stateProvince> Estado
<countyRefId>00000000-0000-1000-0000-000000011302</countyRefId> municipio.municipio_id (Identificador único en la BDC)
</address>
</addressList>
<phoneNumberList>
<phoneNumber phoneNumberType="Home">  Tipo teléfono (Home, Mobile)
<number>53956744</number>  Número de teléfono
</phoneNumber>
<phoneNumber phoneNumberType="Mobile">  Tipo teléfono (Home, Mobile)
<number>5537651855</number>  Número de teléfono
</phoneNumber>
</phoneNumberList>
<schoolEmailList>
<schoolEmail>
<email>terezinhaniehues@gmail.com</email> Correo
</schoolEmail>
</schoolEmailList>
</parentGuardian>

<parentGuardian refId="00000000-0000-1000-0000-000001808888"> persona.persona_id (Identificador único en la BDC)

........

........

</parentGuardian>

</parentGuardianList> (Se agrega esta etiqueta cuando se van a actualizar varios familiares)

Respuesta

PUT:

N/A (Código 204).

Cuando se actualizan varios:

<updateResponse>
<updates>
<update id="00000000-0000-1000-0000-000001342613"
statusCode="200" />
<update id="00000000-0000-1000-0000-000001107025"
statusCode="200" />
<update id="00000000-0000-1000-0000-000001351564"
statusCode="200" />
<update id="00000000-0000-1000-0000-000001063490"
statusCode="200" />
</updates>
</updateResponse>

POST:

<createResponse>
<creates>
<create id="00000000-0000-1000-0000-000002314849"
statusCode="200" />
</creates>
</createResponse>


¿Quién lo utiliza y cómo?