Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Este servicio será consultado por las aplicaciones que necesiten consultar los acuerdos modificados en rango de fechas de una empresa específica en la BDC obtener la cantidad de alumnos por Ciclo Escolar, Colegio, Nivel, Grado, Grupo y Material Contratado (Paquete), se reciban dichos datos de acuerdo a los parámetros especificados.

Situación actual

DescripciónConsulta los acuerdos modificados en un rango de fechas determinadas y para una empresa específicainformación sobre cantidad de alumnos por Ciclo Escolar, Colegio, Nivel, Grado, Grupo y Material Contratado (Paquete)
Referencia SIFExtensión de SIF 3.0.1
Entidad BDCcontratosif_census
Entidad SIFcontracts
Tipo de PeticiónGET
Parámetros


Campos
Descripción
Reglas de negocio
businessId
  • Empresa a la que pertenecen los acuerdos pertenece la información que se quieren consultar
  • Obligatorio
  • Los valores se pueden consultar en maestro de empresas.
  • El identificador debe existir.
  • En caso de ser un ID de empresa no válido entrega el siguiente mensaje:

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

timeModified
  • Fecha UTC desde la cuál se solicitan las creaciones/modificaciones de los acuerdos
  • ObligatorioseasonId
    • Año escolar del cuál se solicita la información.
    • Obligatorio
    • Los valores se pueden consultar en maestro de ciclo_escolar.
    • En caso de no especificar el parámetro, devuelve el siguiente mensaje:
      • <code>400</code>
        <message>Debe especificar un rango de fechas ciclo para consultar.</message>

    • Se consideran las creaciones/modificaciones de acuerdos en los siguientes campos:
      • contrato.fecha_actualizacion
      • contrato_fecha.fecha_actualizacion
      • contrato_fecha_pago.fecha_actualizacion
      • contrato_alumno.fecha_actualizacion
      • contrato_nivel.fecha_actualizacion
      • contrato_ciclo_escolar.fecha_actualizacion
      • contrato_comentario.fecha_actualizacion
      • contrato_material.fecha_actualizacion
      • contrato_profesor_materia.fecha_actualizacion
      • persona.fecha_actualizacion
      • persona_rol.fecha_actualizacion
      • persona_domicilio.fecha_actualizacion
    endTimeModified
    • Fecha UTC hasta la cuál se solicitan las creaciones/modificaciones de los acuerdos
    • Obligatorio
    •  En caso de no especificar el parámetro, devuelve el siguiente mensaje:
      • <code>400</code>
        <message>Debe especificar un rango de fechas para consultar.</message>

    • Se tienen las mismas reglas de negocio de timeModified.
    schoolId
    • Id del Colegio a consultar.
    • Opcional


    levelId
    • Id del Nivel a consultar.
    • Opcional
    • Los valores se pueden consultar en maestro de nivel.

    gradeId
    • Id del grado a consultar.
    • Opcional
    • Los valores se pueden consultar en maestro de grado.


    Ejemplo de llamada o de formulario

    http://desenvx.uno-internacionalsantillanar4.com/sifwssb/crm/contractscensus;contextId=   {"businessId":16,"timeModifiedseasonId":"2017-01-01 00:00:01", "endTimeModified":"2017-01-26 23:00:01"}

    Respuesta

    <contractList>
    <contract refId="00000000-0000-1000-0000-000000003626"/> contrato.contrato_id (Identificador único en la BDC)
    <contract refId="00000000-0000-1000-0000-000000003808"/>
    <contract 67,"schoolId":3622,"levelId":19,"gradeId":28}

    Respuesta
    <censusReport processingDate="2016-03-31" seasonId="67">
        <unoSchool refId="00000000-0000-1000-0000-
    000000015682
    000000003622"
    />
    <contract refId="00000000-0000-1000-0000-000000015701"/>
    <contract
    >
            <crmId>9FF276A0-6668-E511-80F8-3863BB353D98</crmId>
            <name>ESCUELA ACTIVA JEAN PIAGET</name>
            <totalUnoSchool>83</totalUnoSchool>
            <schoolLevel refId="00000000-0000-1000-0000-
    000000015767"/>
    <contract
    000000000019">
                <level>Bachillerato</level>
                <totalCensus>83</totalCensus>
                <grade refId="00000000-0000-1000-0000-
    000000015785
    000000000028"
    />
    <contract refId="00000000-0000-1000-0000-000000015792"/>
    <contract
    >
                    <gradeName>1º- Primero Bachillerato</gradeName>
                    <totalCensus>83</totalCensus>
                    <group refId="00000000-0000-1000-0000-
    000000015798"/>
    <contract
    000000000016">
                        <groupCode>A</groupCode>
                        <totalCensus>27</totalCensus>
                        <packs>
                            <pack>
                                <name>SIN ASIGNAR MATERIAL</name>
                                <total>23</total>
                            </pack>
                            <pack>
                                <name>1BAC SAN COMPARTIR PACK BASICO 04 PRIMERO BACHILLERATO.B</name>
                                <total>4</total>
                            </pack>
                        </packs>
                    </group>
                    <group refId="00000000-0000-1000-0000-
    000000016912"/>
    <contract
    000000000017">
                        <groupCode>B</groupCode>
                        <totalCensus>29</totalCensus>
                        <packs>
                            <pack>
                                <name>SIN ASIGNAR MATERIAL</name>
                                <total>26</total>
                            </pack>
                            <pack>
                                <name>1BAC SAN COMPARTIR PACK BASICO 04 PRIMERO BACHILLERATO.B</name>
                                <total>3</total>
                            </pack>
                        </packs>
                    </group>
                    <group refId="00000000-0000-1000-0000-
    000000016913"/>
    <contract refId="00000000-0000-1000-0000-000000016918"/>
    <contract refId="00000000-0000-1000-0000-000000016921"/>
    <contract refId="00000000-0000-1000-0000-000000016924"/>
    <contract refId="00000000-0000-1000-0000-000000016926"/>
    </contractList>
    000000000018">
                        <groupCode>C</groupCode>
                        <totalCensus>27</totalCensus>
                        <packs>
                            <pack>
                                <name>SIN ASIGNAR MATERIAL</name>
                                <total>27</total>
                            </pack>
                        </packs>
                    </group>
                </grade>
            </schoolLevel>
        </unoSchool>
    </censusReport>
    ¿Quién lo utiliza y cómo?