Descripción
En esta documentación, se detallan los diferentes Web Services disponibles en la plataforma BCN360, junto con sus respectivas funciones y parámetros.
Endpoint para obtener el Token de Acceso
Para obtener el token de acceso, utiliza el siguiente endpoint: https://urlcampus/login/token.php
Obtener Token para Realizar Peticiones
- Descripción: Obtener un token de acceso para realizar peticiones a la plataforma.
- Parámetros:
| Parámetro | Descripción | Obligatorio |
|---|---|---|
| username | Nombre de usuario del usuario. | Sí |
| password | Contraseña del usuario. | Sí |
| service | moodle_mobile_app | Si |
Endpoint para llamar a los Web Services
El endpoint para llamar a los Web Services es: https://urlcampus/webservice/rest/server.php
Web Services Disponibles
Obtener Información del Usuario
- Función: local_bcn_user_manager_user_get
- Descripción: Obtener información del usuario.
- Parámetros:
| Parámetro | Descripción | Obligatorio |
|---|---|---|
| user[username] | Nombre de usuario del usuario. | Sí |
Creación de un Usuario
- Función: local_bcn_user_manager_user_add
- Descripción: Crear un nuevo usuario.
- Parámetros:
| Parámetro | Descripción | Obligatorio |
|---|---|---|
| user[username] | Nombre de usuario del nuevo usuario. | Sí |
| user[firstname] | Nombre del nuevo usuario. | Sí |
| user[lastname] | Apellido del nuevo usuario. | Sí |
| user[email] | Correo electrónico del nuevo usuario. | Sí |
| user[password] | Contraseña del nuevo usuario. | Sí |
| user[idnumber] | Número de identificación del nuevo usuario. | No |
| user[phone1] | Teléfono principal del nuevo usuario. | No |
| user[phone2] | Teléfono secundario del nuevo usuario. | No |
| user[country] | País del nuevo usuario. | No |
| user[nombrecampoadicional_1] | Campos adicionales personalizados. | No |
| user[nombrecampoadicional_2] | Campos adicionales personalizados. | No |
| user[nombrecampoadicional_3] | Campos adicionales personalizados. | No |
| … | … | … |
Actualización de un Usuario
- Función: local_bcn_user_manager_user_update
- Descripción: Actualizar los datos de un usuario existente.
- Parámetros:
| Parámetro | Descripción | Obligatorio |
|---|---|---|
| user[username] | Nombre de usuario del usuario a actualizar. | Sí |
| user[firstname] | Nuevo nombre del usuario. | No |
| user[lastname] | Nuevo apellido del usuario. | No |
| user[email] | Nuevo correo electrónico del usuario. | No |
| user[password] | Nueva contraseña del usuario. | No |
| user[idnumber] | Nuevo número de identificación del usuario. | No |
| user[phone1] | Nuevo teléfono principal del usuario. | No |
| user[phone2] | Nuevo teléfono secundario del usuario. | No |
| user[country] | Nuevo país del usuario. | No |
| user[nombrecampoadicional_1] | Campos adicionales personalizados. | No |
| user[nombrecampoadicional_2] | Campos adicionales personalizados. | No |
| user[nombrecampoadicional_3] | Campos adicionales personalizados. | No |
| … | … | … |
Deshabilitar un Usuario
- Función: local_bcn_user_manager_user_disable
- Descripción: Deshabilitar un usuario existente en la plataforma.
- Parámetros:
| Parámetro | Descripción | Obligatorio |
|---|---|---|
| user[username] | Nombre de usuario del usuario a deshabilitar. | Sí |
Habilitar un Usuario
- Función: local_bcn_user_manager_user_enable
- Descripción: Habilitar un usuario previamente deshabilitado en la plataforma.
- Parámetros:
| Parámetro | Descripción | Obligatorio |
|---|---|---|
| user[username] | Nombre de usuario del usuario a habilitar. | Sí |
Eliminar un Usuario
- Función: local_bcn_user_manager_user_delete
- Descripción: Eliminar un usuario de forma permanente de la plataforma.
- Parámetros:
| Parámetro | Descripción | Obligatorio |
|---|---|---|
| user[username] | Nombre de usuario del usuario a eliminar. | Sí |
Obtener cursos matriculados de un Usuario
- Función: core_enrol_get_users_courses
- Descripción: Obtener la información de los cursos matriculados a un usuario.
- Parámetros:
| Parámetro | Descripción | Obligatorio |
|---|---|---|
| userid | ID del usuario. | Sí |
Last updated on