API

DEEPSUA API

api_class

DeepsuaAPI

API de DEEPSUA

API de DEEPSUA para la gestión de los bots de Telegram.

__init__()

Inicializa la API. Además, se encarga de limpiar los logs antiguos y de configurar el logging.

comisiones()

Devuelve toda la información sobre las comisiones.

Returns:

Type	Description
dict	Diccionario con toda la info sobre las comisiones.

comisiones_coordinador(comision)

Devuelve información sobre el coordinador de una comisión.

Parameters:

Name	Type	Description	Default
comision	str	Comisión de la que se quiere obtener la info.	required

Returns:

Type	Description
dict	Diccionario con la info del coordinador de la comisión solicitada.

comisiones_get(comision)

Devuelve información sobre una comisión.

Parameters:

Name	Type	Description	Default
comision	str	Comisión de la que se quiere obtener la info.	required

Returns:

Type	Description
dict	Diccionario con la info de la comisión solicitada.

comisiones_lista()

Devuelve la lista de comisiones.

Returns:

Type	Description
list	Diccionario con la lista de comisiones.

comisiones_miembros_delete(comision, body)

Elimina un miembro de una comisión.

Parameters:

Name	Type	Description	Default
comision	str	Comisión de la que se quiere eliminar el miembro.	required
body		Diccionario con la info del miembro a eliminar.	required

Returns:

Type	Description
HTTPStatus	HTTP 200 si se ha eliminado correctamente.
HTTPStatus	HTTP 406 si no se ha podido eliminar.

comisiones_miembros_get(comision)

Devuelve la lista de miembros de una comisión.

Parameters:

Name	Type	Description	Default
comision	str	Comisión de la que se quiere obtener la info.	required

Returns:

Type	Description
list	Diccionario con la lista de miembros de la comisión solicitada.

comisiones_miembros_post(comision, body)

Añade un miembro a una comisión.

Parameters:

Name	Type	Description	Default
comision	str	Comisión a la que se quiere añadir el miembro.	required
body		Diccionario con la info del miembro a añadir.	required

Returns:

Type	Description
HTTPStatus	HTTP 201 si se ha añadido correctamente.
HTTPStatus	HTTP 406 si no se ha podido añadir.

comisiones_telegram(comision)

Devuelve la lista de miembros de una comisión.

Parameters:

Name	Type	Description	Default
comision	str	Comisión de la que se quiere obtener la info.	required

Returns:

Type	Description
dict	Diccionario con la lista de miembros de la comisión solicitada.

coordinador_grado(grado)

Devuelve información sobre el representante de un grado.

Parameters:

Name	Type	Description	Default
grado	str	Grado del que se quiere obtener la info.	required

Returns:

Type	Description
dict	Diccionario con la info del representante del grado solicitado.

deepsua()

Endpoint de Deepsua.

Returns:

Type	Description
dict	Diccionario con la info de Deepsua.

edit_bd(bdname, bd)

Edita la base de datos solicitada.

Parameters:

Name	Type	Description	Default
bdname	str	Nombre de la base de datos a editar.	required
bd	dict	Base de datos a editar.	required

Returns:

Type	Description
bool	True si la base de datos se ha editado correctamente.

get_bd(bdname, context='')

Devuelve la base de datos solicitada.

Parameters:

Name	Type	Description	Default
bdname	str	Nombre de la base de datos a devolver.	required
context	str	Contexto de la base de datos a devolver.	''

Returns:

Type	Description
dict	Base de datos solicitada.

get_calendarios_from_grado(grado)

Devuelve un diccionario con los calendarios pertenecientes a un grado.

Parameters:

Name	Type	Description	Default
grado	str	Grado del que se quieren obtener los calendarios.	required

Returns:

Type	Description
dict	Diccionario con los calendarios del grado solicitado.

get_cursos(grado)

Devuelve los cursos de un grado.

Parameters:

Name	Type	Description	Default
grado	str	Grado del que se quieren obtener los cursos.	required

Returns:

Type	Description
list	Lista con los cursos del grado solicitado.

get_grado(grado)

Devuelve toda la info de un grado.

Parameters:

Name	Type	Description	Default
grado	str	Grado del que se quiere obtener la info.	required

Returns:

Type	Description
dict	Diccionario con toda la info del grado.

get_grados()

Devuelve los grados de la API en bruto.

Returns:

Type	Description
list	Lista con los grados de la API.

get_grados_lista()

Devuelve los grados de la API.

Returns:

Type	Description
list	Lista con los grados de la API.

grupos_curso(grado)

Devuelve la lista de grupos de un grado.

Parameters:

Name	Type	Description	Default
grado	str	Grado del que se quieren obtener los grupos.	required

Returns:

Type	Description
list	Lista con los grupos del grado solicitado.

grupos_delegados(grado)

Devuelve la lista de delegados de un grado

Parameters:

Name	Type	Description	Default
grado	str	Grado del que se quieren obtener los delegados.	required

Returns:

Type	Description
list	Lista con los delegados del grado solicitado.

grupos_materias(grado)

Devuelve la lista de materias.

Parameters:

Name	Type	Description	Default
grado	str	Grado del que se quieren obtener las materias.	required

Returns:

Type	Description
list	Lista con las materias del grado solicitado.

permanente()

Devuelve la lista de representantes de la permanente.

Returns:

Type	Description
dict	Diccionario con la lista de representantes de la permanente.

root()

Devuelve la raíz de la API.

Returns:

Type	Description
dict	Diccionario con la raíz de la API.

rrss()

Devuelve la lista de rrss.

Returns:

Type	Description
list	Lista con la lista de rrss.