Versions Compared

Key

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

...


Este servicio será utilizado por las aplicaciones que necesiten actualizar insertar datos de alumnos con la BDC.


Situación actual

DescripciónInserta
uno o varios Alumnos
un Alumno. Insertando tambien en la entidad 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ónPOST


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

Parámetros

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>
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
  • Va en blanco ya que se insertará un nuevo alumno.


studentId
  • Clave del alumno
 


firstName
  • Nombre
  • Obligatorio

 

 



  • En caso de no indicar valor entrega el siguiente mensaje:
<update
  • <creates>
    <create id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-

000004036006
  • 000714176904" >
    <code>400</code>
    <message>Los datos del nombre son

requerido</message><
  • requeridos.</message>
    </error>
    </create>
    </

update>
  • creates>

middleName
  • Apellido paterno
  • Obligatorio
  • En caso de no indicar valor entrega el siguiente mensaje:

    <creates>

<update
  • <create id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-

000004036006
  • 000714176904" >
    <code>400</code>
    <message>Los datos del nombre son

requerido</message><
  • requeridos.</message>
    </error>
    </create>
    </

update>
  • creates>

lastName
  • Apellido materno
  • Obligatorio
  • En caso de no indicar valor entrega el siguiente mensaje:

    <creates>

<update
  • <create id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-

000004036006
  • 000714176904" >
    <code>400</code>
    <message>Los datos del nombre son

requerido</message><
  • requeridos.</message>
    </error>
    </create>
    </

update>
  • creates>

birthDate
  • Fecha de nacimiento
  • Formato: aaaa-mm-dd
  • Obligatorio
  • En caso de no indicar valor entrega el siguiente mensaje:

    <creates>

<update
  • <create id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-

000004036006
  • 001965167148" >
    <code>400</code>
    <message>El formato de la fecha es incorrecto.</

message><
  • message>
    </error>
    </create>
    </

update>
  • creates>

sex
  • Valores: Male, Female, Not selected
 

userId
  • Username
  • Obligatorio
  • En caso de no indicar valor entrega el siguiente mensaje:
    <update
    • Para crear login, debe dar userId y password.

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

    000004036006
    • 001682490178" >
      <code>409</code>

    <message>Ocurrió un error al guardar la información de login
    • <message>Ya existe una persona con el login proporcionado.</message>
      </error>
      </create>
      </

    update>
    • creates>

    • 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
     personRefId
    • Para crear login, debe dar userId y password. 
    • El valor debe ser enviado codificado en base64.
    language
    zona_horaria_id
    • Identificador único en la BDC
    persona.persona
    • zona_horaria.zona_horaria_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
     <unoStudent refId="00000000-0000-1000-0000-000004036006" >  alumno.alumno_id (Identificador único en la BDC)
    <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 (

    email
    • Correo electrónico
     Ejemplo XML Payload

    admissionDate
    • Fecha de Ingreso
    • Formato: 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:

    http://desenv
    • Opcional

    personRoleId
    • Persona Rol Id del usuario que realiza el cambio.
    • Opcional
    • Si el cambio en una entidad se realizó en alguna herramienta administrativa (Acuerdo, Censo, SINCROBDC, etc), el valor almacenado corresponde al usuario con rol administrativo que realizó el cambio (Administrador, Staff, Administrador de Colegio)

    paymentResponsibleId

    • El ID Fiscal del responsable de pago
    • Opcional
    • El atributo se utiliza para asociar a la persona que realizará el pago de los materiales y los alumnos en el portal de pagos de Brasil UNOi/Educate.
    • Deberá contener un número  CPF válido.
    lmsBlocked
    • Indicador para verificar el acceso del alumno al LMS
    • Opcional
    • El atributo es utilizado para verificar si el alumno puede acceder o no al LMS.
    • Es utilizado en Brasil Moderna Compartilha
    • Los valores aceptados son:
      • true = Indica que el alumno no puede acceder al LMS.
      • false = Indica que el alumno puede acceder al LMS


    Ejemplo de llamada o de formulariohttps://homol.uno-internacional.com/sif/unoStudent
    Ejemplo XML Payload


    Code Block
    language
    <unoStudentList>
    xml
    <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>
    ">
        <studentId>newStudent.1</studentId>
        <name>
            <firstName>Alumno</firstName>
            <middleName>Prueba</middleName>
            <lastName>Sif</lastName>
        </name>
        <birthDate>2014-06-06</birthDate>
        <sex>Male</sex>
        <userId>new.student.1</userId>
        <password>bmV3LnN0dWRlbnQuMQ==</password>
        <language>ES</language>
    	<zona_horaria_id>16</zona_horaria_id>
        <addressList>
            <address addressType="Physical">
                <street>
                    <line1>CALLE 8 DE MAYO</line1>
                </street>
                <city>MEXICO</city>
                <neighborhood>PLANETARIO LINDAVISTA</neighborhood>
                <postalCode>07300</postalCode>
                <buildingSiteNumber>2</buildingSiteNumber>
                <county>GUSTAVO A MADERO</county>
                <stateProvince>Distrito Federal</stateProvince>
                <countyRefId>00000000-0000-1000-0000-
    000000011121<
    000000011302</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
    
        </addressList>
        <phoneNumberList>
            <phoneNumber phoneNumberType="Home">
                <number>53956782</number>
            </phoneNumber>
            <phoneNumber phoneNumberType="Mobile">
                <number>5537651829</number>
            </phoneNumber>
        </phoneNumberList>
        <schoolEmailList>
            <schoolEmail>
                <email>new.student.1@correo.com</email>
            </schoolEmail>
        </schoolEmailList>
    	<admissionDate>2019-01-01</admissionDate>
        <personRoleId>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
    000000526589</personRoleId>
    	<paymentResponsibleId>53465435621</paymentResponsibleId>
    	<lmsBlocked>true</lmsBlocked>
    </unoStudent>


    Respuesta


    Code Block
    languagexml
    <createResponse>
    	<creates>
    		<create id="00000000-0000-1000-0000-
    000001696161
    000005786419"

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