Actas services

1. Crear acta.

- local_contentdata_create_acta

Descripción:
Servicio para crear una plantilla para actas.
Endpoint: local_contentdata_create_acta
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_create_acta
• courseid: int | Id de curso
• title: string | Nombre de la plantilla
• description: string | Descripción de la plantilla (opcional)
• university_title: string | Nombre para la universidad
• course_period: string | Periodo del curso
• teaching_title: string | Título para la columna de profesores
• credits_remaining: string | Creditos restantes
• credits_exceeded: string | Creditos aprobados
• tfm_period: string | Periodo de TFM (Opcional)
• logo: string | Logo
• signature: string | Firmante
• acta_type: int | Tipo de acta (1->simple, 2->por bloques)

Respuestas:

Éxito

Se creó la plantilla

{
    "status": 200,
    "code": 0,
    "message": "",
    "body":
        'templateid': id del acta,
        'acta_details_id': id de los detalles del acta,
}

Fallo

Error producido si no se encuentró el curso

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

2. Ver información de platilla de acta.

- local_contentdata_get_acta_template

Descripción:
Servicio para obtener la información de una plantilla de acta
Endpoint: local_contentdata_get_acta_template
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_get_acta_template
• courseid: int | Id de curso
• templateid: int | Id de la plantilla

Respuestas:

Éxito

Se obtiene la información

{
    "status": 200,
    "code": 0,
    "message": "",
    "body":
        'templateid': id del template,
        'title': nombre del template,
        'description': descripción del template,
        "details":
            'acta_details_id': id de los detalles,
            'university_title': nombre para la universidad,
            'course_period': periodo del curso,
            'teaching_title': título para la columna de profesores,
            'credits_remaining': creditos restantes,
            'credits_exceeded': creditos aprobados,
            'tfm_period': periodo de TFM,
            'logo': logo,
            'signature': firmante,
            'acta_type': tipo de acta
        "blocks":
            'blockid': id de bloque,
            'block_name': nombre del bloque,
            'period': periodo del bloque,
            "modules":
                'actasectionid': id del registro del módulo en el acta,
                'sectionid': id del módulo en moodle,
                'order': orden del módulo en el curso,
                'title': nombre del módulo en el curso,
                'personal_title': nombre visible en el acta,
                'period': periodo del módulo en el acta,
                'teachers': profesores del módulo
}

Fallo

Error producido si no se encuentró el curso

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

Error producido si no se encuentró el template

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

3. Actualizar la información del acta.

- local_contentdata_update_acta_template

Descripción:
Servicio para actualizar la información del acta.
Endpoint: local_contentdata_update_acta_template
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_update_acta_template
• templateid: int | Id del template
• title: string | Nombre de la plantilla
• description: string | Descripción de la plantilla (opcional)
• university_title: string | Nombre para la universidad
• course_period: string | Periodo del curso
• teaching_title: string | Título para la columna de profesores
• credits_remaining: string | Creditos restantes
• credits_exceeded: string | Creditos aprobados
• tfm_period: string | Periodo de TFM (Opcional)
• logo: string | Logo
• signature: string | Firmante
• acta_type: int | Tipo de acta (1->simple, 2->por bloques)

Respuestas:

Éxito

Se actualizó la plantilla

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

Fallo

Error producido si no se encuentró la plantilla

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

4. eliminar una plantilla de acta.

- local_contentdata_delete_acta_template

Descripción:
Servicio para eliminar una acta.
Endpoint: local_contentdata_delete_acta_template
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_delete_acta_template
• templateid: int | Id del template

Respuestas:

Éxito

Se eliminó el acta

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

Fallo

Error producido si no se encuentró el acta

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

5. Crear un bloque de módulos en el acta.

- local_contentdata_create_acta_block

Descripción:
Servicio para crear un bloque de módulos en el acta.
Endpoint: local_contentdata_create_acta_block
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_create_acta_block
• acta_details_id: int | Id de los detalles del acta
• block_name: string | Nombre del bloque
• period: string | Periodo del bloque en el acta

Respuestas:

Éxito

Se creó el bloque

{
    "status": 200,
    "code": 0,
    "message": "",
    "body":
        'blockid': id del bloque creado
}

Fallo

Error producido si no se encuentró los detalles del acta

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

6. Actualizar un bloque de módulos en el acta.

- local_contentdata_update_acta_block

Descripción:
Servicio para actualizar un bloque de módulos en el acta.
Endpoint: local_contentdata_update_acta_block
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_update_acta_block
• blockid: int | Id del bloque
• block_name: string | Nombre del bloque (opcional)
• period: string | Periodo del bloque en el acta (opcional)

Respuestas:

Éxito

Se actualizó el bloque

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

Fallo

Error producido si no se encuentró el bloque

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

7. Eliminar un bloque de módulos en el acta.

- local_contentdata_delete_acta_block

Descripción:
Servicio para eliminar un bloque de módulos en el acta.
Endpoint: local_contentdata_delete_acta_block
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_delete_acta_block
• blockid: int | Id del bloque

