Versions Compared

Key

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

...


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


Situación actual

DescripciónInserta 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 en XML payload
  • Valida payload. En caso de no ser correcto manda mensaje de error.
CampoDescripciónReglas de Negocio
unoStudent refId
  • 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:

    <creates>
    <create id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-000714176904" >
    <code>400</code>
    <message>Los datos del nombre son requeridos.</message>
    </error>
    </create>
    </creates>

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

    <creates>
    <create id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-000714176904" >
    <code>400</code>
    <message>Los datos del nombre son requeridos.</message>
    </error>
    </create>
    </creates>

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

    <creates>
    <create id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-000714176904" >
    <code>400</code>
    <message>Los datos del nombre son requeridos.</message>
    </error>
    </create>
    </creates>

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

    <creates>
    <create id="" statusCode="400" >
    <error id="00000000-0000-1000-0000-001965167148" >
    <code>400</code>
    <message>El formato de la fecha es incorrecto.</message>
    </error>
    </create>
    </creates>

sex
  • Valores: Male, Female, Not selected

userId
  • Username
  • 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-001682490178" >
    <code>409</code>
    <message>Ya existe una persona con el login proporcionado.</message>
    </error>
    </create>
    </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
  • 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 zona_horaria.zona_horaria_id
  • Obligatorio
  • Valores: ver maestro de zona_horaria.

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

admissionDate
  • Fecha de Ingreso
  • Formato: aaaa-mm-dd
  • 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
languagexml
<unoStudent refId="">
    <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-000000011302</countyRefId>
        </address>
    </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-000000526589</personRoleId>
	<paymentResponsibleId>53465435621</paymentResponsibleId>
	<lmsBlocked>true</lmsBlocked>
</unoStudent>


Respuesta

<createResponse>
<creates>
<create id="00000000-0000-1000-0000-000005786419"
statusCode="200" />
</creates>
</createResponse>