Servicio web: Grupos

Modificado el Mar, 2 Ene a 8:08 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:

  1. Autenticarte
    Se requiere autenticación HTTP mediante los datos de acceso de un usuario de Gesforma con perfil de coordinador (loginname y contraseña).
  2. Consumir el servicio en la URL que te hemos proporcionado.
  3. Solicitud: se envía en formato JSON
  4. 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.
CampoDescripciónTipo de DatoValores Esperados
paginaNú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_paginaCantidad de elementos por páginaEntero (integer)Valor entero positivo (ej. 10, 20)
id_cursoIdentificador del cursoEntero (int)Número entero positivo
id_grupoIdentificador del grupoEntero (int)Número entero positivo
convocatoria_tipo_cursoTipo de curso (opcional)Texto (string)"subvencionados", "privados", "bonificables"
grupo_abiertoIndicador de grupos abiertos (opcional).
El valor se calcula en función del campo publico_en_web.
Booleano0 (falso), 1 (verdadero)
grupo_fecha_fin_rebasadaIndicador de fecha fin rebasada (opcional)Booleano0 (falso), 1 (verdadero)
grupo_con_precioIndicador de grupos con precio (opcional)Booleano0 (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.

CampoDescripciónTipo de DatoValor Esperado
successIndica el resultado de la operación de autenticaciónEntero1 (si éxito), 0 (si error)
numero_elementos_totalesIndica el número de elementos totales (es decir, el número total de grupos)Entero (integer)Número entero positivo
numero_paginas_totalesIndica el número total de páginasEntero (integer)Número entero positivo
fechaIndica la fecha y hora de generación de los datosFecha y Hora (datetime)Formato de fecha y hora válido
gruposTodos los datos referentes a los gruposObjeto de datosDependerá de la estructura de datos del grupo

Donde Grupo es un objeto compuesto de estos elementos.

CampoDescripciónTipo de DatoValor Esperado
id_grupoIdentificador del grupoEntero (int)Número entero positivo
codigo_grupoCódigo del grupoTexto (text)Cadena de texto (máx. 6 caracteres)
codigo_aaffCódigo de la AAFF.Texto (text)Cadena de texto (máx. 6 caracteres)
denominacionDenominación del grupoTexto (text)Cadena de texto (máx. 150 caracteres)
horasNúmero de horas de formación total.Decimal (decimal(10,2))Número decimal con dos decimales
horas_presenciales
Número de horas de formación en modalidad presencial
Decimal (decimal(10,2))
Número decimal con dos decimales
horas_teleformacion
Número de horas de formación en modalidad teleformación
Decimal (decimal(10,2))
Número decimal con dos decimales
modalidadModalidad de formaciónTexto (text)Teleformación | Presencial | Mixta | A distancia
fecha_inicioFecha de inicio del grupoFecha (date)Formato de fecha válido (por ejemplo, "YYYY-MM-DD")
fecha_finFecha de finalización del grupoFecha (date)Formato de fecha válido (por ejemplo, "YYYY-MM-DD")
publico_en_webIndica si debe ser publicado en la web de matriculaciónBooleano0 (falso), 1 (verdadero)
fecha_fin_publicacionFecha en la que dejar de publicarlo en la web de matriculaciónFecha (date)Formato de fecha válido (por ejemplo, "YYYY-MM-DD")
matriculacion_directaIndica si el interesado se matricula directamente en el grupo o requiere validación previaBooleano0 (falso), 1 (verdadero)
estadoEstado del grupoTexto (text)Uno de: Planificado, Activo, Concluido
dirigidopúblico al que se dirige el grupoTexto (text)Cadena de texto
comentarioscomentarios privados del grupoTexto (text)Cadena de texto
id_plan_formacionIdentificador del plan de formación vinculadoEntero (int)Número entero positivo
nombre_plan_formacionNombre del plan de formación vinculadoTexto (text)Cadena de texto (máx. 150 caracteres)
expediente_plan_formacionexpediente del plan de formaciónTexto (text)Cadena de texto
id_eps_plan_formacionid del EPS vinculado al plan de formaciónTexto (text)Cadena de texto
nombre_eps_plan_formacionNombre del EPS del plan de formaciónTexto (text)Cadena de texto
id_convocatoriaIdentificador de la convocatoria vinculadaEntero (int)Número entero positivo
nombre_convocatoriaNombre de la convocatoria vinculadaTexto (text)Cadena de texto (máx. 150 caracteres)
formulario_convocatoriaTexto definido en este campo del formulario de la convocatoriaTexto (text, máx. 64KB)Cadena de texto (máx. 64KB)
url_logo_convocatoriaImagen de la convocatoriaTexto (text)

Cadena de texto

formulario_anexo_convocatoriaNombre del formulario de la convocatoriaTexto (text)Cadena de texto
marca_convocatoriaNombre de la marca de la convocatoriaTexto (text)Cadena de texto
id_colectivo_prioritario_convocatoriaid del colectivo prioritario de la convocatoria.Texto (text)Cadena de texto
nombre_colectivo_prioritario_convocatoriaNombre del colectivo prioritario vinculado a la convocatoria.Texto (text)Cadena de texto
territorioNombre del territorio al que se dirige la convocatoriaTexto (text)Cadena de texto formada por el nombre de la CCAA, o Ciudad Autónoma, o la palabra "Estatal"
convocatoria_tipo_cursoTipo de cursos indicado en la convocatoriaTexto (text)posibles valores: Bonificables, Privados, Subvencionados
id_estudioId del estudio vinculado al cursoTexto (text)Cadena de texto
nombre_estudionombre del estudio vinculado al cursoTexto (text)Cadena de texto
nivel_estudionivel del estudio vinculado al cursoTexto (text)Cadena de texto
clave_estudioclave del estudio vinculado al cursoTexto (text)Cadena de texto
id_areaId del área del cursoTexto (text)Cadena de texto
codigo_areacódigo del área del cursoTexto (text)Cadena de texto
descripciondescripción del cursoTexto (text)Cadena de texto
cif_centro_formacion_presencialCIF del centro de formación presencialTexto (text)Cadena de texto
nombre_centro_formacion_presencialNombre del centro de formación presencialTexto (text)Cadena de texto
telefono_centro_formacion_presencialTeléfono del centro de formación presencialTexto (text)Cadena de texto
domicilio_centro_formacion_presencialDomicilio del centro de formación presencialTexto (text)Cadena de texto
cp_centro_formacion_presencialCódigo postal del centro de formación presencialTexto (text)Cadena de texto
poblacion_centro_formacion_presencialPoblación del centro de formación presencialTexto (text)Cadena de texto
provincia_centro_formacion_presencialProvincia del centro de formación presencialTexto (text)Cadena de texto
cif_centro_imparticionCIF del centro de imparticiónTexto (text)Cadena de texto
nombre_centro_imparticionNombre del centro de imparticiónTexto (text)Cadena de texto
telefono_centro_imparticionTeléfono del centro de imparticiónTexto (text)Cadena de texto
domicilio_centro_imparticionDomicilio del centro de imparticiónTexto (text)Cadena de texto
cp_centro_imparticionCódigo postal del centro de imparticiónTexto (text)Cadena de texto
poblacion_centro_imparticionPoblación del centro de imparticiónTexto (text)Cadena de texto
provincia_centro_imparticionProvincia del centro de imparticiónTexto (text)Cadena de texto
medio_aula_virtualmedio aula virtualTexto (text)Cadena de texto
conexion_aula_virtualmodo de conexión aula virtualTexto (text)Cadena de texto
contacto_aula_virtualcontacto aula virtualTexto (text)Cadena de texto
telefono_aula_virtualteléfono aula virtualTexto (text)Cadena de texto
bimodalIndica si el grupo es bimodalBooleanoSí o No
etiquetasNombre de las etiquetas asociadas al grupoArray de nombres de etiquetasLista de cadenas de texto
tutoresInformación sobre los tutores Array de objetos- id_usuario,
- nif,
- nombre,
- apellido1,
- apellido2,
empresas_participantesInformación sobre las empresas participantes en el grupoArray de objetos- id_empresa,
- cif
- nombre
participantesInformación sobre los participantes Array de objetos- id_matricula
- perfil_gestion
- precio
- id_usuario
- nif
- nombre,
- apellido1,
- apellido2
sesionesLista de fechas de sesionesArray de fechasLista 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

¡Háganos saber cómo podemos mejorar este artículo!

Seleccione al menos una de las razones
Se requiere la verificación del CAPTCHA.

Sus comentarios se han enviado

Agradecemos su esfuerzo e intentaremos corregir el artículo