Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

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 al familiar de un alumno por su id. Actualiza uno o varios familiares de un alumno por su id. 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 no válido 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.

  • En caso de ser un ID de alumno no válido 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
 
language 
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:

http://desenv.uno-internacional.comsif/parentGuardian/00000000-0000-1000-0000-000001803089

Para PUT de varios familiares y POST de un familiar:

http://desenv.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
<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>

¿Quién lo utiliza y cómo?

 


 

  • No labels