Consultar Grupos

consultar_grupos ( (opcional) id_grupo as Integer, (opcional) tipo as String, (opcional) id_curso_externo as String)

El método obtiene el listado con los datos de grupos según lo especificado. Los parámetros son excluyentes, por mas que ingresemos mas de un parámetro, solo uno se procesará(el de mayor nivel de precedencia). El nivel de precedencia es, de mayor a menor, en el siguiente orden: id_grupo, id_curso_externo.

El parámetro tipo se mantiene para mantener la compatibilidad con las implementaciones realizadas, pero hoy en día todos los grupos son de tipo = 7.

Devuelve: 1{id + nombre + descripcion + estado + id_usuario_administrador + idioma + responsables_acceden_admin + tipo + (id_agrupacion + descripcion_agrupacion + nombre_agrupacion + id_grupo_cabecera + orden_agrupado) + (id_curso_externo)}n

Un conjunto de grupos (o uno solo), con los datos propios del grupo, y , si es que pertenece a una agrupación, los datos de ésta más el orden de agrupación de este grupo en ella. Adicionalmente, devuelve el identificador de un curso externo, si es que este grupo posee uno asociado:


Funcionamiento

  • Si se especifica el 'id_grupo': el método retorna los datos de ese grupo.
  • Si se especifica el 'tipo': el método retorna los datos de los grupos del tipo especificado.
    • Como el único existente es el 7, éste valor devuelve todos los grupos existentes, los valores <> 7 arrojan error.
  • Si se especifica el 'id_curso_externo': el método retorna los datos del grupo asociado al curso externo indicado.
  • Si no se especifica parámetro alguno: el método retorna los datos de todos los grupos de la plataforma.


Ejemplo de Respuesta

Ejemplo de respuesta de la llamada consultar_grupos, pasándole como parámetros : id_grupo y id_curso_externo:


  • Llamada:

      <aula:consultar_grupos>
       <aula:id_grupo>22</aula:id_grupo>
       <aula:tipo></aula:tipo>
       <aula:id_curso_externo>curso_manu</aula:id_curso_externo>
    </aula:consultar_grupos>

En esta llamada, podemos observar que se están queriendo consultar por id_grupo y por id_curso_externo, pero como son mutuamente excluyentes, y teniendo en cuenta el orden de precedencia, solo traerá los datos para el grupo con 'id_grupo'= "22", haciendo caso omiso del 'id_curso_externo' especificado.


  • Respuesta:

<consultar_grupos_response xmlns="urn:Educativa/Aula/">
       <grupos>
          <id>22</id>
          <nombre>02-Aula Clases</nombre>
          <descripcion>02-Aula Clases</descripcion>
          <estado>true</estado>
          <id_usuario_administrador>tic</id_usuario_administrador>
          <idioma>1</idioma>
          <responsables_acceden_admin>true</responsables_acceden_admin>
          <tipo>7</tipo>
          <id_agrupacion>1</id_agrupacion>
          <descripcion_agrupacion>agrupacion 1</descripcion_agrupacion>
          <nombre_agrupacion>agrupacion 1</nombre_agrupacion>
          <id_grupo_cabecera>22</id_grupo_cabecera>
          <orden_agrupado>1</orden_agrupado>
          <id_curso_externo>curso_manu</id_curso_externo>
       </grupos>
    </consultar_grupos_response>


Errores de validación

  • Educativa::Aula::Error::TipoGrupoInvalido - el tipo de grupo ingresado es <> 7.