Añadir aptitudes

Este endpoint permite registrar una lista de aptitudes para un empleado.

POST /api/v1/import/aptitudes

A continuación, se expone una explicación de cada uno de los campos que conforman el cuerpo de la petición.

Todos los campos de esta petición son obligatorios, por eso están marcados con un asterisco (*).

Cuerpo de la petición

Análisis del JSON
{
  "business": "string",
  "employeeId": "string",
  "aptitudes": [
    {
      "productId": "string",
      "aptitudes": [
        {
          "locationId": "string",
          "level": 0,
          "excludedZones": ["string"]
        }
      ]
    }
  ]
}
Detalles
  • business*: identificador externo del negocio.

  • employeeId*: identificador externo del empleado.

  • aptitudes*: conjunto de aptitudes que se van a definir para el empleado con respecto a las tareas de un producto.

    • productId*: identificador externo del producto o sección del empleado.

    • aptitudes*: lista de aptitudes. Cada aptitud está conformada por los siguientes campos:

      • locationId*: identificador externo de la tarea a la que hace referencia la aptitud.

      • level*: nivel de competencia en dicha tarea en un rango de 0 (no competente) a 3 (experto).

      • excludedZones: identificadores externos de las zonas que se excluirán de esta aptitud. Si no se especifican, la aptitud se aplica a todas las zonas del producto.

Ejemplo de la petición

Una vez realizado el análisis de los distintos campos, se muestra un ejemplo de la petición:

POST /api/v1/import/aptitudes
{
  "business": "BUSINESSID",
  "employeeId": "EMPLOYEEID",
  "aptitudes": [
    {
      "productId": "0001-G",
      "aptitudes": [
                {
                    "locationId": "02",
                    "level": 3,
                    "excludedZones": ["Z1"]
                }
      ]
    }
  ]
}

Si los datos son correctos, la petición devolverá un estado 200 OK y todas las aptitudes del empleado en el producto indicado se sustituirán por las de la petición.

Consideraciones

Si se envían valores con decimales para level, estos se truncarán a su número entero.

Se establecerá el mismo nivel de competencia para todas las zonas del producto que tengan habilitada la tarea, salvo que se incluya alguna zona en el campo excludedZones. En las zonas excluidas, se definirá nivel 0.

Si el empleado tiene aptitudes definidas en otros productos, estas permanecerán inalteradas.

Códigos de error

Además de los errores comunes, este endpoint puede devolver los siguientes códigos:

Código Mensaje Descripción

406 Not Acceptable

must be less than or equal to 3

Uno o más campos level contiene valores fuera de rango. La petición admite para level los valores 0, 1, 2 y 3.

must be greater than or equal to 0

Uno o más campos level contiene valores fuera de rango. La petición admite para level los valores 0, 1, 2 y 3.

409 Conflict

-

Se han incluido aptitudes duplicadas en la creación. Se recomienda revisar la petición y eliminar las aptitudes duplicadas antes de enviarla.

Enlaces de interés

¿Qué es una aptitud?

¿Qué es una tarea?