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:
- Autenticarte
- Se requiere autenticación HTTP mediante los datos de acceso de un usuario de Gesforma con perfil de coordinador (loginname y contraseña).
- 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.
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
Elementos disponibles
Puedes consultar los elementos disponibles aquí
Ejemplo
{
"usuario_nombre": "John",
"usuario_apellido_1": "Smith",
"usuario_email": "[email protected]",
"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.
Campo | Tipo de Dato | Posibles Valores/Rango | Descripción |
---|---|---|---|
success | int | 0, 1 | Indica 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
Sus comentarios se han enviado
Agradecemos su esfuerzo e intentaremos corregir el artículo