Grades

1. Obtener el las calificaciones generales.

- local_contentdata_get_general_grades

Descripción:
Servicio para obtener el las calificaciones generales del curso o de la promoción.

Endpoint: local_contentdata_get_general_grades
Método: GET
Argumentos:

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

Respuestas:

Éxito

Se obtienen las calificaciones

{
    "status": 200,
    "code": 0,
    "message": "",
    "body":
        "categories":
            'itemid': id de item,
            'itemtype': tipo de item,
            'name': nombre de la actividad,
            'parentid': id de la categoria padre,
            'gradetype': tipo de calificación,
            'gradepass': calificación para aprobar,
            'grademin': calificación mínima,
            'grademax': calificación máxima,
            'display': mostrar calificación,
            'decimals': cantidad de decimales
            'aggregationcoef2': porcentaje de la calificacion total del curso
        "grades":
            'userid': id de usuario,
            'firstname': nombre de usuario,
            'lastname': apellido de usuario,
            'status': estado del usuario,
            'email': correo electronico del usuario,
            'progress': progreso del usuario en el curso,
            'finalgrade': calificación final del curso,
            'grades':
                'categoryid': id de la categoría,
                'fullname': nombre de la categoría,
                'gradeitemid': id del la calificación,
                'finalgrade': calificación de la categoría,
}

Fallo

Error producido si no se encuentró el curso

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

Error producido si el curso es master y no se agregó el parametro groupid

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

Error producido si no se encontró el grupo

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

2. Obtener el las calificaciones de los examenes por bloque.

- local_contentdata_get_users_quizzes_grades_by_block

Descripción:
Servicio para obtener el las calificaciones de los examenes por bloque.

Endpoint: local_contentdata_get_users_quizzes_grades_by_block
Método: GET
Argumentos:

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

Respuestas:

Éxito

Se obtienen las calificaciones

{
    "status": 200,
    "code": 0,
    "message": "",
    "body":
        "quizzes":
            'quizid': id de examen,
            'quizcategory': id de la categoría del examen,
            'name': nombre del examen,
            'calls': (llamadas para examenes extraordinarios)
                'call': id de la llamada de extraordinario,
                'parent': id del examen padre,
                'name': nombre del examen
        "users":
            'userid': id de usuario,
            'firstname': nombre de usuario,
            'lastname': apellido de usuario,
            'email': correo electronico del usuario,
            'course': id de curso,
            'group': id de grupo,
            'grades':
                'gradeitemid': id de la calificación,
                'quizid': id del examen,
                'quizcategory': id de categoría del examen,
                'name': nombre del examen,
                'finalgrade': calificación final del examen,
                'extraordinarygrades': (calificaciones si tiene examenes extraordinarios)
                    'gradeitemid': id de examen extraordinario,
                    'quizid': id de examen,
                    'quizcategory': id de categoría del examen,
}

Fallo

Error producido si no se encuentró el curso

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

Error producido si el curso es master y no se agregó el parametro groupid

{
    "status": 404,
    "code": 2,
    "message": "Required group id",
    "body": []
}

Error producido si no se encontró el grupo

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

Error producido si no se encontró el bloque

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

3. Obtener el las calificaciones de los foros por bloque.

- local_contentdata_get_users_forums_grades_by_block

Descripción:
Servicio para obtener el las calificaciones de los foros por bloque.

Endpoint: local_contentdata_get_users_forums_grades_by_block
Método: GET
Argumentos:

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

Respuestas:

Éxito

Se obtienen las calificaciones

{
    "status": 200,
    "code": 0,
    "message": "",
    "body":
        "forums":
            'forumid': id de foro,
            'name': nombre del foro
        "users":
            'userid': id de usuario,
            'firstname': nombre de usuario,
            'lastname': apellido de usuario,
            'email': correo electronico del usuario,
            'course': id de curso,
            'group': id de grupo,
            'averagegrade': calificacion promedio
            'grades':
                'gradeitemid': id de la calificación,
                'forumid': id del foro,
                'name': nombre del foro,
                'finalgrade': calificación final del foro,
                'participation': bandera para saber si participó en el foro (1 -> si, 0 -> no),
}

Fallo

Error producido si no se encuentró el curso

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

Error producido si el curso es master y no se agregó el parametro groupid

{
    "status": 404,
    "code": 2,
    "message": "Required group id",
    "body": []
}

Error producido si no se encontró el grupo

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

Error producido si no se encontró el bloque

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

4. Cambiar la calificación de una actividad a un usuario.

- local_contentdata_update_user_grade

Descripción:
Servicio para cambiar la calificación de una actividad a un usuario.

