Servicio web: Solicitudes avanzado

Modificado el Wed, 21 Feb 2024 a las 09:46 PM

Introducción

Este servicio web sirve para crear solicitudes del tipo "añadir participante a grupo".

De esta forma puedes enviar información desde otro entorno de datos.

Incluye las opciones disponibles en el servicio web Solicitudes-básico, más la posibilidad de crear/vincular acciones formativas, grupos y hacer una matriculación directa del usuario en un grupo.

Proceso de consumo

Se utiliza el protocolo de comunicación HTTP.

Los pasos serían:

  1. Autenticarte: autenticación HTTP mediante los datos de acceso proporcionados.
  2. Consumir el servicio en la URL proporcionada.
  3. Solicitud: se envía en formato JSON
  4. Respuesta: se recibe una respuesta en formato JSON.

Diagrama

Solicitud (llamada)

Usa notación JSON con la siguiente estructura.
Los elementos obligatorios para la creación del registro son:

  • usuario_nombre
  • usuario_apellido1
  • usuario_email,
  • id_curso (en caso de no enviar id_aaff, o id_grupo)

Para crear la acción formativa son necesarios como mínimo estos elementos:

  • id_agrupacion
  • codigo_aaff
  • denominacion aaff
  • obietivos aaff
  • contenido_aaff

Para crear el grupo son necesarios como mínimo estos elementos:

  • denominacion_grupo
  • fecha_inicio_grupo
  • fecha_fin_grupo

Para crear el grupo son necesarios como mínimo estos elementos:

  • usuario_nombre
  • usuario_apellido1
  • usuario_email


ElementosTipo de DatoPosibles Valores/RangoDescripción
id_curso
intNúmero entero positivo
ID curso.
(obligatorio en caso se no venir id_aaff ni id _grupo)
usuario_nif
string
Número entero positivo
Nº documento del usuario (se valida al crearlo)
usuario_nass
string
Número entero positivo
Nº documento de la SS del usuario
usuario_sexostring

Lista predefinida:
0 = "Sin especificar"

H = "Hombre"

M = "Mujer"

O = "Otro"

Genero del participante
usuario_nombrestringTexto (hasta 255 caracteres)El nombre del usuario.
usuario_apellido_1stringTexto (hasta 255 caracteres)El primer apellido del usuario.
usuario_apellido_2stringTexto (hasta 255 caracteres)El segundo apellido del usuario.

usuario_ fecha_nacimiento


date

fecha de nacimiento del participante
usuario_discapacidadBooleano


(0|1)
Indica su el usuario tiene discapacidad
usuario_telefonointTexto (hasta 15 caracteres)Número de teléfono del usuario.
usuario_emailstringFormato de correo electrónico válidoDirección de correo electrónico del usuario.

usuario_domicilio

string
domicilio del usuario

usuario_cp

int

el valor del elemento lo validamos contra el listado oficial de códigos postales de Fundae.

usuario_poblacion

string

el valor tiene que estar dentro de las poblaciones existentes para el código postal del listado oficial de Fundae.
usuario_paisstringLista de países válidosPaís de residencia o operación del usuario.
usuario_provinciastringLista de provincias/estados válidos dependiendo del paísProvincia o estado del usuario.
usuario_tipostringLista predefinida:
0 = "Cliente";
1= "Potencial";
Tipo de usuario.
usuario_situacionintLista predefinida:
0 = "Sin especificar"
1 = "Empleado"
2 = "Autónomo"
3 = "Funcionario"
4 = "No definido"
5 = "Desempleado"
6 = "ERTE"
Situación actual del usuario.

usuario nivel estudios

int


usuario_area_funcional

int

usuario_cif_empresa
string
Número entero positivo

N° documento del usuario (se valida al crearlo)

usuario_empresa
string
Texto (hasta 255 caracteres)
Nombre de la empresa del usuario.
usuario_sector
string
Lista predefinida de sectores (si aplica)
Sector al que pertenece la empresa del usuario.
usuario_grupo_cotizacion
int


usuario_categoria_profesional
int


usuario_perfil
int

Lista predefinida:

O = "Sin especificar"

1 = "Bonificado"

2 = "Privado"

3 = "Autónomo"

4 = "Desempleado"

5 = "Subvencionado"

El perfil de gestión vinculado a la matrícula usuario.


usuario_situacion_programa_22
int
Lista predefinida de valores
Establecidos oficialmente por Fundae
usuario_precio_curso
decimal
10.2

La separación decimal indicarla con un "."

usuario_desempleado_larga_duración
int
0,1

Indica si se debe marcar seleccionar este elemento (1) o no (0)

usuario_contrato_parcial
int


0,1

Indica si se debe marcar seleccionar este elemento (1) o no (0)


usuario_contrato_temporal
int

0,1

Indica si se debe marcar seleccionar este elemento (1) o no (0)


usuario_manutencionint

0,1

Indica si se debe marcar seleccionar este elemento (1) o no (0)


usuario_transporte
int

0,1

Indica si se debe marcar seleccionar este elemento (1) o no (0)


usuario_alojamiento
int
0,1

