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

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)
Ejemplo de llamada o de formulariohttps://homol.uno-internacional.com/sif/unoStudent
Ejemplo XML Payload


<unoStudent refId="">
<studentId>newStudent.1</studentId> Clave del alumno
<name>
<firstName>Alumno</firstName> Nombre
<middleName>Prueba</middleName> Apellido Paterno
<lastName>Sif</lastName> Apellido Materrno
</name>
<birthDate>2014-06-06</birthDate>  Fecha de nacimiento (aaaa-mm-dd)
<sex>Male</sex> Male, Female, Not selected)
<userId>new.student.1</userId> Username
<password>bmV3LnN0dWRlbnQuMQ==</password> Contraseña

<language>ES</language>

<addressList> Lista de domicilios

<address addressType="Physical"> Tipo domicilio (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> 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>new.student.1@correo.com</email>  Correo
</schoolEmail>
</schoolEmailList>

<personRoleId>526589</personRoleId>
</unoStudent>
Respuesta

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

  • No labels