Endpoint: local_contentdata_update_user_grade
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_update_user_grade
• courseid: int | id de curso
• groupid: int | id de grupo
• userid: int | id de usuario
• itemid: int | id de item
• grade: int | nueva calificación

Respuestas:

Éxito

Se actualizó la calificación

{
    "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 curso es master y no se agregó el parametro groupid

{
    "status": 404,
    "code": 2,
    "message": "Required group id"
}

Error producido si no se encontró el grupo

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

Error producido si no se encontró el item

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

Error producido si la calificación es inferior a la nota minima o mayor a la nota máxima

{
    "status": 404,
    "code": 5,
    "message": "Incorrect grade"
}

5. Obtener un reporte de progreso.

- local_contentdata_progress_report

Descripción:
Servicio para obtener un reporte de progreso.

Endpoint: local_contentdata_progress_report
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_progress_report
• courseid: int | id de curso
• groupid: int | id de grupo
• includegrades: int | Indicador para incluir calificaciones (1->Si, 0->No, es opcional, por defecto es 0)

Respuestas:

Éxito

Se actualizó la calificación

{
    "status": 200,
    "code": 0,
    "message": "",
    "body":[
        'userid' : ID del usuario
        'name' : Nombre del usuario
        'email' : Email del usuario
        'dni' : DNI del usuario
        'phone' : Teléfono del usuario
        'firstconexion' : Primera conexión del usuario
        'lastconexion' : Última conexión del usuario
        'viewedcontent' : Número de contenidos vistos
        'totalcontents' : Total de contenidos del curso
        'currentsection' : Módulo en el que se encuentra el usuario
        'timeleft' : Días transcurridos del curso
        'grades'[
            'categoryid' : ID de la categoría
            'fullname' : Nombre de la categoría
            'gradeitemid' : ID del item calificable
            'finalgrade' : Calificación final
        ]

    ]
}

Fallo

Error producido si no se encuentró el curso

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

Error producido si el curso es master y no se agregó el parametro groupid

{
    "status": 404,
    "code": 2,
    "message": "Required group id",
    "body":[]
}

Error producido si no se encontró el grupo

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

6. Obtener las calificaciones del TFM.

- local_contentdata_get_users_tfm_grades

Descripción:
Servicio para obtener las calificaciones del TFM.

Endpoint: local_contentdata_get_users_tfm_grades
Método: GET
Argumentos:

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

Respuestas:

Éxito

Se actualizó la calificación

{
    "status": 200,
    "code": 0,
    "message": "",
    "body":[
        'activities'[
            'cmid' : ID de actividad
            'name' : Nombre de la actividad
        ]
        'users':[
            'userid' : ID del usuario
            'firstname' : Nombre del usuario
            'lastname' : Nombre del usuario
            'email' : Email del usuario
            'course' : Nombre del curso
            'group' : Promoción
            'averagegrade' : Calificación promedio
            'grades' : [
                'categoryid' : ID de la categoría
                'fullname' : Nombre de la categoría
                'gradeitemid' : ID del item calificable
                'finalgrade' : Calificación final
            ]
        ]
    ]
}

Fallo

Error producido si no se encuentró el curso

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

Error producido si el curso es master y no se agregó el parametro groupid

{
    "status": 404,
    "code": 2,
    "message": "Required group id",
    "body":[]
}

Error producido si no se encontró el grupo

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

Error producido si no se encontró el TFM en el grupo

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

Error producido si el TFM no cuenta con actividades

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

7. Obtener el las calificaciones de los casos por bloque.

- local_contentdata_get_users_casos_grades_by_block

Descripción:
Servicio para obtener el las calificaciones de los casos por bloque.

Endpoint: local_contentdata_get_users_casos_grades_by_block
Método: GET
Argumentos:

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

Respuestas:

Éxito

Se obtienen las calificaciones

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        "casos": [
            'casoid': id del caso,
            'name': nombre del caso
        ]
        "users": [
            'userid': id de usuario,
            'firstname': nombre de usuario,
            'lastname': apellido de usuario,
            'email': correo electronico del usuario,
            'course': id de curso,
            'group': id de grupo,
            'grades':
                'gradeitemid': id de la calificación,
                'casoid': id del caso,
                'name': nombre del caso,
                'finalgrade': calificación final del caso,
        ]
    ]
}

Fallo

Error producido si no se encuentró el curso

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

Error producido si el curso es master y no se agregó el parametro groupid

{
    "status": 404,
    "code": 2,
    "message": "Required group id",
    "body": []
}

Error producido si no se encontró el grupo

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

Error producido si no se encontró el bloque

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