Indica si se debe marcar seleccionar este elemento (1) o no (0)


usuario_nivel_estudios_subvencionado
string

Lista predefinida de los valores oficiales establecidos por Fundae para esa convocatoria.


Se valida en función del esquema XML indicado en la convocatoria seleccionada en el grupo comercial indicado en el elemento id_grupo_comercial


usuario_situacion_laboral
string

Lista predefinida de los valores oficiales establecidos por Fundae para esa convocatoria.


Se valida en función del esquema XML indicado en la convocatoria seleccionada en el grupo comercial indicado en el elemento id_grupo_comercial

usuario_ocupacion
string

Lista predefinida de los valores oficiales establecidos por Fundae para esa convocatoria.


Se valida en función del esquema XML indicado en la convocatoria seleccionada en el grupo comercial indicado en el elemento id_grupo_comercial

producto_nombrestringTexto (hasta 255 caracteres)Nombre del curso
producto_idintNúmero entero positivo
ID curso
id_grupo_comercialintNúmero entero positivoID del grupo comercial
id_AAFFint
Número entero positivo
ID de la acción formativa
id_cursoint
Número entero positivo
ID del curso
(obligatorio en caso se no venir id_aaff ni id _grupo)

id_agrupacion

int
Número entero positivo
ID de la agrupación
codigo_aaffint
Número entero positivo
Código de la AAFF
denominacion_aaffstring
Texto (hasta 255 caracteres)
Nombre de la AAFF
tipo_formacion_aaffstring
0, 1

Indica si la AAFF es "propia" (0) o está "vinculada a un certificado profesional" (1)
codigo_grupo_acciones_ftstring
listado de valoresid del grupo de acción de la AAFF
codigo_area_profesional_aaffstring
listado de valoresid del área profesional de la AAFF
nivel_formacion_aaffint
0 = "básica";
1 = "superior";
Tipo de nivel de formación indicada en la AAFF
objetivos_aaffstring
Texto (hasta 16MB)
Objetivos de la AAFF comunicados a Fundae
contenido_aaffstringTexto (hasta 16MB)
Contenidos de la AAFF comunicados a Fundae
id_proveedor_aaffint
Número entero positivo
Id del proveedor seleccionado en la AAFF
nombre_proveedor_aaffstring
Texto (hasta 255 caracteres)
Nombre del proveedor seleccionado en la AAFF
cif_proveedor_aaffstring
Numérico
Nº de identificación del proveedor en modalidad de teleformación (se valida al crearlo)
url_proveedor_aaffstring
Texto (hasta 1024 caracteres)
URL de la plataforma que se indica en la AAFF
usuario_inspector_aaffstring
Texto (hasta 1024 caracteres)
nombre de usuario para el acceso del inspector a las labores de seguimiento que se indica en la AAFF

contrasena_inspector_aaff

string
Texto (hasta 1024 caracteres)
clave de usuario para el acceso del inspector a las labores de seguimiento que se indica en la AAFF

matriculacion_directa

int
0, 1
Indica si se debe matricular directamente al usuario en el grupo (1) o no (0)
id_grupoint
Número entero positivo
Identificador del grupo
denominacion_grupostringTexto (hasta 1024 caracteres)
Nombre del grupo
fecha_inicio_grupoFecha (date)
Formato de fecha válido (por ejemplo, "YYYY-MM-DD")
Fecha de inicio del grupo
fecha_fin_grupoFecha (date)
Formato de fecha válido (por ejemplo, "YYYY-MM-DD")
Fecha de fin del grupo
adjunto_1string
Texto (hasta 1024 caracteres)
URL donde se encuentra el archivo para importarlo a la solicitud.

etiqueta

Array de nombres de etiquetas
Nombre de las etiquetas asociadas al grupo
Lista de cadenas de texto

comentarios

string

Cadena de texto
Cadena de texto (máx. 64KB)

Ejemplo

{
"usuario_nombre": "John",
"usuario_apellido_1": "Smith",
"usuario_email": "john.smith@domain.com",
"producto_nombre": "WORD",
"id_grupo_comercial": 125
}

Respuesta

Usa notación JSON con la siguiente estructura.

Se envía en todos los casos al terminar el proceso.

CampoTipo de DatoPosibles Valores/RangoDescripción
successint0, 1Indica si la operación fue exitosa (1) o no (0)

Ejemplo

Object {success: 1}

Errores devueltos

  • 'error_code' => 0,
  • 'error_message'=> "cuando se produce un error",

Log de registros

Existe un log de registros accesible desde el propio programa a través de la opción de menú principal Cuenta/Informes/Formación/Log de cursos.

Se muestra una tabla con los siguientes datos:

  • id
    nº de registro del log
  • Fecha
    fecha y hora de la acción
  • Datos
    Resumen de los datos actualizados
  • Conversión
    Si se ha actualizado el registro
  • Id solicitud
    nº de registro de la solicitud generada
  • Comisionista
    comercial al que se ha vinculado la solicitud
  • Comentarios
    fila complementaria donde se indica el usuario vinculado a la solicitud, o el detalle del error por el que no se ha creado el registro.


¿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