Groups

1. Obtener la lista de grupos de un curso.

- local_contentdata_get_groups

Descripción:
Servicio para obtener la lista de grupos de un curso.

Endpoint: local_contentdata_get_groups
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_get_groups
• courseid: int | id de curso

Respuestas:

Éxito

Se obtiene la lista de grupos

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'id': id del grupo,
        'name': nombre del grupo,
        'currentsection': módulo actual del grupo,
        'active': bandera para identificar si el grupo está activo o inactivo
        'skinid': id de skin
    ]
}

Fallo

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 1,
    "message": "Course not found",
    "body": []
}

2. crear un grupo.

- local_contentdata_create_group

Descripción:
Servicio para crear un grupo.

Endpoint: local_contentdata_create_group
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_create_group
• usertoken: string | token del usuario
• courseid: int | id de curso
• name: string | nombre del grupo
• skinid: int | id de skin
• starttimestamp: int | fecha de inicio en timestamp

Respuestas:

Éxito

Se creó el grupo

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
    ]
}

Fallo

Error producido si el usuario no tiene permisos

{
    "status": 403,
    "code": 1,
    "message": "Permission denied",
    "body": []
}

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 2,
    "message": "Course not found",
    "body": []
}

Error producido si ya existe un grupo con el mismo nombre

{
    "status": 404,
    "code": 3,
    "message": "The group name already exist",
    "body": []
}

3. Eliminar un grupo.

- local_contentdata_delete_course_group

Descripción:
Servicio para eliminar un grupo.

Endpoint: local_contentdata_delete_course_group
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_delete_course_group
• usertoken: string | token del usuario
• courseid: int | id de curso
• groupid: int | id de grupo

Respuestas:

Éxito

Se eliminó el grupo

{
    "status": 200,
    "code": 0,
    "message": ""
}

Fallo

Error producido si el usuario no tiene permisos

{
    "status": 403,
    "code": 1,
    "message": "Permission denied"
}

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 2,
    "message": "Course not found"
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 3,
    "message": "Group not found"
}

Error producido si el grupo tiene usuarios inscritos

{
    "status": 404,
    "code": 4,
    "message": "Delete not available, group has users"
}

4. Obtener la información de un grupo.

- local_contentdata_get_course_group_info

Descripción:
Servicio para obtener la información de un grupo.

Endpoint: local_contentdata_get_course_group_info
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_get_course_group_info
• courseid: int | id de curso
• groupid: int | id de grupo

Respuestas:

Éxito

Se obtuvo la información el grupo

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'id': id del grupo,
        'name': nombre del grupo,
        'skinid': id de skin,
        'startdate': fecha de inicio del grupo,
        'modulesdurationdays': duración de los módulos en días
    ]
}

Fallo

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 1,
    "message": "Course not found",
    "body": []
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 2,
    "message": "Group not found",
    "body": []
}

5. Actualizar un grupo.

- local_contentdata_update_course_group

Descripción:
Servicio para actualizar un grupo.

Endpoint: local_contentdata_update_course_group
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_update_course_group
• usertoken: string | token del usuario
• courseid: int | id de curso
• groupid: int | id de grupo
• name: string | nombre del grupo
• skinid: int | id de skin
• startdate: int | fecha de inicio en timestamp
• modulesdurationdays: int | duración de los módulos

Respuestas:

Éxito

Se actualizó el grupo

{
    "status": 200,
    "code": 0,
    "message": ""
}

Fallo

Error producido si el usuario no tiene permisos

{
    "status": 403,
    "code": 1,
    "message": "Permission denied"
}

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 2,
    "message": "Course not found"
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 3,
    "message": "Group not found"
}

Error producido si no se encontró el skin

{
    "status": 404,
    "code": 3,
    "message": "Skin not found"
}

6. Actualizar la fecha de un módulo.

- local_contentdata_update_section_date

Descripción:
Servicio para actualizar la fecha de un módulo.

Endpoint: local_contentdata_update_section_date
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_update_section_date
• courseid: int | id de curso
• groupid: int | id de grupo
• sectionid: int | id de la sección (cmid)
• startdatetimestamp: int | fecha de inicio en timestamp
• enddatetimestamp: int | fecha de cierre en timestamp
• userid: int | id de usuario (opcional)

Respuestas:

Éxito

Se actualizó el módulo

{
    "status": 200,
    "code": 0,
    "message": ""
}

Fallo

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 1,
    "message": "Course not found"
}

