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
Se requiere autenticación HTTP mediante los datos de acceso de un usuario de Gesforma con perfil de coordinador (loginname y contraseña). - Consumir el servicio en la URL que te hemos proporcionado.
- Solicitud: se envía en formato JSON
- Respuesta: se recibe una respuesta en formato JSON.
Solicitud
Usa notación JSON con la siguiente estructura:
(en negrita los elementos obligatorios para responder a la solicitud con éxito)
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_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}
Al enviar en la petición un id_grupo, en la respuesta solo se devuelve información relativa a ese grupo.
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 de estos elementos.
Campo | Descripción | Tipo de Dato | Valor Esperado |
---|---|---|---|
id_grupo | Identificador del grupo | Entero (int) | Número entero positivo |
codigo_grupo | Código del grupo | Texto (text) | Cadena de texto (máx. 6 caracteres) |
codigo_aaff | Código de la AAFF | Texto (text) | Cadena de texto (máx. 6 caracteres) |
denominacion | Denominación del grupo | Texto (text) | Cadena de texto (máx. 150 caracteres) |
horas | Número de horas de formación | Decimal (decimal(10,2)) | Número decimal con dos decimales |
modalidad | Modalidad de formación | Texto (text) | Teleformación | Presencial | Mixta | A distancia |
fecha_inicio | Fecha de inicio del grupo | Fecha (date) | Formato de fecha válido (por ejemplo, "YYYY-MM-DD") |
fecha_fin | Fecha de finalización del grupo | Fecha (date) | Formato de fecha válido (por ejemplo, "YYYY-MM-DD") |
publico_en_web | Indica si debe ser publicado en la web de matriculación. | Booleano | 0 (falso), 1 (verdadero) |
fecha_fin_publicacion | Fecha en la que dejar de publicarlo en la web de matriculación | Fecha (date) | Formato de fecha válido (por ejemplo, "YYYY-MM-DD") |
matriculacion_directa | Indica si el interesado se matricula directamente en el grupo o requiere validación previa | Booleano | 0 (falso), 1 (verdadero) |
estado | Estado del grupo | Texto (text) | Uno de: Planificado, Activo, Concluido |
dirigido | público al que se dirige el grupo | Texto (text) | Cadena de texto |
comentarios | comentarios privados del grupo | Texto (text) | Cadena de texto |
id_plan_formacion | Identificador del plan de formación vinculado | Entero (int) | Número entero positivo |
nombre_plan_formacion | Nombre del plan de formación vinculado | Texto (text) | Cadena de texto (máx. 150 caracteres) |
expediente_plan_formacion | expediente del plan de formación | Texto (text) | Cadena de texto |
id_eps_plan_formacion | id del EPS vinculado al plan de formación | Texto (text) | Cadena de texto |
nombre_eps_plan_formacion | Nombre del EPS del plan de formación | Texto (text) | Cadena de texto |
id_convocatoria | Identificador de la convocatoria vinculada | Entero (int) | Número entero positivo |
nombre_convocatoria | Nombre de la convocatoria vinculada | Texto (text) | Cadena de texto (máx. 150 caracteres) |
formulario_convocatoria | Texto definido en este campo del formulario de la convocatoria | Texto (text, máx. 64KB) | Cadena de texto (máx. 64KB) |
url_logo_convocatoria | Imagen de la convocatoria | Texto (text) | Cadena de texto |
formulario_anexo_convocatoria | Nombre del formulario de la convocatoria | Texto (text) | Cadena de texto |
marca_convocatoria | Nombre de la marca de la convocatoria | Texto (text) | Cadena de texto |
id_colectivo_prioritario_convocatoria | id del colectivo prioritario de la convocatoria. | Texto (text) | Cadena de texto |
nombre_colectivo_prioritario_convocatoria | Nombre del colectivo prioritario vinculado a la convocatoria. | Texto (text) | Cadena de texto |
territorio | Nombre del territorio al que se dirige la convocatoria | Texto (text) | Cadena de texto formada por el nombre de la CCAA, o Ciudad Autónoma, o la palabra "Estatal" |
convocatoria_tipo_curso | Tipo de cursos indicado en la convocatoria | Texto (text) | posibles valores: Bonificables, Privados, Subvencionados |
id_estudio | Id del estudio vinculado al curso | Texto (text) | Cadena de texto |
nombre_estudio | nombre del estudio vinculado al curso | Texto (text) | Cadena de texto |
nivel_estudio | nivel del estudio vinculado al curso | Texto (text) | Cadena de texto |
clave_estudio | clave del estudio vinculado al curso | Texto (text) | Cadena de texto |
id_area | Id del área del curso | Texto (text) | Cadena de texto |
codigo_area | código del área del curso | Texto (text) | Cadena de texto |
descripcion | descripción del curso | Texto (text) | Cadena de texto |
cif_centro_formacion_presencial | CIF del centro de formación presencial | Texto (text) | Cadena de texto |
nombre_centro_formacion_presencial | Nombre del centro de formación presencial | Texto (text) | Cadena de texto |
telefono_centro_formacion_presencial | Teléfono del centro de formación presencial | Texto (text) | Cadena de texto |
domicilio_centro_formacion_presencial | Domicilio del centro de formación presencial | Texto (text) | Cadena de texto |
cp_centro_formacion_presencial | Código postal del centro de formación presencial | Texto (text) | Cadena de texto |
poblacion_centro_formacion_presencial | Población del centro de formación presencial | Texto (text) | Cadena de texto |
provincia_centro_formacion_presencial | Provincia del centro de formación presencial | Texto (text) | Cadena de texto |
cif_centro_imparticion | CIF del centro de impartición | Texto (text) | Cadena de texto |
nombre_centro_imparticion | Nombre del centro de impartición | Texto (text) | Cadena de texto |
telefono_centro_imparticion | Teléfono del centro de impartición | Texto (text) | Cadena de texto |
domicilio_centro_imparticion | Domicilio del centro de impartición | Texto (text) | Cadena de texto |
cp_centro_imparticion | Código postal del centro de impartición | Texto (text) | Cadena de texto |
poblacion_centro_imparticion | Población del centro de impartición | Texto (text) | Cadena de texto |
provincia_centro_imparticion | Provincia del centro de impartición | Texto (text) | Cadena de texto |
medio_aula_virtual | medio aula virtual | Texto (text) | Cadena de texto |
conexion_aula_virtual | modo de conexión aula virtual | Texto (text) | Cadena de texto |
contacto_aula_virtual | contacto aula virtual | Texto (text) | Cadena de texto |
telefono_aula_virtual | teléfono aula virtual | Texto (text) | Cadena de texto |
bimodal | Indica si el grupo es bimodal | Booleano | Sí o No |
etiquetas | Nombre de las etiquetas asociadas al grupo | Array de nombres de etiquetas | Lista de cadenas de texto |
tutores | Información sobre los tutores | Array de objetos | - id_usuario, - nif, - nombre, - apellido1, - apellido2, |
empresas_participantes | Información sobre las empresas participantes en el grupo | Array de objetos | - id_empresa, - cif - nombre |
participantes | Información sobre los participantes | Array de objetos | - id_matricula - perfil_gestion - precio - id_usuario - nif - nombre, - apellido1, - apellido2 |
sesiones | Lista de fechas de sesiones | Array de fechas | Lista de fechas válidas |
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":""}]"}
¿Le ha sido útil este artículo?
¡Qué bien!
Gracias por sus comentarios
¡Sentimos mucho no haber sido de ayuda!
Gracias por sus comentarios
Sus comentarios se han enviado
Agradecemos su esfuerzo e intentaremos corregir el artículo