Respuestas:

Éxito

Se eliminó el bloque

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

Fallo

Error producido si no se encuentró el bloque

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

8. Asignar un módulo del curso en el acta.

- local_contentdata_assign_section_to_acta

Descripción:
Servicio para asignar un módulo del curso en el acta.
Endpoint: local_contentdata_assign_section_to_acta
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_assign_section_to_acta
• sectionid: int | Id’s de módulos (section) del curso separados por ”,”
• blockid: int | Id del bloque

Respuestas:

Éxito

Se agregó el módulo al bloque

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

Fallo

Error producido si no se encuentró el módulo del curso

{
    "status": 404,
    "code": 1,
    "message": "Section not found",
    "body":
        'actasectionid': id del módulo en el acta
        'sectionid': id del módulo en moodle
}

Error producido si no se encuentró el bloque

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

9. Actualizar los datos de un módulo del curso en el acta.

- local_contentdata_update_acta_section

Descripción:
Servicio para actualizar los datos de un módulo del curso en el acta.
Endpoint: local_contentdata_update_acta_section
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_update_acta_section
• actasectionid: int | Id del módulo en el acta
• personal_title: string | Nombre del módulo para mostrar en el acta (opcional)
• period: string | Periodo del módulo en el acta (opcional)
• teachers: string | Profesores asignados al módulo en el acta, separados por ”,” (opcional)

Respuestas:

Éxito

Se actualizó el módulo en el acta

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

Fallo

Error producido si no se encuentró el módulo en el acta

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

10. Eliminar un módulo del acta.

- local_contentdata_delete_acta_section

Descripción:
Servicio para eliminar un módulo del acta.
Endpoint: local_contentdata_delete_acta_section
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_delete_acta_section
• actasectionid: int | Id del módulo en el acta

Respuestas:

Éxito

Se eliminó el módulo del bloque

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

Fallo

Error producido si no se encuentró el módulo en el acta

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

11. Obtener la lista de plantillas en un curso.

- local_contentdata_get_course_actas_templates

Descripción:
Servicio para obtener la lista de plantillas de acta de un curso.
Endpoint: local_contentdata_get_course_actas_templates
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_get_course_actas_templates
• courseid: int | Id del curso

Respuestas:

Éxito

Se encontraron los templates

{
    "status": 200,
    "code": 0,
    "message": "",
    "body":
        'templateid': id del template,
        'title': nombre del template,
        'description': descripción del template
}

Fallo

Error producido si no se encuentró el curso

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

12. Generar una o varias actas.

- local_contentdata_generate_user_acta

Descripción:
Servicio para generar una o varias actas.
Endpoint: local_contentdata_generate_user_acta
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_generate_user_acta
• usersid: string | Id de usuarios separados por coma
• courseid: int | Id de curso
• groupid: int | Id de grupo
• templateid: int | Id del template de el acta
• lang: string | Idioma del acta
• test: int | Bandera para generar una acta de prueba (opcional)

Respuestas:

Éxito

Se generaron las actas

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": array |
        'userid': id del usuario,
        'url': url del acta,
}

Fallo

Error producido si no se encuentró el curso

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

Error producido si no se encuentró el grupo

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

Error producido si no se encuentró el template del acta

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

13. Obtener la lista de actas de usuarios.

- local_contentdata_get_users_actas

Descripción:
Servicio para obtener la lista de actas de usuarios.
Endpoint: local_contentdata_get_users_actas
Método: GET
Argumentos:

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

Respuestas:

Éxito

Se generaron las actas

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": array |
        'actaid': id del acta,
        'userid': id del usuario,
        'name': nombre del usuario,
        'url': url del acta
}

Fallo

Error producido si no se encuentró el curso

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

14. Eliminar actas de alumnos.

- local_contentdata_delete_user_acta

Descripción:
Servicio para eliminar actas.
Endpoint: local_contentdata_delete_user_acta
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_delete_user_acta
• actasid: string | Id’s de actas separadas por ”,”

Respuestas:

Éxito

Se eliminaron las actas

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

15. Enviar actas por correo electronico.

- local_contentdata_send_acta

Descripción:
Servicio para enviar actas por correo electronico.
Endpoint: local_contentdata_send_acta
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_send_acta
• usersactasids: string | Id’s de actas separadas por ”,”
• email: string | email destino

Respuestas:

Éxito

Se enviaron las actas al correo definido

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

Fallo

Error producido si no enviaron las actas

{
    "status": 400,
    "code": 1,
    "message": "email not found",
    "body": []
}

16. Descargar una o varias actas.

- local_contentdata_download_acta

Descripción:
Servicio para descargar una o varias actas.
Endpoint: local_contentdata_download_acta
Método: GET
Argumentos:

• wstoken: string | token de Manager
• moodlewsrestformat: json | formato de la respuesta
• wsfunction: string | local_contentdata_download_acta
• usersactasids: string | Id’s de actas separadas por ”,”

Respuestas:

Éxito

Se descargaron correctamente las actas

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": url de aws para descargar archivo zip
}