consultar_tiempo_estimado_uso
Consultar tiempo estimado de uso
consultar_tiempo_estimado_uso (id_usuario as String, id_curso as Integer, (opcional) fecha_inicio as Date, (opcional) fecha_fin as Date )
El método nos permite obtener el tiempo estimado de uso de un usuario sobre un grupo particular de la plataforma, opcionalmente en un período de tiempo dado.
Devuelve: id_usuario + id_curso + tiempo_estimado_uso
Funcionamiento
- Para obtener el tiempo estimado de uso de un usuario en un grupo debemos especificar el id_usuario y el id_grupo.
- Si queremos consultar el tiempo estimado de uso para un usuario en un grupo, para un rango de fechas especifico, además de especificar los parámetros 'id_usuario' y 'id_grupo', debemos pasar los parámetros correspondientes a fecha, y tenemos tres opciones: pasar solamente fecha_inicio, pasar solamente fecha_fin o pasar fecha_inicio y fecha_fin.
- Se Restringe el periodo a lo establecido en el parámetro rango_meses_log_acciones.
- La fecha mínima se calcula como la fecha más reciente entre el primero de mes de rango_meses_log_acciones meses atrás y el primero de mes correspondiente al primer registro existente en las tablas de log_acciones.
- Si no ingresamos fecha_inicio se utiliza la fecha mínima calculada
- Si la fecha_inicio ingresada es menor a la fecha mínima calculada se informa el error.
- Formato de la fecha a ingresar: aaaa-mm-dd
- El valor de tiempo entre clicks que se considera para armar los bloques de uso se toma del parámetro de config_params: tiempo_entre_clicks.
- Formato de devolución del tiempo estimado de uso: horas:minutos
Ejemplo de Respuesta
Ejemplo de respuesta de la llamada consultar_tiempo_estimado_uso, pasando los parámetros opcionales 'fecha_inicio' y 'fecha_fin'.
- Llamada:
<aula:consultar_tiempo_estimado_uso>
<aula:id_usuario>educativa</aula:id_usuario>
<aula:id_curso>32</aula:id_curso>
<aula:fecha_inicio>2018-05-01</aula:fecha_inicio>
<aula:fecha_fin>2019-01-15</aula:fecha_fin>
</aula:consultar_tiempo_estimado_uso>
En esta llamada, podemos observar que se solicita consultar el tiempo estimado de uso para el 'id_usuario'= "educativa", en el 'id_curso'= "32", entre las fechas 2018-05-01 y 2019-01-15. La respuesta indica el tiempo estimado de uso del usuario, en el grupo indicado, en el lapso de tiempo indicado.
- Respuesta:
<consultar_tiempo_estimado_uso_response xmlns="urn:Educativa/Aula/">
<id_usuario>educativa</id_usuario>
<id_curso>32</id_curso>
<tiempo_estimado_uso>600:50</tiempo_estimado_uso>
</consultar_tiempo_estimado_uso_response>
Errores de validación
- Educativa::Aula::Error::IdUsuarioInvalido - cuando el 'id_usuario' ingresado contiene caracteres inválidos o es vacío.
- Educativa::Aula::Error::UsuarioInexistente - ocurre cuando el usuario no existe en la plataforma.
- Educativa::Aula::Error::UsuarioInexistenteEnGrupo - ocurre cuando se intenta consultar accesos para un usuario en un grupo en el que no existe.
- Educativa::Aula::Error::IdGrupoInvalido - ocurre cuando el 'id_grupo' ingresado no es integer.
- Educativa::Aula::Error::GrupoInexistente - ocurre cuando el 'id_grupo' ingresado no existe en la plataforma.
- Educativa::Aula::Error::FechaFormatoInvalido - al ingresar una fecha con un formato distinto a aaaa-mm-dd.
- Educativa::Aula::Error::FechaInvalida - al ingresar una fecha no existente, ej: no existe dicho día para ese mes.
- Educativa::Aula::Error::RangoFechaInvalido - cuando la fecha de finalización es anterior a la fecha de inicio.
- Educativa::Aula::Error::FechaInicioInvalida - cuando la 'fecha_inicio' ingresada es menor a la fecha mínima calculada.