Servicio /crm/census

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á consultado por las aplicaciones que necesiten 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 información sobre cantidad de alumnos por Ciclo Escolar, Colegio, Nivel, Grado, Grupo y Material Contratado (Paquete)
Referencia SIF
Entidad BDCsif_census
Entidad SIF
Tipo de PeticiónGET
Parámetros
Campos
Descripción
Reglas de negocio
businessId
  • Empresa a la que 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>

seasonId
  • 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 ciclo para consultar.</message>

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

https://homol.uno-internacional.com/wssb/crm/census;contextId= {"businessId":6,"seasonId":67,"schoolId":3622,"levelId":19,"gradeId":28}

Respuesta
<censusReport processingDate="2016-03-31" seasonId="67">
    <unoSchool refId="00000000-0000-1000-0000-000000003622">
        <crmId>9FF276A0-6668-E511-80F8-3863BB353D98</crmId>
        <name>ESCUELA ACTIVA JEAN PIAGET</name>
        <totalUnoSchool>83</totalUnoSchool>
        <schoolLevel refId="00000000-0000-1000-0000-000000000019">
            <level>Bachillerato</level>
            <totalCensus>83</totalCensus>
            <grade refId="00000000-0000-1000-0000-000000000028">
                <gradeName>1º- Primero Bachillerato</gradeName>
                <totalCensus>83</totalCensus>
                <group refId="00000000-0000-1000-0000-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-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-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?

 


 

Related pages