Restrictions

1. Actualizar el estado de la restricción del usuario

- local_contentdata_update_user_status_restriction

Descripción:
Servicio para actualizar el estado de la restricción para acceder a un curso que tiene un usuario.

Endpoint: local_contentdata_update_user_status_restriction
Método: POST
Argumentos:

wstoken: string | token de Manager
moodlewsrestformat: json | formato de la respuesta
wsfunction: string | local_contentdata_update_user_status_restriction
courseid: int | ID de curso
restrictiontplid: int | ID de la restricción
userid: int | ID de usuario (alumno)
newstatus: int | ID del tipo de estado
groupid: int | ID del grupo

Respuestas:

Éxito
Fallo

Se actualizó correctamente el estado de la restricción para el alumno

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

Error producido si no se encuentró el curso

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

Error producido si se trata de un curso de tipo máster y no recibe un id de grupo

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

Error producido si no se encuentró el grupo

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

Error producido si no se encuentró el estado de la restricción

{
    "status": 404,
    "code": 5,
    "message": "Status not found"
}

Error producido si no se encuentró registro del usuario para la restricción

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

2. Obtener lista de templates de restricciones en un curso

- local_contentdata_get_course_restriction_templates

Descripción:
Servicio para obtener lista de templates de restricciones en un curso.

Endpoint: local_contentdata_get_course_restriction_templates
Método: GET
Argumentos:

wstoken: string | token de Manager
moodlewsrestformat: json | formato de la respuesta
wsfunction: string | local_contentdata_get_course_restriction_templates
courseid: int | ID de curso

Respuestas:

Éxito
Fallo

Se obtuvo la información correctamente

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'id' : ID de templates
        'name' : Nombre del template
    ]
}

Error producido si no se encuentró el curso

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

3. Crear un nuevo template de restricciones

- local_contentdata_create_course_restriction_template

Descripción:
Servicio para crear un nuevo template de restricciones.

Endpoint: local_contentdata_create_course_restriction_template
Método: POST
Argumentos:

wstoken: string | token de Manager
moodlewsrestformat: json | formato de la respuesta
wsfunction: string | local_contentdata_create_course_restriction_template
usertoken: string | token del usuario
courseid: int | ID de curso
tplname: string | Nombre del template
title: string | Nombre de la restricción
mandatory: int | Indicar si la restricción es obligatoria
description: string | Descripción de la restricción
endpoint: string | Formulario del endpoint
fieldsform: string | Campos del formulario en multiple idioma

Respuestas:

Éxito
Fallo

Se correctamente la restricción

{
    "status": 200,
    "code": 0,
    "message": "",
    "body": [
        'id' : ID del template
    ]
}

Error producido si el usuario no tiene permisos para crear templates.

{
    "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": []
}

4. Eliminar un template de restricciones

- local_contentdata_delete_course_restriction

Descripción:
Servicio para eliminar un template de restricciones.

Endpoint: local_contentdata_delete_course_restriction
Método: POST
Argumentos:

wstoken: string | token de Manager
moodlewsrestformat: json | formato de la respuesta
wsfunction: string | local_contentdata_delete_course_restriction
usertoken: string | token del usuario
courseid: int | ID de curso
id: int | ID del template

Respuestas:

Éxito
Fallo

Se eliminó la restricción

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

Error producido si el usuario no tiene permisos para eliminar templates.

