Versions Compared

Version Old Version 4 New Version 5
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 consultar , o actualizar o insertar colegios con la BDC.

Situación actual

DescripciónConsulta
al familiar de un alumno por su id. Actualiza uno o varios familiares de un alumno
o Actualiza un Colegio por su id.
Inserta un Familiar de Alumno en la base de datos.
Referencia SIFExtensión de SIF 3.0.1
Entidad BDC
Persona
Colegio
Entidad SIF
Entidad parentGuardian
Extensión de la entidad k12school (CEDS_
Common
K12.xsd).
Tipo de Petición

GET para consultar

,

y PUT para actualizar

y POST para insertar.

Parámetros
Campos en URL
Descripción
Reglas de negocio
UUID del
Familiar
Colegio que se
consulta
consulta 
  • UUID del
Familiar
  • Colegio que se
consulta
  • consulta 
  • Obligatorio
(en caso de GET o PUT de un solo familiar)
  • El identificador debe existir.
  • En caso de ser un ID de
alumno lastName
  • Apellido materno
 
  • colegio 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
 <parentGuardian
unoSchool refId
  • UUID del Colegio que se consulta 
  • Obligatorio

 

schoolIdSystem
  • Clave del colegio
 
name
  • Descripción
 
country
  • País
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)

<unoSchool refId="00000000-0000-1000-0000-

000001803089

000000001135" >

persona

colegio.

persona

colegio_id (

Identificador

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

<schoolIdSystem>IEDIS</schoolIdSystem> Colegio clave
<name>IEDIS PRIMARIA METEPEC</name> Descripción
<country>MX</country>
<addressList>
<address addressType="Physical">

Tipo de dirección (Physical, Mailing, Shipping)


<street>

<line1>CALLE 8 DE MAYO<

<line1>MARIANO MATAMOROS</line1>

Calle


</street>

<city>MEXICO<

<city>METEPEC</city>

Ciudad
<neighborhood>PLANETARIO LINDAVISTA<


<neighborhood>BARRIO DE SAN MATEO</neighborhood>

Colonia


<postalCode>07300<

<postalCode>52149</postalCode>

Código postal


<buildingSiteNumber>2<

<buildingSiteNumber>1201 </buildingSiteNumber>

Número


<county>GUSTAVO A MADERO<

<county>METEPEC</county>

Municipio


<stateProvince>Ciudad

<stateProvince>Estado de México</stateProvince>

Estado


<countyRefId>00000000-0000-1000-0000-

000000011302<

000000011121</countyRefId>

municipio.municipio_id (Identificador único en la BDC)


</address>

</addressList>
<phoneNumberList>
<phoneNumber phoneNumberType

<address addressType="

Home

Mailing">

 Tipo teléfono (Home, Mobile)
<number>53956744</number>  Número de teléfono


<street>
<line1>AV. JUAREZ</line1>
</

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

street>
<city>TOLUCA</city>
<neighborhood>SAN MATEO OXTOTITLAN</neighborhood>
<postalCode>50100</postalCode>
<buildingSiteNumber>207</buildingSiteNumber>
<county>TOLUCA</county>
<stateProvince>Estado de México</stateProvince>
<countyRefId>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

000000011235</countyRefId>
</address>
<address addressType="Shipping">
<street>
<line1>MARIANO MATAMOROS</line1>
</street>
<city>METEPEC</city>
<neighborhood>BARRIO DE SAN MATEO</neighborhood>
<postalCode>52149</postalCode>
<buildingSiteNumber>1201 </buildingSiteNumber>
<county>METEPEC</county>
<stateProvince>Estado de México</stateProvince>
<countyRefId>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>

000000011121</countyRefId>
</address>
</addressList>
<phoneNumberList>
<phoneNumber phoneNumberType="Main">
<number>(722)319-0286 (722)318-4843 (722) 271-3148</number>
</phoneNumber>
<phoneNumber phoneNumberType="Administrative">
<number>(044) (722) 408 89 64</number>
</phoneNumber>
</phoneNumberList>
<schoolEmailList>
<schoolEmail>
<email>contabilidad@casitaiedis.edu.mx</email>
</schoolEmail>
</schoolEmailList>
</unoSchool>

Respuesta

 

¿Quién lo utiliza y cómo?