...
Panel |
---|
|
< , > statuscolour | Yellow |
title | Petición de cambio |
o Status |
---|
colour | Red |
---|
title | Descontinuado |
---|
|
>
Note |
---|
|
- Cuando un requisito de sistema software tenga el estado En Uso, solo se debe mostrar la descripción del mismo.
- Cuando un requisito de sistema software tenga el estado Petición de Cambio, seguido de su descripción debe venir descrita la petición de cambio asociada.
- Cuando un requisito de sistema software tenga el estado Descontinuado, se entiende que ya no aplica.
|
Panel |
---|
|
Note |
---|
| - Se debe especificar a qué aplicaciones impacta el requisito de sistema software.
|
|
Situación actual
Descripción | <Se describe el uso que se le da al requisito de sistema software. > |
Referencia SIF | <Si es un webservice, se especifica la referencia SIF> |
Tipo de Petición | <Si es un webservice, se especifica el tipo de petición: GET, POST, PUT> |
Parámetros o Campos | <Se especifican los campos del formulario o parámetros del servicio con las reglas de negocio que se aplican> Campos | Descripción | Reglas de negocio |
---|
<nombre del campo> | - <Posibles valores>
- <Obligatorio / No obligatorio>
| - <Se describen todas las reglas de negocio aplicadas al campo o parámetro>
- Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a libero placerat, commodo risus vel, gravida lectus. Vestibulum purus nunc, commodo at metus in, commodo suscipit magna. Aliquam felis odio, iaculis ut eros eget, lacinia blandit massa. Nam tempor augue nisl, quis volutpat lorem varius a. Phasellus quam nisl, sagittis et commodo in, aliquam non massa.
|
|
Ejemplo de llamada o de formulario | <ejemplo de llamada o diseño del formulario> |
Respuesta | <ejemplo de respuesta o descripción del resultado> |
¿Quién lo utiliza y cómo? | <qué aplicación utiliza el requisito de sistema software o el webservice, cómo lo utiliza> |
Petición de cambio
Panel |
---|
border | true |
---|
title | Petición de cambio |
---|
|
- Motivo del cambio:
- Solicitado por:
Warning |
---|
title | Descripción del cambio |
---|
| Se debe mantener la misma descripción, tachando lo que se desea eliminar y se agregando los elementos de cambio con color verde. |
Campos | Descripción | Reglas de negocio |
---|
<nombre del campo a modificar> | - <Posibles valores>
- <Obligatorio / No obligatorio>
| - Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Donec a libero placerat, commodo risus vel, gravida lectus. Vestibulum purus nunc, commodo at metus in, commodo suscipit magna. Aliquam felis odio, iaculis ut eros eget, lacinia blandit massa. Nam tempor augue nisl, quis volutpat lorem varius a. Phasellus quam nisl, sagittis et commodo in, aliquam non massa. Suspendisse scelerisque nibh ultrices elementum ultricies. Mauris tincidunt faucibus diam, id fringilla odio pretium consequat. Duis sed nisi bibendum, efficitur elit vel, porttitor justo. Ut sem turpis, egestas ac aliquam sed, hendrerit sit amet leo. In vitae accumsan turpis.
|
- Línea de trabajo:
- <Se describen los pasos a realizar para realizar el cambio>
|
Panel |
---|
|
- <Se listan los JIRA asociados a la descripción del requisito de sistema software o de la petición de cambio.>
|
| 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ón | Actualiza uno o varios Alumnos. Actualizando también persona, persona_login, persona_domicilio y domicilio. |
Referencia SIF | Extensión de SIF 3.0.1 |
Entidad BDC | Alumno |
Entidad SIF | Extensión de la entidad k12student (CEDS_K12.xsd). |
Tipo de Petición | PUT |
Parámetros o campos |
| | |
---|
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:
En caso que el usuario que invoca el servicio (generatorId) no tenga permisos en la empresa donde esta relacionado el alumno, devuelve:
|
|
Parámetros en XML payload | - Valida payload. En caso de no ser correcto manda mensaje de error.
Campo | Descripción | Reglas de Negocio |
---|
unoStudent refId | - Identificador único en la BDC alumno.alumno_id
- Obligatorio
| | studentId | |
| firstName |
| - 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.
| | password | | - Para crear login, debe dar userId y password.
| language | |
| personRefId | - Identificador único en la BDC persona.persona_id
|
| curp | |
| addressType | - Tipo domicilio
- Valores: Physical, Mailing, Shipping
|
| line1 | |
| city | |
| neighborhood | |
| postalCode | |
| buildingSiteNumber | |
| county | |
| stateProvince | |
| countyRefId | - Identificador único en la BDC municipio.municipio_id
- Obligatorio
- Valores: ver maestro de municipios.
|
| phoneNumberType | - Tipo
- Valores: Home, Mobile
|
| number | |
| email | |
| 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).
| 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 CPFvá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 formulario | En caso de actualizar solo un Alumno: https://homol.uno-internacional.com/sif/unoStudent/00000000-0000-1000-0000-000004036006 |
Ejemplo XML Payload |
Code Block |
---|
| <unoStudent refId="00000000-0000-1000-0000-000004036006">
<studentId>JMAV</studentId>
<name>
<firstName>Joel Maximiliano</firstName>
<middleName>Aguilar</middleName>
<lastName>Valdez</lastName>
</name>
<birthDate>2008-12-04</birthDate>
<sex>Male</sex>
<userId>joelmaximiliano.aguilar.9</userId>
<password>dmFsZXJpYS5w</password>
<language>ES</language>
<personRefId>00000000-0000-1000-0000-000003149709</personRefId>
<curp></curp>
<addressList>
<address addressType="Physical">
<street>
<line1>Rosas 101</line1>
</street>
<city>QUINTANA ROO</city>
<neighborhood>SM 223 MZA 6 LTE 15..</neighborhood>
<postalCode>CANCUN</postalCode>
<buildingSiteNumber>41</buildingSiteNumber>
<county>BENITO JUAREZ</county>
<stateProvince>Quintana Roo</stateProvince>
<countyRefId>00000000-0000-1000-0000-000000015248</countyRefId>
</address>
</addressList>
<phoneNumberList>
<phoneNumber phoneNumberType="Home">
<number>53956782</number>
</phoneNumber>
<phoneNumber phoneNumberType="Mobile">
<number>5537651829</number>
</phoneNumber>
</phoneNumberList>
<schoolEmailList>
<schoolEmail>
<email>correo@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 | N/A (Código 204). |
Ejemplo de llamada o formulario | Puede actualizar varios: https://homol.uno-internacional.com/sif/unoStudent |
Ejemplo XML Payload |
Code Block |
---|
| <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 />
<personRoleId>00000000-0000-1000-0000-000000526589</personRoleId>
<paymentResponsibleId>53465435621</paymentResponsibleId>
</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 />
<personRoleId>00000000-0000-1000-0000-000000526589</personRoleId>
<paymentResponsibleId>53465435621</paymentResponsibleId>
</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 />
<personRoleId>00000000-0000-1000-0000-000000526589</personRoleId>
<paymentResponsibleId>53465435621</paymentResponsibleId>
<lmsBlocked>true</lmsBlocked>
</unoStudent>
</unoStudentList> |
|
Respuesta |
Code Block |
---|
| <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> |
|