Servicio web: Grupos

Modificado el Vie, 18 Oct a 2:49 P. M.

Introducción

Este servicio web sirve para conocer detalles sobre los procesos formativos que se estén llevando a cabo.

De esta forma puedes llevar esta información a otros sistemas como por ejemplo una tienda WooCommerce o un CRM.

Proceso de consumo

Se utiliza el protocolo de comunicación HTTP.

Los pasos serían:

Autenticarte
1. Se requiere autenticación HTTP mediante los datos de acceso de un usuario de Gesforma con perfil de coordinador (loginname y contraseña).
2. Para aumentar la seguridad en el consumo del servicio aconsejamos activar el token API de tu cuenta (más info)
Consumir el servicio (debes solicitarnos que te proporcionemos la URL)
Solicitud: se envía en formato JSON
Respuesta: se recibe una respuesta en formato JSON.

Solicitud

Usa notación JSON con la siguiente estructura. A tener en cuenta:

Los elementos pagina y numero_elementos_por_pagina son obligatorios para responder a la solicitud con éxito.
Al enviar en la petición un id_curso, en la respuesta solo se devuelve información relativa a los grupos vinculados a ese curso.
Al enviar en la petición un id_grupo, en la respuesta solo se devuelve información relativa a ese grupo.

Campo	Descripción	Tipo de Dato	Valores Esperados
pagina	Número de página para la consulta. Al inicio es 1, pero si los datos ocupan más de una página poder repetir la llamada con las siguientes paginas 2, 3, 4….	Entero (integer)	Valor entero positivo (ej. 1, 2, 3)
numero_elementos_por_pagina	Cantidad de elementos por página	Entero (integer)	Valor entero positivo (ej. 10, 20)
id_curso	Identificador del curso	Entero (int)	Número entero positivo
id_grupo	Identificador del grupo	Entero (int)	Número entero positivo
convocatoria_tipo_curso	Tipo de curso (opcional)	Texto (string)	"subvencionados", "privados", "bonificables"
grupo_abierto	Indicador de grupos abiertos (opcional). El valor se calcula en función del campo publico_en_web.	Booleano	0 (falso), 1 (verdadero)
grupo_fecha_fin_rebasada	Indicador de fecha fin rebasada (opcional)	Booleano	0 (falso), 1 (verdadero)
grupo_con_precio	Indicador de grupos con precio (opcional)	Booleano	0 (falso), 1 (verdadero)

Ejemplo

{pagina: "1", numero_elementos_por_pagina: 10, convocatoria_tipo_curso: "subvencionados", grupo_abierto: 0, grupo_fecha_fin_rebasada: 0, grupo_con_precio: 1}

Respuesta

Usa notación JSON con la siguiente estructura.

Campo	Descripción	Tipo de Dato	Valor Esperado
success	Indica el resultado de la operación de autenticación	Entero	1 (si éxito), 0 (si error)
numero_elementos_totales	Indica el número de elementos totales (es decir, el número total de grupos)	Entero (integer)	Número entero positivo
numero_paginas_totales	Indica el número total de páginas	Entero (integer)	Número entero positivo
fecha	Indica la fecha y hora de generación de los datos	Fecha y Hora (datetime)	Formato de fecha y hora válido
grupos	Todos los datos referentes a los grupos	Objeto de datos	Dependerá de la estructura de datos del grupo

Donde Grupo es un objeto compuesto por estos elementos: ver

Ejemplo

{success: 1, numero_elementos_totales: 2, numero_paginas_totales: 0, fecha: "2023-10-03 23:19:19", grupos: '[{"id_grupo":"160881","codigo_grupo":"1","codigo_aaff":"0556","denominacion":"INGLES 40 HORAS","horas":"40","fecha_inicio":"06/03/2023","fecha_fin":"17/03/2023","modalidad":"teleformación","estado":"concluido","publico_en_web":"0","fecha_fin_publicacion":null,"matriculacion_directa":"no","id_plan_formacion":"103","nombre_plan_formacion":"PROGRAMAS 2022","id_convocatoria":"43","nombre_convocatoria":"PROGRAMAS 2022","formulario_convocatoria":"","cif_centro_formacion_presencial":"","nombre_centro_formacion_presencial":"","telefono_centro_formacion_presencial":"","domicilio_centro_formacion_presencial":"","cp_centro_formacion_presencial":"","poblacion_centro_formacion_presencial":"","provincia_centro_formacion_presencial":"","cif_centro_imparticion":"","nombre_centro_imparticion":"","telefono_centro_imparticion":"","domicilio_centro_imparticion":"","cp_centro_imparticion":"","poblacion_centro_imparticion":"","provincia_centro_imparticion":"","medio_aula_virtual":"","conexion_aula_virtual":"","contacto_aula_virtual":"","telefono_aula_virtual":"","bimodal":"no","tutores":"[{"id_usuario":"23998","nif":"00000001R","nombre":"RAMIRO","apellido1":"SOLIS","apellido2":"FEZ"}]","sesiones":"[]","etiquetas":"[]","empresas_participantes":"{"0":{"id_empresa":"68794","cif":"B76039759","nombre":"Producciones Isleu00f1as"},"2":{"id_empresa":"5851","cif":"37328534V","nombre":"G P Productos Ibericos"}}","participantes":"[{"id_matricula":"806688","precio":"300.00","id_usuario":"166904","nif":"52149894q","nombre":"Lola","apellido1":"Garcu00eda","apellido2":"Suu00e1rez"},{"id_matricula":"806689","precio":"300.00","id_usuario":"603696","nif":"29172137H","nombre":"Luis","apellido1":"CANDELA","apellido2":"HERNANDEZ"}]"},{"id_grupo":"163608","codigo_grupo":"1","codigo_aaff":"0557","denominacion":"INGLES 40 HORAS","horas":"20","fecha_inicio":"24/04/2023","fecha_fin":"06/05/2024","modalidad":"teleformación","estado":"activo","publico_en_web":"0","fecha_fin_publicacion":null,"matriculacion_directa":"no","id_plan_formacion":"103","nombre_plan_formacion":"PROGRAMAS 2022","id_convocatoria":"43","nombre_convocatoria":"PROGRAMAS 2022","formulario_convocatoria":"","cif_centro_formacion_presencial":"","nombre_centro_formacion_presencial":"","telefono_centro_formacion_presencial":"","domicilio_centro_formacion_presencial":"","cp_centro_formacion_presencial":"","poblacion_centro_formacion_presencial":"","provincia_centro_formacion_presencial":"","cif_centro_imparticion":"","nombre_centro_imparticion":"","telefono_centro_imparticion":"","domicilio_centro_imparticion":"","cp_centro_imparticion":"","poblacion_centro_imparticion":"","provincia_centro_imparticion":"","medio_aula_virtual":"","conexion_aula_virtual":"","contacto_aula_virtual":"","telefono_aula_virtual":"","bimodal":"no","tutores":"[{"id_usuario":"23998","nif":"00000001R","nombre":"RAMIRO","apellido1":"SOLIS","apellido2":"FEZ"}]","sesiones":"[]","etiquetas":"[]","empresas_participantes":"[{"id_empresa":"218644","cif":"B44670180","nombre":"Exportaciones"}]","participantes":"[{"id_matricula":"937206","precio":"100.00","id_usuario":"941359","nif":"07637656T","nombre":"Carlos","apellido1":"Osuna","apellido2":""}]"}