Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleEstado
<

Status
colourGreen
titleEn

uso

Uso

Status
colourYellow
titlePetición de cambio
o 
Status
colourRed
titleDescontinuado
>

 

Petición de cambio
Note
title
Info
titleEn Uso

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
    titleImpacto
    •  
    Note
    titlePetición de cambio
    Se debe especificar a qué aplicaciones impacta el requisito de sistema software

    significa que está disponible para su uso.

     

    Este servicio será consultado por las aplicaciones que necesiten sincronizar datos de la asociación Alumno-Grado-Grupo con la BDC con cierta periodicidad.

    Situación actual

    Referencia SIF<Si es un webservice, se especifica la referencia SIF>
    Descripción
    <Se describe el uso que se le da al requisito de sistema software. >

    Consulta la asociación Alumno-Grado-Grupo para un Colegio en un Ciclo en específico, si se especifica un Nivel se regresan los datos para ese Nivel, si no se especifica el Nivel se regresan los datos para todos los Niveles asociados al Colegio para el Ciclo especificado.

    Referencia SIFExtensión de SIF 3.0.1
    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>

    CamposDescripciónReglas 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
    bordertrue
    titlePetición de cambio
    • Motivo del cambio:
    • Solicitado por:
    Warning
    titleDescripció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.

     

     

    CamposDescripciónReglas 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>

     

    ...

    titleEnlaces

    ...

    school
    • (Obligatorio) Id del Colegio correspondiente
    • El identificador del colegio debe existir, en caso de no ser válido devuelve:
      •  <code>404</code>

        <message>No se encontraron datos con los parámetros especificados.</message>

    • Si no ese especifica el parámetro, como es obligatorio devuelve:
      •  <code>400</code>
        <message>Debe especificar el identificador del 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>404</code>
        <message>No se encontraron datos con los parámetros especificados.</message>

    • Si no se especifica el parámetro, como es obligatorio devuelve:
      •  <code>400</code>
        <message>Debe especificar un ciclo para consultar.</message>
    level
    • (Opcional) Id del Nivel del Colegio que se consulta. Ver maestro de niveles
    • 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>
    keys
    • (Opcional) Indicador de regresar solo llaves de entidades. Default: false.
       
     

     

     

    Ejemplo de llamada o de formulario

    http://desenv.uno-internacional.com/sif/unoSchool/studentGroupAssociation;contextId={"school":1135, "schoolYear":2015, "level":18, "keys":false}

    Respuesta

    <studentGroupAssociationList>
    <studentGroupAssociation refId="00000016-0000-1000-0000-000002657856" > refId compuesto por el grupo_id y alumno.alumno_id (Identificador único en la BDC).  Ver maestro de Grupos.
    <unoStudentRefId>00000000-0000-1000-0000-000002657856</unoStudentRefId> alumno.alumno_id (Identificador único en la BDC)
      <gradeRefId>00000000-0000-1000-0000-000000000026</gradeRefId> grado_id
    <groupRefId>00000000-0000-1000-0000-000000000016</groupRefId> grupo_id. Ver maestro de Grupos.
    </studentGroupAssociation>
    <studentGroupAssociation refId="00000016-0000-1000-0000-000002657857" >
    <unoStudentRefId>00000000-0000-1000-0000-000002657857</unoStudentRefId>
    <gradeRefId>00000000-0000-1000-0000-000000000026</gradeRefId>
    <groupRefId>00000000-0000-1000-0000-000000000016</groupRefId>
    </studentGroupAssociation>
    <studentGroupAssociation refId="00000016-0000-1000-0000-000002657860" >
    <unoStudentRefId>00000000-0000-1000-0000-000002657860</unoStudentRefId>
    <gradeRefId>00000000-0000-1000-0000-000000000026</gradeRefId>
    <groupRefId>00000000-0000-1000-0000-000000000016</groupRefId>
    </studentGroupAssociation>
    ......
    ......

    <resumen>
    <niveles>
    <nivel>
    <nivel_id>18</nivel_id> nivel_id
    <colegio_nivel_ciclo_id>12776</colegio_nivel_ciclo_id> colegio_nivel_ciclo_id
    <grupos>
    <grupo>
    <grado_id>26</grado_id> grado_id
    <grupo_id>16</grupo_id> grupo_id
    <total>23</total> total alumno del nivel_id, grado_id y grupo_id
    </grupo>

    </grupos>
    </nivel>
    </niveles>
    <total>141</total> total alumno del colegio
    </resumen>
    </studentGroupAssociationList>

    ¿Quién lo utiliza y cómo?