Error producido si el tipo de curso es incorrecto

{
    "status": 404,
    "code": 2,
    "message": "Incorrect course type"
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 3,
    "message": "Group not found"
}

Error producido si no se encontró el módulo

{
    "status": 404,
    "code": 4,
    "message": "Section not found"
}

7. Obtener el calendario de un grupo.

- local_contentdata_get_group_calendar

Descripción:
Servicio para obtener el calendario de un grupo.

Endpoint: local_contentdata_get_group_calendar
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_get_group_calendar
• courseid: int | id de curso
• groupid: int | id de grupo

Respuestas:

Éxito

Se actualizó el módulo

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'sections':
            'id': id de sección
            'name': nombre del módulo
            'section': número de sección
            'startdate': fecha de inicio
            'enddate': fecha de cierre
        'quizzes':
            'id': id de sección
            'name': nombre del módulo
            'section': número de sección
            'startdate': fecha de inicio
            'enddate': fecha de cierre
            'quizcategoryid': categoría de examen
            'quiztypeid': tipo de examen
        'forums':
            'id': id de sección
            'name': nombre del módulo
            'section': número de sección
            'startdate': fecha de inicio
            'enddate': fecha de cierre
    ]
}

Fallo

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 1,
    "message": "Course not found",
    "body": []
}

Error producido si el tipo de curso es incorrecto

{
    "status": 404,
    "code": 2,
    "message": "Incorrect course type",
    "body": []
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 3,
    "message": "Group not found",
    "body": []
}

8. Obtener la información de los examenes de un grupo.

- local_contentdata_get_group_quizzes_info

Descripción:
Servicio para obtener la información de los examenes de un grupo.

Endpoint: local_contentdata_get_group_quizzes_info
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_get_group_quizzes_info
• courseid: int | id de curso
• groupid: int | id de grupo

Respuestas:

Éxito

Se actualizó el módulo

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'quiztypeid': id del tipo de exámen
        'quizcategoryid': id de la categoría del exámen
        'quizid': id del exámen
        'name': nombre del exámen
        'assigneduserid': id de usuario asignado (solo examenes extraordinarios)
        'assignedusername': nombre de usuario asignado (solo examenes extraordinarios)
        'assigneduseremail': correo electronico de usuario asignado (solo examenes extraordinarios)
        'section': número de sección
        'startdate': fecha de inicio
        'enddate': fecha de cierre
    ]
}

Fallo

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 1,
    "message": "Course not found",
    "body": []
}

Error producido si el tipo de curso es incorrecto

{
    "status": 404,
    "code": 2,
    "message": "Incorrect course type",
    "body": []
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 3,
    "message": "Group not found",
    "body": []
}

9. Obtener la información de los foros de un grupo.

- local_contentdata_get_group_forums_info

Descripción:
Servicio para obtener la información de los foros de un grupo.

Endpoint: local_contentdata_get_group_forums_info
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_get_group_forums_info
• courseid: int | id de curso
• groupid: int | id de grupo

Respuestas:

Éxito

Se actualizó el módulo

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'quizid': id del exámen
        'name': nombre del exámen
        'associatedteam': nombre de usuario asignado
        'fileurl': correo electronico de usuario asignado
        'section': número de sección
        'startdate': fecha de inicio
        'enddate': fecha de cierre
    ]
}

Fallo

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 1,
    "message": "Course not found",
    "body": []
}

Error producido si el tipo de curso es incorrecto

{
    "status": 404,
    "code": 2,
    "message": "Incorrect course type",
    "body": []
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 3,
    "message": "Group not found",
    "body": []
}

10. Obtener las restricciones para un usuario.

- local_contentdata_get_group_user_restrictions

Descripción:
Servicio para obtener las restricciones para un usuario.

Endpoint: local_contentdata_get_group_user_restrictions
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_get_group_user_restrictions
• courseid: int | id de curso
• groupid: int | id de grupo
• userid: int | id de usuario

Respuestas:

Éxito

Se obtuvo la restricción

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'id' : ID de restricción
        'title' : Título de la restricción
        'status' : Estatus de la restricción
        'mandatory'  : Bandera para saber si la restricción es obligatoria
        'description' : Descripción de la restricción
        'endpoint' : Formulario endpoint/api
        'form' : [
            'id' : ID del formulario
            'label' : Etiqueta del campo
            'type' : Tipo
            'hidden' : Bandera para saber si el campo está oculto
        ]
    ]
}

