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 11 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 asociaciones de Alumno-Grado-Grupo en la BDC.


Situación actual

Descripción

Inserta/actualiza una entidad StudentGroupAssociation (Alumno-Grado-Grupo), para un Colegio en un Ciclo en específico. Se valida que el alumno no tenga borrado lógico, que el colegio pertenezca al ciclo escolar, verificando consistencia entre los niveles del colegio y grados indicados en los parámetros. Antes de insertar la entidad Alumno-Grado-Grupo, se verifica que no exista para evitar duplicidad, de existir se actualiza con los datos indicados.

Referencia SIFExtensión de SIF 3.0.1
Tipo de PeticiónPOST
Parámetros o Campos
Campos en llamadaDescripciónReglas de negocio
school
  • (Obligatorio) Id del Colegio correspondiente
  • El identificador del colegio debe existir, en caso de no ser válido devuelve:
    •  <code>400</code>

      <message>El identificador propocionado no es válido.</message>

  • Si no se especifica el parámetro, como es obligatorio devuelve:
    •  <code>400</code>
      <message>Debe especificar el identificador del colegio.</message>
  • El colegio debe existir en el ciclo escolar que se especifica.
  • Si el alumno ya se encuentra relacionado a un colegio distinto al que se indica en el parámetro, devuelve:

    • <code>409</code>
      <message>El alumno ya está asignado a un grupo.</message>

  • En caso de que el alumno tenga borrado lógico, se devuelve el siguiente mensaje:

    • <error id="00000000-0000-1000-0000-000781714646" >
      <code>409</code>
      <message>Ocurrió un error al guardar la información del alumno.</message>
      </error>

  • En caso que el usuario que invoca el servicio (generatorId) no tenga permisos en la empresa donde esta relacionado el colegio, devuelve:

    • <code>403</code>
      <message>No tiene permiso para insertar o modificar en la empresa a la que pertenece el colegio.</message>

schoolYear
  • (Obligatorio) Año escolar que se consulta 
  • El colegio debe existir en el año escolar, en caso de no ser válido devuelve:

    • <code>400</code>
      <message>El identificador propocionado no es válido</message>

  • Si no se especifica el parámetro, como es obligatorio devuelve:
    •  <code>400</code>
      <message>Debe especificar un ciclo para consultar.</message>
Campos en XML payloadDescripciónReglas de negocio
unoStudentRefId
  • (Obligatorio)  alumno.alumno_id (Identificador único en la BDC, asignado para el ciclo escolar)
  • En caso que no se especifique correctamente el tag del grado devuelve:
    • <code>400</code>
      <message>El xml del payload no se encuentra bien formado.</message>
  • El identificador del alumno debe existir, en caso de no ser válido devuelve:

    • <code>400</code>
      <message>>El identificador propocionado no es válido.</message>

  • El alumno debe tener relacionada una persona, en caso de no ser válido devuelve:
    • <code>400</code>
      <message>Ocurrió un error al guardar la información personal.</message>

  • En caso que el usuario que invoca el servicio (generatorId) no tenga permisos en la empresa donde esta relacionado el alumno_id, devuelve:

    • <code>403</code>
      <message>No tiene permiso para insertar o modificar en la empresa a la que pertenece el alumno.</message>

gradeRefId
  • En caso que no se especifique correctamente el tag del grado devuelve:
    • <code>400</code>
      <message>El xml del payload no se encuentra bien formado.</message>
  • El identificador del grado debe existir, en caso de no ser válido devuelve:

      • <code>400</code>
        <message>>El identificador propocionado no es válido.</message>


groupRefId
  • (Obligatorio)  grupo_id. Ver maestro de Grupos.
  • En caso que no se especifique correctamente el tag del grupo devuelve:
    • <code>400</code>
      <message>El xml del payload no se encuentra bien formado.</message>
  • El identificador del grupo debe existir, en caso de no ser válido devuelve:

      • <code>400</code>
        <message>>El identificador propocionado no es válido.</message>

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 formulario

https://homol.uno-internacional.com/sif/studentGroupAssociation;contextId={"school":1253, "schoolYear":2018}

Ejemplo XML payload

<studentGroupAssociation refId="">
    <unoStudentRefId>00000000-0000-1000-0000-000008460659</unoStudentRefId>
    <gradeRefId>00000000-0000-1000-0000-000000000037</gradeRefId>
    <groupRefId>00000000-0000-1000-0000-000000000016</groupRefId>
	<personRoleId>526589</personRoleId>
</studentGroupAssociation>
Respuesta

<createResponse>

    <creates>

        <create id="00000016-0000-1000-0000-000008460659" alumno.alumno_id.

statusCode="200" /> Se realizó exitosamente la inserción de la asociación StudentGroupAssociation (Alumno-Grado-Grupo).

    </creates>

</createResponse>

¿Quién lo utiliza y cómo?


  • No labels