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 44 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á utilizado por las aplicaciones que necesiten actualizar datos de alumnos con la BDC.


Situación actual

DescripciónActualiza uno o varios Alumnos. Actualizando también persona, persona_login, persona_domicilio y domicilio.
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 o campos
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>

  • En caso de tener borrado lógico, entrega el siguiente mensaje:

    <error refId="00000000-0000-1000-0000-000850968958">
    <code>409</code>
    <message>Ocurrió un error al guardar la información del alumno.</message>
    </error>

  • La actualización de los datos del alumno solo es permitida para los alumnos de colegios SIS, alumnos de colegios de la empresa Moderna Compartilha o cuando aún no han sido vinculados a un colegio. En caso de cumplirse la regla el servicio devuelve:

    • <code>401</code>
      <message>No está autorizado para ejecutar esta acción.</message>

  • En caso que el usuario que invoca el servicio (generatorId) no tenga permisos en la empresa donde esta relacionado el alumno, devuelve:

    • <code>403</code>
      <message>No tiene permiso para insertar o modificar en la empresa a la que pertenece el alumno.</message>

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 o con borrado lógico, 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>
  • En caso de tener borrado lógico, entrega el siguiente mensaje:

    <error refId="00000000-0000-1000-0000-000850968958">
    <code>409</code>
    <message>Ocurrió un error al guardar la información del alumno.</message>
    </error>

studentId

  • Clave del alumno

 

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
 
userId
  • Username
  • En caso de indicarlo, debe tener 6 o más caracteres.
  • Si el usuario previamente tiene login y no se indica 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>

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

  • Para crear login, debe dar userId y password. 
password
  • Contraseña
  • Para crear login, debe dar userId y password. 
language 
personRefId
  • Identificador único en la BDC persona.persona_id
 
curp
  • Curp
 
addressType
  • Tipo domicilio
  • Valores: Physical, Mailing, Shipping
 
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
 
exitDate
  • Inactiva usuario
  • Valor: <exitDate>2017-05-17</exitDate>
  • Cuando se incluye la etiqueta con fecha válida en el payload se inactiva alumno y persona_rol. (alumno.activo = 0 y persona_rol.activo = 0).
  • Cuando no se incluye la etiqueta en el payload se activa alumno y persona_rol. (alumno.activo = 1 y persona_rol.activo = 1).
Ejemplo de llamada o de formulario

En caso de actualizar solo un Alumno:

https://homol.uno-internacional.com/sif/unoStudent/00000000-0000-1000-0000-000004036006

Ejemplo XML Payload

<unoStudent refId="00000000-0000-1000-0000-000004036006" >  alumno.alumno_id (Identificador único en la BDC, asignado para el ciclo escolar)
<studentId>JMAV</studentId>  Clave del alumno
<name>
<firstName>Joel Maximiliano</firstName>  Nombre
<middleName>Aguilar</middleName> Apellido Paterno
<lastName>Valdez</lastName> Apellido Materrno
</name>
<birthDate>2008-12-04</birthDate> Fecha de nacimiento (aaaa-mm-dd)
<sex>Male</sex> (Male, Female, Not selected)
<userId>joelmaximiliano.aguilar.9</userId> Username
<password>dmFsZXJpYS5w</password> Contraseña
<language>ES</language> Lenguaje
<personRefId>00000000-0000-1000-0000-000003149709</personRefId> persona.persona_id (Identificador único en la BDC)
<curp></curp> Curp
<addressList> Lista de domicilios
<address addressType="Physical"> Tipo domicilio (Physical, Mailing, Shipping)
<street>
<line1>Rosas 101</line1> Calle
</street>
<city>QUINTANA ROO</city> Ciudad
<neighborhood>SM 223 MZA 6 LTE 15..</neighborhood> Colonia
<postalCode>CANCUN</postalCode> Código postal
<buildingSiteNumber>41</buildingSiteNumber> Número
<county>BENITO JUAREZ</county> Municipio
<stateProvince>Quintana Roo</stateProvince> Estado
<countyRefId>00000000-0000-1000-0000-000000015248</countyRefId> municipio.municipio_id (Identificador único en la BDC)
</address>
</addressList>
<phoneNumberList> Lista de teléfonos
<phoneNumber phoneNumberType="Home"> Tipo teléfono (Home, Mobile)
<number>53956782</number> Número de teléfono
</phoneNumber>
<phoneNumber phoneNumberType="Mobile">  Tipo teléfono (Home, Mobile)
<number>5537651829</number> Número de teléfono
</phoneNumber>
</phoneNumberList>
<schoolEmailList> 
<schoolEmail>
<email>correo@correo.com</email> Correo
</schoolEmail>
</schoolEmailList>
</unoStudent>