{
    "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 encuentró el template

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

5. Actualizar un template de restricciones

- local_contentdata_update_course_restriction_template

Descripción:
Servicio para actualizar un template de restricciones.

Endpoint: local_contentdata_update_course_restriction_template
Método: POST
Argumentos:

wstoken: string | token de Manager
moodlewsrestformat: json | formato de la respuesta
wsfunction: string | local_contentdata_update_course_restriction_template
usertoken: string | token del usuario
courseid: int | ID de curso
id: int | ID del template
title: string | Nombre de la restricción
mandatory: int | Indicar si la restricción es obligatoria
description: string | Descripción de la restricción
endpoint: string | Formulario del endpoint
fieldsform: string | Campos del formulario en multiple idioma

Respuestas:

Éxito
Fallo

Se actualizó correctamente la restricción

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

Error producido si el usuario no tiene permisos para crear templates.

{
    "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 encuentró el template

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

6. Obtener información de un template

- local_contentdata_get_restriction

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

Endpoint: local_contentdata_get_restriction
Método: GET
Argumentos:

wstoken: string | token de Manager
moodlewsrestformat: json | formato de la respuesta
wsfunction: string | local_contentdata_get_restriction
courseid: int | ID de curso
id: int | ID del template

Respuestas:

Éxito
Fallo

Se obtuvo la información de la restricción

{
    "status": 200,
    "code": 0,
    "message": "",
    "body" : [
        'id' : ID de template
        'title' : Nombre de la restricción
        'mandatory' : Indicador de envio obligatorio
        'description' : Descripción de restricción
        'endpoint' : Formulario endpoint
        'form' : [
            'id' : ID de campo
            'label' : Campo
            'type' : tipo de campo
            'hidden' : indicador de campo oculto o visible
        ]
    ]
}

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": 1,
    "message": "Template not found",
    "body" : []
}

7. Obtener información de los templates asignados a una promoción

- local_contentdata_get_group_restrictions

Descripción:
Servicio para obtener la información de los templates asignados a una promoción.

Endpoint: local_contentdata_get_group_restrictions
Método: GET
Argumentos:

wstoken: string | token de Manager
moodlewsrestformat: json | formato de la respuesta
wsfunction: string | local_contentdata_get_group_restrictions
courseid: int | ID de curso
groupid: int | ID de grupo

Respuestas:

Éxito
Fallo

Se obtuvo la información de la restricción

{
    "status": 200,
    "code": 0,
    "message": "",
    "body" : [
        'id' : ID de template
        'title' : Nombre de la restricción
        'mandatory' : Indicador de envio obligatorio
        'description' : Descripción de restricción
        'endpoint' : Formulario endpoint
        'form' : [
            'id' : ID de campo
            'label' : Campo
            'type' : tipo de campo
            'hidden' : indicador de campo oculto o visible
        ]
    ]
}

Error producido si no se encuentró el curso

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

Error producido si no se encuentró el grupo

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

8. Obtener lista de usuarios con una restricción especifica

- local_contentdata_get_users_by_restriction

Descripción:
Servicio para obtener lista de usuarios con una restricción especifica.

Endpoint: local_contentdata_get_users_by_restriction
Método: GET
Argumentos:

wstoken: string | token de Manager
moodlewsrestformat: json | formato de la respuesta
wsfunction: string | local_contentdata_get_users_by_restriction
courseid: int | ID de curso
restrictiontplid: int | ID de restricción
groupid: int | ID de grupo

Respuestas:

Éxito
Fallo

Se obtuvo la información de la restricción

{
    "status": 200,
    "code": 0,
    "message": "",
    "body" : [
        'userid' : ID de usuario
        'name' : Nombre de usuario
        'restrictiontplid' : ID de template
        'restrictionstatustype' : Tipo de restricción
        'status' : estado de restricción
    ]
}

Error producido si no se encuentró el curso

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

Error producido si no se encuentró el grupo

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

Error producido si no se encuentró el template

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

9. Obtener lista de usuarios con una restricción especifica

- local_contentdata_manage_restriction_in_groups

Descripción:
Servicio para obtener lista de usuarios con una restricción especifica.

Endpoint: local_contentdata_manage_restriction_in_groups
Método: POST
Argumentos:

wstoken: string | token de Manager
moodlewsrestformat: json | formato de la respuesta
wsfunction: string | local_contentdata_manage_restriction_in_groups
usertoken: string | token del usuario
courseid: int | ID de curso
restrictiontplid: int | ID de la restricción
groupsadd: string | ID de grupos en los que se agregara la restricción separados por coma
groupsdelete: string | ID de grupos en los que se eliminara la restricción separados por coma

Respuestas:

Éxito
Fallo

Se completo la administración

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

Error producido si el usuario no tiene permisos de administrar las restricciones

{
    "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 encuentró el grupo

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

Error producido si no se encuentró el template

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