Método «POST /openapi/v1/report»

Generar datos de informes sobre los usuarios que están registrados en el portal y que están completando formación en los programas ASAP.

El tamaño de los datos pasados se describe en el cuerpo de la solicitud.

Solicitud

Encabezado:

• Authorization: El token de la API de la empresa.

Cuerpo:

• lng – una cadena: El código de idioma del idioma utilizado para el informe. Uno de los idiomas de localización disponibles en el formato ISO 639-1. Es necesario. Se indica en minúsculas.

Correspondencias entre el idioma del informe y el valor de lng:

• email – una matriz: La dirección de correo electrónico del usuario. Se indica para obtener datos de un usuario concreto. Opcional.

  Requisitos sobre las direcciones indicadas: 1) deben indicarse en minúsculas, 2) deben contener los símbolos «@» y «.».

Respuesta

JSON que contiene una matriz de datos sobre cada usuario:

• id – una cadena: El ID asignado al empleado en la plataforma ASAP.
• email – una cadena: La dirección de correo electrónico utilizada para registrar al usuario.
• shortName – una cadena: El nombre corto registrado del usuario.
• fullName – una cadena: El nombre completo registrado del usuario.
• group – una cadena: El grupo de formación actual del usuario.
• educationTime – una cadena: Duración de la formación en segundos.
• mainEducationProgress – una cadena: Categoría de rendimiento en el curso principal.
• expressEducationProgress – una cadena: Categoría de rendimiento en el curso exprés.
• educationStatus – una cadena: Estado actual de la formación.
• mainEducationProgressPercent – un valor flotante: Progreso de la formación en el curso principal, expresado como un porcentaje con el formato xx.xx.
• expressEducationProgressPercent – un valor flotante: Progreso de la formación en el curso exprés, expresado como un porcentaje con el formato xx.xx.
• mainEducationEndPlan – una fecha: Fecha prevista para la finalización del curso principal.
• expressEducationEndPlan – una fecha: Fecha prevista para la finalización del curso exprés.
• realMainEducationEnd – una fecha: Fecha de finalización del curso principal.
• realExpressEducationEnd – una fecha: Fecha de finalización del curso exprés.
• educationMainCourses – una matriz: Cursos de la formación y estado de la formación en el curso principal.

  Formato de respuesta:

  [

  {

  code,

  level,

  status,

  startedAt,

  finishedAt

  }

  ]

  donde:

  • code es el nombre del curso, que depende del idioma de localización.
  • level es el nivel de la formación. Los siguientes valores son posibles:
    • 1: «principiante»
    • 2: «elemental»
    • 3: «intermedio»
    • 4: «avanzado»
  • status es el estado de formación en el curso. Los siguientes valores son posibles:
    • 0: «asignado». El curso está disponible para que el empleado lo complete como parte de su ruta de formación individual actual. El curso estará disponible cuando se complete el módulo actual o se inicie la formación.
    • 1: «completado». El empleado ha recibido un certificado de finalización.
    • 2: «en progreso». El empleado está trabajando en el curso como parte de su ruta de formación individual actual.
  • startedAt: La fecha y hora en que el empleado inició el módulo de formación, expresadas en el formato ISO 8601: AAAA-MM-DDThh:mm:ss. El formato de fecha (AAAA-MM-DD) depende del idioma de entrada.
  • finishedAt: La fecha y hora de finalización del módulo (para el que se recibió un certificado), en el formato ISO 8601: AAAA-MM-DDThh:mm:ss. El formato de fecha (AAAA-MM-DD) depende del idioma de entrada. Si faltan datos, se devuelve un valor vacío.

  Si no hay datos, se forma una matriz vacía.

• educationExpressCourses – una matriz: Cursos de la formación y estado de la formación en el curso exprés.

  Formato de respuesta:

  [

  {

  code,

  level,

  status,

  startedAt,

  finishedAt

  }

  ]

  donde:

  • code es el nombre del curso, que depende del idioma de localización.
  • level es el nivel de la formación.
  • status es el estado de formación en el curso. Los siguientes valores son posibles:
    • 0: «asignado». El curso está disponible para que el empleado lo complete como parte de su ruta de formación individual actual.
    • 1: «completado».

    Se está realizando una verificación para determinar si las pruebas están activadas para la formación actual. Si las pruebas están activadas y se ha aprobado la prueba del módulo, o si las pruebas están activadas y hay una nota sobre obtener una habilidad, entonces «status» es igual a 1. De lo contrario, «status» es igual a 0.

  • startedAt: La fecha y hora en que el empleado inició el módulo de formación, expresadas en el formato ISO 8601: AAAA-MM-DDThh:mm:ss. El formato de fecha (AAAA-MM-DD) depende del idioma de entrada.
  • finishedAt: La fecha y hora de finalización del módulo (para el que se recibió un certificado), en el formato ISO 8601: AAAA-MM-DDThh:mm:ss. El formato de fecha (AAAA-MM-DD) depende del idioma de entrada. Si faltan datos, se devuelve un valor vacío.

  Si no hay datos, se forma una matriz vacía.

• dateLastActive – una fecha: La fecha de la actividad más reciente, en un formato que depende del idioma de localización de entrada.
• certificatesReceived – un entero: El número total de certificados recibidos por el usuario durante la formación.

  Si el usuario no ha iniciado la formación o no ha recibido ningún certificado, se devuelve «0».

• phishingAttacks – una matriz: Información sobre un ataque de phishing durante la formación en la plataforma ASAP.

  Formato de respuesta:

  [

  {

  code: '''',

  level: '''', 

  startedAt: '''', 

  phishingAttackLetter: '''', 

  phishingAttackResult: '''',

  followPhishingLinkAt: ''" || null

  }

  ]

  donde:

  • code es el nombre dependiente de la configuración regional del módulo de formación que implica el envío de un correo electrónico de phishing.
  • level es el nivel de la formación. Los siguientes valores son posibles:
    • 1: «principiante»
    • 2: «elemental»
    • 3: «intermedio»
    • 4: «avanzado»

    Se devuelve un valor vacío para los correos electrónicos de phishing enviados como parte de una campaña de phishing.

  • startedAt: La fecha y hora en que el empleado inició el módulo de formación, expresadas en el formato ISO 8601: AAAA-MM-DDThh:mm:ss. El formato de fecha (AAAA-MM-DD) depende del idioma de entrada.
  • phishingAttackLetter es el título del correo electrónico de phishing. Cuando se envían correos electrónicos de phishing utilizando una plantilla, se emplea el título introducido por el administrador. El título depende del idioma de localización de entrada.
  • phishingAttackLetter es el resultado del ataque de phishing. Los siguientes valores son posibles:
    • 0: Se ha enviado un correo electrónico de phishing. Se está a la espera de una respuesta del usuario.
    • 1: El usuario ha evitado el ataque de phishing.
    • 2: El usuario ha caído en el phishing.
  • followPhishingLinkAt es la fecha y hora en que se accedió al enlace de phishing. Se genera solo para «phishingAttackResult»: 2. En otros casos, se devuelve un valor vacío.  

  Si no hay datos, se forma una matriz vacía.

Posibles errores:

• 200 – success: La operación se ha realizado correctamente.
• 401 – common-unauthorized: Ha ocurrido un error de autenticación. 
• 404 – user not found: Se ha enviado una dirección de correo electrónico no válida. 
• 400 bad request: Hay algún error con la solicitud.
• 500 – internal-server-error: Ha habido un error interno del servidor.