Respuesta N/A (Código 204).
Ejemplo de llamada o formulario

Puede actualizar varios:

https://homol.uno-internacional.com/sif/unoStudent

Ejemplo XML Payload

<unoStudentList>
<unoStudent refId="00000000-0000-1000-0000-000001696160">
<studentId />
<name>
<firstName>TANIA</firstName>
<middleName>AGUILAR</middleName>
<lastName>RUBIO</lastName>
</name>
<birthDate>2000-03-15</birthDate>
<sex>Female</sex>
<userId>tania.aguilar.sm</userId>
<password>dLgseXdpfS8b</password>
<personRefId>00000000-0000-1000-0000-000001003674</personRefId>
<addressList>
<address addressType="Physical">
<street>
<line1>Calle tres</line1>
</street>
<city />
<neighborhood />
<postalCode />
<buildingSiteNumber>0</buildingSiteNumber>
<county>METEPEC</county>
<stateProvince>Estado de México</stateProvince>
<countyRefId>00000000-0000-1000-0000-000000011121</countyRefId>
</address>
</addressList>
<phoneNumberList />
<schoolEmailList />
</unoStudent>
<unoStudent refId="00000000-0000-1000-0000-000001696161">
<studentId>EICJ000526HMCSSSA6</studentId>
<name>
<firstName>JESÚS</firstName>
<middleName>ESPINOSA DE LOS MONTEROS</middleName>
<lastName>CASTAÑEDA</lastName>
</name>
<birthDate>2000-05-26</birthDate>
<sex>Male</sex>
<userId>jesus.espinosa.sm</userId>
<password>dldjGXdkf8HJhfb</password>
<personRefId>00000000-0000-1000-0000-000001004648</personRefId>
<addressList>
<address addressType="Physical">
<street>
<line1 />
</street>
<city />
<neighborhood />
<postalCode />
<buildingSiteNumber>0</buildingSiteNumber>
<county>METEPEC</county>
<stateProvince>Estado de México</stateProvince>
<countyRefId>00000000-0000-1000-0000-000000011121</countyRefId>
</address>
</addressList>
<phoneNumberList />
<schoolEmailList />
</unoStudent>
<unoStudent refId="00000000-0000-1000-0000-000001696162">
<studentId>EAGB001219MMCSRRA9</studentId>
<name>
<firstName>BRENDA MONSERRAT</firstName>
<middleName>ESTRADA</middleName>
<lastName>GRAJALES</lastName>
</name>
<birthDate>2000-12-19</birthDate>
<sex>Female</sex>
<userId>brenda.estrada.sm</userId>
<password>d9Hnsjf7pdfK</password>
<personRefId>00000000-0000-1000-0000-000001002836</personRefId>
<exitDate>2013-08-23</exitDate>
<addressList>
<address addressType="Physical">
<street>
<line1 />
</street>
<city />
<neighborhood />
<postalCode />
<buildingSiteNumber>0</buildingSiteNumber>
<county>METEPEC</county>
<stateProvince>Estado de México</stateProvince>
<countyRefId>00000000-0000-1000-0000-000000011121</countyRefId>
</address>
</addressList>
<phoneNumberList />
<schoolEmailList />
</unoStudent>
</unoStudentList>

Respuesta

<updateResponse>
<updates>
<update id="00000000-0000-1000-0000-000001696160"
statusCode="200" />
<update id="00000000-0000-1000-0000-000001696161"
statusCode="200" />
<update id="00000000-0000-1000-0000-000001696162"
statusCode="200" />
</updates>
</updateResponse>

  • No labels