Versions Compared

Version Old Version 13 New Version 14
Changes made by

Samara Carmona. CCORP

Samara Carmona. CCORP

Saved on

Key

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

...

Situación actual

DescripciónActualiza un Alumno.
Referencia SIFExtensión de SIF 3.0.1
Entidad BDCAlumno
Entidad SIFExtensión de la entidad k12student (CEDS_K12.xsd).
Tipo de PeticiónPut
Parámetros
Campos
Descripción
Reglas de negocio
UUID del Alumno
  • UUID del Alumno que se consulta
  • Obligatorio
  • El identificador debe existir.
  • En caso de ser un ID de alumno no válido entrega el siguiente mensaje:

    <error refId="00000000-0000-1000-0000-000179262049">
    <code>404</code>
    <message>No se encontraron datos con los parámetros especificados.</message>
    </error>

Ejemplo de llamada o de formulario

http://desenv.uno-internacional.com/sif/unoStudent/00000000-0000-1000-0000-000001003549

Parámetros en XML payload
  • Valida payload. En caso de no ser correcto manda mensaje de error.
CampoDescripciónReglas de Negocio
unoStudent refId
  • Identificador único en la BDC alumno.alumno_id
  • Obligatorio

En caso de ser un ID de alumno no válido entrega el siguiente mensaje:

  • <error refId="00000000-0000-1000-0000-001373134177">
    <code>404</code>
    <message>No existe la entidad con el id especificado.</message>
    </error>
studentId
  • Clave del alumno
  • Opcional

 

firstName
  • Nombre
  • Obligatorio

 

 

  • En caso de no indicar valor entrega el siguiente mensaje:
    <update id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-000004036006" >
    <code>400</code>
    <message>Los datos del nombre son requerido</message></error>
    </update>
middleName
  • Apellido paterno
  • Obligatorio
  • En caso de no indicar valor entrega el siguiente mensaje:
    <update id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-000004036006" >
    <code>400</code>
    <message>Los datos del nombre son requerido</message></error>
    </update>
lastName
  • Apellido materno
  • Obligatorio
  • En caso de no indicar valor entrega el siguiente mensaje:
    <update id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-000004036006" >
    <code>400</code>
    <message>Los datos del nombre son requerido</message></error>
    </update>
birthDate
  • Fecha de nacimiento
  • Formato: aaaa/mm/dd
  • Obligatorio
  • En caso de no indicar valor entrega el siguiente mensaje:
    <update id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-000004036006" >
    <code>400</code>
    <message>El formato de la fecha es incorrecto.</message></error>
    </update>
sex
  • Valores: Male, Female, Not selected
  • Opcional
 
userId
  • Obligatorio
  • En caso de no indicar valor entrega el siguiente mensaje:
    <update id="" statusCode="409" >
    <error id="00000000-0000-1000-0000-000004036006" > <code>409</code>
    <message>Ocurrió un error al guardar la información de login.</message>
    </error>
    </update>
password
  • Contraseña
  • Opcional
 
personRefId
  • Identificador único en la BDC persona.persona_id
  • Opcional
 
curp
  • Opcional
 
addressType
  • Tipo de dirección
  • Physical, Mailing, Shipping
 
line1
  • Calle
 
city
  • Ciudad
 
neighborhood
  • Colonia
 
postalCode
  • Código postal
 
buildingSiteNumber
  • Número
 
county
  • Municipio
 
stateProvince
  • Estado
 
countyRefId
  • Identificador único en la BDC municipio.municipio_id

 
phoneNumberType  
number  
email  
   
Ejemplo XML Payload

<unoStudent refId="00000000-0000-1000-0000-000001003549"> Identificador único en la BDC alumno.alumno_id
<studentId>ADP4A.14</studentId> Clave del Alumno
<name>
<firstName>VALERIA MICHELLE</firstName> Nombre
<middleName>PIÑEIRO</middleName> Apellido paterno
<lastName>ARENAS</lastName> Apellido materno
</name>
<birthDate>2012-12-11</birthDate> Fecha de nacimiento (aaaa/mm/dd)
<sex>Female</sex> (Male, Female, Not selected)
<userId>valeria.pineiro</userId> username
<password>dmFsZXJpYS5w</password> contraseña
<personRefId>00000000-0000-1000-0000-000001003674</personRefId> Identificador único en la BDC persona.persona_id
<curp>PIAV020218MDFXRLB2</curp> CURP
<addressList> Lista 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>Distrito Federal</stateProvince> Estado
<countyRefId>00000000-0000-1000-0000-000000011302</countyRefId>  Identificador único en la BDC municipio.municipio_id
</address>
<address addressType="Mailing">Tipo de dirección (Physical, Mailing, Shipping)
<street>
<line1>CALLE 10 DE ABRIL</line1> Calle
</street>
<city>IRAPUATO</city> Ciudad
<neighborhood>TABACHINES</neighborhood> Colonia
<postalCode>07500</postalCode>  Código Postal
<buildingSiteNumber>22</buildingSiteNumber> Número
<county>IRAPUATO</county> Municipio
<stateProvince>Guanajuato</stateProvince> Estado
<countyRefId>00000000-0000-1000-0000-000000008126</countyRefId>  Identificador único en la BDC municipio.municipio_id
</address>
</addressList>
<phoneNumberList>
<phoneNumber phoneNumberType="Home">
<number>53956782</number>
</phoneNumber>
<phoneNumber phoneNumberType="Mobile">
<number>5537651829</number>
</phoneNumber>
</phoneNumberList>
<schoolEmailList>
<schoolEmail>
<email>correo@correo.com</email>
</schoolEmail>
</schoolEmailList>
</unoStudent>

Respuesta

<unoStudent refId="00000000-0000-1000-0000-000001003549" > Identificador único en la BDC
<studentId>ADP4A.14</studentId> Clave del alumno
<name>
<firstName>VALERIA MICHELLE</firstName> Nombre
<middleName>PIÑEIRO</middleName> Primer apellido
<lastName>ARENAS</lastName> Segundo apellido
</name>
<birthDate>2002-02-18</birthDate> Fecha de nacimiento
<sex>Female</sex> (Male, Female, Not selected)
<userId>valeria.pineiro</userId> Username
<language>ES</language> Idioma
<personRefId>00000000-0000-1000-0000-000001003674</personRefId>  persona.persona_id (Identificador único en la BDC)
<curp>PIAV020218MDFXRLB2</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>3</buildingSiteNumber> Número
<county>GUSTAVO A. MADERO</county> Municipio
<stateProvince>Distrito Federal</stateProvince> Estado
<countyRefId>00000000-0000-1000-0000-000000011292</countyRefId> Identificador único en la BDC
</address>
</addressList>
<phoneNumberList></phoneNumberList> Listado de teléfonos
<schoolEmailList></schoolEmailList> Listado de correos electrónicos
</unoStudent>

¿Quién lo utiliza y cómo?