Skip to end of metadata
Go to start of metadata
Situación actual
| Descripción | Consulta los Alumnos asociados a un Colegio para un Ciclo en específico. Opcionalmente se puede filtrar por nivel, grado y/o grupo. En esta consulta no se enlistan alumnos con borrado lógico. |
| Referencia SIF | Extensión de SIF 3.0.1 |
| Entidad BDC | Alumno |
| Entidad SIF | UNOStudent (Lista) |
| Tipo de Petición | GET |
| Parámetros o Campos | | Campos | Descripción | Reglas de negocio |
|---|
| school | | - El identificador del colegio debe existir, en caso de no ser válido devuelve:
- Si no se especifica el parámetro, como es obligatorio devuelve:
| | schoolYear | | - El colegio debe existir en el año escolar, en caso de no ser válido devuelve:
- Si no se especifica el parámetro, como es obligatorio devuelve:
- <code>400</code>
<message>Debe especificar el identificador del colegio.</message>
| | level | | - El nivel debe existir para el colegio, en caso de no ser válido devuelve
- <code>404</code>
<message>No se encontraron datos con los parámetros especificados.</message>
- Si no se especifica el parámetro, como es obligatorio devuelve:
| | grade | - (Opcional) Id del grado que se consulta.
|
| | group | - (Opcional) Id del grupo que se consulta. Ver maestro de Grupos.
|
| keys | - (Opcional) Indicador de regresar solo llaves de entidades.
- Valores: true, false.
- Default: false.
|
| | timeModified | (Opcional) Fecha Brazil/East desde la cuál se solicitan las creaciones/actualizaciones de usuarios | - Se consultan los alumno creados y modificados desde esta fecha, teniendo en cuenta los campos:
- persona.fecha_registro
- persona.fecha_actualizacion
- persona_login.fecha_actualizacion
- persona_rol.fecha_actualizacion
- alumno.fecha_actualizacion
| | endTimeModified | (Opcional) Fecha Brazil/East hasta la cuál se solicitan las creaciones/actualizaciones de usuarios | Se consultan los usuarios creados y modificados hasta esta fecha, teniendo en cuenta las mismas reglas de negocio de timeModified. |
|
| Ejemplo de llamada o de formulario | https://homol.uno-internacional.com/sif/unoSchool/unoStudentExt;contextId={"school":1135, "schoolYear":2017, "keys":false, "level":18, "grade":25, "group":17} |
| Respuesta | <unoStudentList>
<unoStudent refId="00000000-0000-1000-0000-000005221937" > alumno.alumno_id (Identificador único en la BDC, asignado para el ciclo escolar)
<studentId></studentId> Clave del alumno
<name>
<firstName>DANA PAULINA</firstName> Nombre
<middleName>AMEZCUA</middleName> Apellido Paterno
<lastName>SANCHEZ</lastName> Apellido Materno
</name>
<birthDate>2003-06-15</birthDate> Fecha de nacimiento
<sex>Female</sex> (Male, Female, Not selected)
<userId>dana.amezcua.sm</userId> Username <exitDate>2020-01-14</exitDate> Indica que el usuario se encuentra inactivo y fue actualizado en la fecha indicada
<language>ES</language> Idioma
<personRefId>00000000-0000-1000-0000-000001029240</personRefId> persona.persona_id (Identificador único en la BDC)
<curp>AESD030615MHGMNNA1</curp> CURP
<addressList> Listado de domicilios
<address addressType="Physical"> Tipo de dirección (Physical, Mailing, Shipping)
<street>
<line1></line1> Calle
</street>
<city></city> Ciudad
<neighborhood></neighborhood> Colonia
<postalCode></postalCode> Código postal
<buildingSiteNumber></buildingSiteNumber> Número
<county>METEPEC</county> Municipio
<stateProvince>Estado de México</stateProvince> Estado
<countyRefId>00000000-0000-1000-0000-000000011121</countyRefId> municipio.municipio_id (Identificador único en la BDC)
</address>
</addressList>
<phoneNumberList></phoneNumberList> Listado de teléfonos
<schoolEmailList></schoolEmailList> Listado de correos electrónicos
</unoStudent> .... <unoStudent refId="00000000-0000-1000-0000-000005582760" > .........
</unoStudent>
</unoStudentList>
|
| ¿Quién lo utiliza y cómo? | Este servicio será utilizado sólo por MIM para consultar datos de alumnos asociados a un colegio para un ciclo específico con la BDC. |