Ejemplos de uso de API abierta

Ejemplo 1

El método devuelve un error o un enlace para que el usuario acceda al portal del usuario si este ya ha iniciado la formación.

Si se devuelve un enlace, debe mostrarse al usuario y no se realizan más llamadas del método.

En los demás casos, se devuelve un error con varios códigos. La lista de códigos disponibles se describe en Swagger y en la documentación en línea.

Si se recibe un error «404 user-not-found», se llama al método n.º 2.

Cualquier error con el código 422 significa que el plan de formación se está calculando en ese momento y que el enlace llegará pronto. En caso de que no ocurra, debería ponerse en contacto con el administrador de la cuenta para la que ASAP emitió el token de la API.

Ejemplo 2

En esta fase, obtenemos la lista de grupos a los que el usuario puede añadirse. Cuando el método recibe la lista, tiene que filtrarse para mostrar solo los grupos para los que el parámetro isStarted tiene el valor «true».

Solo se ha iniciado la formación en estos grupos, y el usuario solo puede unirse a dichos grupos.

Si no existen esos grupos, se devuelve el error «404 groups-not-found». En este caso, debería ponerse en contacto con el administrador de la cuenta para la que ASAP emitió el token de la API.

Ejemplo 3

Después de seleccionar un grupo, los datos personales y un identificador de grupo se pasan al método n.º 3. El resultado es un error o una respuesta 201 con el identificador del usuario añadido. En caso de recibir este error, debería ponerse en contacto con el administrador de la cuenta para la que ASAP emitió el token de la API.

Ejemplo 4

Para recibir datos de informes sobre la formación de los empleados:

1. Dirección de correo electrónico utilizada para registrar al usuario.
2. Nombre corto registrado del usuario.
3. Nombre completo registrado del usuario.
4. Grupo de formación actual del usuario.
5. Duración de la formación en segundos.
6. Categoría de rendimiento para el curso principal.
7. Categoría de rendimiento para el curso exprés.
8. Estado de formación actual.
9. Progreso de formación en el curso principal como un porcentaje con el formato xx.xx.
10. Progreso de formación en el curso exprés como un porcentaje con el formato xx.xx.
11. Fecha prevista de finalización del curso principal.
12. Fecha prevista de finalización del curso exprés.
13. Fecha de finalización del curso principal.
14. Fecha de finalización del curso principal.
15. Cursos de formación y estado de la formación del curso principal.
16. Cursos de formación y estado de la formación del curso exprés.
17. Fecha de la última actividad, en un formato que depende del idioma de localización elegido.
18. El número total de certificados recibidos por el usuario durante la formación.

Ejemplo 5

Para mover usuarios entre grupos y crear datos de grupos de formación para cada empleado de la empresa:

1. Grupo de formación actual.
2. Grupo de formación previo.

Ejemplo 6

Eliminar a un empleado del sistema de ASAP.