Skip to content
Alebat

Forum services

Servicios relacionados a los foros de los cursos.

1. Crear foro.

- local_contentdata_create_course_forum

Descripción:
Servicio para crear foros.

Endpoint: local_contentdata_create_course_forum
Método: GET
Argumentos:

  • wstoken: string | token de Manager
  • moodlewsrestformat: json | formato de la respuesta
  • wsfunction: string | local_contentdata_create_course_forum
  • usertoken: string | token del usuario
  • courseid: int | id de curso
  • sectionnum: int | numero de sección
  • name: string | nombre del foro
  • speaker: string | nombre del exponente
  • description: string | descripcion del foro
  • files: file | archivos para subir al foro

Respuestas:

Se creó el foro

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'id': id del foro,
        'name': nombre del foro
    ]
}

2. Actualizar un foro.

- local_contentdata_update_course_forum

Descripción:
Servicio para actualizar un foro.

Endpoint: local_contentdata_update_course_forum
Método: GET
Argumentos:

  • wstoken: string | token de Manager
  • moodlewsrestformat: json | formato de la respuesta
  • wsfunction: string | local_contentdata_update_course_forum
  • usertoken: string | token del usuario
  • courseid: int | id de curso
  • activityid: int | id de la actividad (cmid)
  • name: string | nombre del foro
  • speaker: string | nombre del exponente
  • description: string | descripcion del foro
  • files: file | archivos para subir al foro

Respuestas:

Se actualizó el foro

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'id': id del foro,
        'name': nombre del foro,
        'files': [
            'url': URL del archivo
        ]
    ]
}

3. Eliminar foros del curso o de una promoción.

- local_contentdata_delete_course_forum

Descripción:
Servicio para eliminar foros del curso o de una promoción.

Endpoint: local_contentdata_delete_course_forum
Método: GET
Argumentos:

  • wstoken: string | token de Manager
  • moodlewsrestformat: json | formato de la respuesta
  • wsfunction: string | local_contentdata_delete_course_forum
  • usertoken: string | token del usuario
  • courseid: int | id de curso
  • sectionnum: int | numero de sección
  • activityid: int | id de la actividad (cmid)
  • groupid: string | id’s de grupo separados por coma ’,’ (Opcional, se usa si se desea borrar el foro de una o varias promociones)

Respuestas:

Se eliminó el foro correctamente.

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'id': id del foro,
        'name': nombre del foro
    ]
}

4. Obtener los foros del curso.

- local_contentdata_get_course_forum

Descripción:
Servicio para obtener los foros del curso.

Endpoint: local_contentdata_get_course_forum
Método: GET
Argumentos:

  • wstoken: string | token de Manager
  • moodlewsrestformat: json | formato de la respuesta
  • wsfunction: string | local_contentdata_get_course_forum
  • courseid: int | id de curso
  • activityid: int | id de la actividad (cmid)

Respuestas:

Se obtuvieron los foros del curso

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'id': id del foro,
        'name': nombre del foro,
        'description': descripcion del foro,
        'speaker': exponente del foro,
        'files': [
            'url': URL del archivo
        ]
    ]
}

5. Ver comentarios de un foro.

- local_contentdata_get_forum_discussion

Descripción:
Servicio para ver los comentarios de un foro.

Endpoint: local_contentdata_get_forum_discussion
Método: GET
Argumentos:

  • wstoken: string | token de Manager
  • moodlewsrestformat: json | formato de la respuesta
  • wsfunction: string | local_contentdata_get_forum_discussion
  • usertoken: string | token del usuario que realiza la petición
  • courseid: int | id de curso
  • groupid: int | id de grupo
  • cmid: int | id de la actividad

Respuestas:

Se obtuvieron los foros del curso

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'cmid': ID de la actividad (cmid)
        'forumid': ID del foro
        'itemid': ID del item calificable
        'title': Nombre del foro
        'description': Descripción del foro
        'speaker' : Autor del foro
        'files' [
            'url' : URL del archivo
            ]
        'forumstartdate': Fecha de inicio
        'forumenddate': Fecha de cierre
        'grademax' : Calificación máxima
        'grademin' : Calificación mínima
        'comments'[
            'commentid' : ID de comentario
            'user' [
                'id' : ID de usuario que realizó el comentario
                'fullname' : Nombre del usuario
                'isPublicAccount' : Bandera para identificar cuenta publica (1->true, 0->false)
                'picture': URL de foto del usuario
            ]
            'message' : Comentario del usuario
            'date' : Fecha del comentario
            'reply' [
                'commentid' : ID de usuario que responde al comentario
                'parentid' : ID del comentario al que responde
                'user'[
                    'id' : ID de usuario que realizó el comentario
                    'fullname' : Nombre del usuario
                    'isPublicAccount' : Bandera para identificar cuenta publica (1->true, 0->false)
                    'picture': URL de foto del usuario
                ]
                'message' : Comentario del usuario
                'date' : Fecha del comentario
            ]
        ]
        'grades'[
            'userid' : ID de usuario
            'grade' : Calificación del usuario en el foro
        ]
    ]
}