Fallo

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 1,
    "message": "Course not found",
    "body": []
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 2,
    "message": "Group not found",
    "body": []
}

11. Dar acceso a una promoción a un usuario que no es estudiante.

- local_contentdata_assign_group_access

Descripción:
Servicio para dar acceso a una promoción a un usuario que no es estudiante.

Endpoint: local_contentdata_assign_group_access
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_assign_group_access
• usertoken: string | token del usuario
• courseid: int | id de curso
• groupid: int | id de grupo
• userid: int | id de usuario

Respuestas:

Éxito

Se dio el acceso

{
    "status": 200,
    "code": 0,
    "message": ""
}

Fallo

Error producido si el usuario no tiene permiso de dar acceso a otros usuarios

{
    "status": 404,
    "code": 1,
    "message": "Permission denied",
    "body": []
}

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 2,
    "message": "Course not found",
    "body": []
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 3,
    "message": "Group not found",
    "body": []
}

12. Retirar el acceso a una promoción a un usuario que no es estudiante.

- local_contentdata_remove_group_access

Descripción:
Servicio para retirar el acceso a una promoción a un usuario que no es estudiante.

Endpoint: local_contentdata_remove_group_access
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_remove_group_access
• usertoken: string | token del usuario
• courseid: int | id de curso
• groupid: int | id de grupo
• userid: int | id de usuario

Respuestas:

Éxito

Se retiró el acceso

{
    "status": 200,
    "code": 0,
    "message": ""
}

Fallo

Error producido si el usuario no tiene permiso de retirar acceso a otros usuarios

{
    "status": 404,
    "code": 1,
    "message": "Permission denied",
    "body": []
}

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 2,
    "message": "Course not found",
    "body": []
}

Error producido si no se encontró el grupo

{
    "status": 404,
    "code": 3,
    "message": "Group not found",
    "body": []
}

13. Asignar una actividad extraordinaria a un alumno.

- local_contentdata_add_user_to_extraordinary_activity

Descripción:
Servicio para asignar una actividad extraordinaria a un alumno.

Endpoint: local_contentdata_add_user_to_extraordinary_activity
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_add_user_to_extraordinary_activity
• usertoken: string | token del usuario
• courseid: int | ID de curso
• groupid: int | ID de grupo
• userids: string | ID’s de usuarios separados por ”,”
• cmid: int | ID de la actividad (cmid)
• starttime: raw | Fecha de inicio en timestamp
• endtime: raw | Fecha de cierre en timestamp
• deadline: raw | Fecha limite en timestamp (Opcional para actividades que usan una fecha limite)
• teamid: int | ID de equipo (Opcional solo para actividades de TFM)

Respuestas:

Éxito

Se asigno correctamente al alumno

{
    "status": 200,
    "code": 0,
    "message": ""
}

Fallo

Error producido si el usuario no tiene permiso de asignar usuarios a actividades extraordinarias

{
    "status": 404,
    "code": 1,
    "message": "Permission denied",
    "body": []
}

Error producido si no se encuentró el curso

{
    "status": 404,
    "code": 2,
    "message": "Course not found",
    "body": []
}

Error producido si no se encontró la actividad

{
    "status": 404,
    "code": 3,
    "message": "Group not found",
    "body": []
}

14. Eliminar una asignación extraordinaria a un alumno.

- local_contentdata_delete_user_to_extraordinary_activity

Descripción:
Servicio para eliminar una asignación extraordinaria a un alumno.

Endpoint: local_contentdata_delete_user_to_extraordinary_activity
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_delete_user_to_extraordinary_activity
• usertoken: string | token del usuario
• userid: string | ID’s de usuarios separados por ”,”
• cmid: int | ID de la actividad (cmid)
• extraordinarydateid: int | ID de la asignación extraordinaria
• teamid: int | ID de equipo (Opcional solo para actividades de TFM)

Respuestas:

Éxito

Se elimino la asignación correctamente al alumno

{
    "status": 200,
    "code": 0,
    "message": ""
}

Fallo

Error producido si el usuario no tiene permiso de asignar usuarios a actividades extraordinarias

{
    "status": 404,
    "code": 1,
    "message": "Permission denied",
    "body": []
}

Error producido si no se encontró la actividad

{
    "status": 404,
    "code": 3,
    "message": "Activity not found",
    "body": []
}

Error producido si no se encontró la asignación

{
    "status": 404,
    "code": 4,
    "message": "Date not found",
    "body": []
}