Añadir un rol de empleado

Este endpoint permite añadir un nuevo rol de empleado dentro de un servicio o tienda.

POST /api/v1/businesses/{businessId}/services/{serviceId}/employee-role

A continuación, se desglosan los campos que conforman el cuerpo de la petición, siendo algunos de ellos obligatorios para que esta se realice de manera exitosa.

Los campos obligatorios están marcados con un asterisco (*).

Cuerpo de la petición

Análisis del JSON 
{
  "id": "string",
  "orquestId": 0,
  "name": "string",
  "color": "string"
}
Detalles

  • id*: identificador externo del rol de empleado. Debe ser único.

  • orquestId: identificador interno del rol en Orquest. No es necesario enviarlo, ya que el sistema lo añadirá de manera automática.

  • name*: nombre del rol.

  • color*: código de color hexadecimal que debe coincidir con la expresión regular "^(#[A-Fa-f0-9]{6})$".

Ejemplo de la petición

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

POST /api/v1/businesses/BUSINESSID/services/0001/employee-role
{
  "id": "ID001",
  "name": "Manager",
  "color": "#921b01"
}

Si todos los datos son correctos, se generará un rol con las características especificadas que podrá ser aplicado a cualquier empleado que esté asociado a este servicio.

Consideraciones

Una vez creado el rol, se podrá aplicar a un empleado del servicio o tienda de dos maneras:

  • Manualmente: editando la asociación a tienda del empleado dentro de la interfaz de Orquest.

  • Vía API: utilizando los endpoints complejos de creación o actualización de empleado o lista de empleados. Será necesario incluir el campo roles dentro del objeto serviceAssociations con el identificador del rol que se desea aplicar al empleado.

Ver ejemplo 
[
  {
    "business": "BUSINESSID",
    "lag": 0,
    "person": {
      "name": "John",
      "surname": "Carmack",
      "employeeId": "000000"
      },
    "serviceAssociations": [
      {
        "ownerProduct": "0001-G",
        "product": "0001-G",
        "from": "2021-10-01",
        "to": null,
        "roles": [
          "ID001"
        ]
      }
    ]
  }
]

Como el rol de empleado ha sido creado en el servicio 0001, se puede aplicar dentro de una asociación a este mismo servicio.

Códigos de error

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

Código Mensaje Descripción

400 Bad Request

-

El cuerpo de la petición no es un JSON válido o alguno de sus campos no tiene el formato esperado.

error.outer_id

El identificador externo (id) indicado ya está en uso por otro rol del mismo servicio. La unicidad es por servicio, no a nivel global del negocio.

406 Not Acceptable

must match "^(#[A-Fa-f0-9]{6})$"

El campo color no tiene el formato hexadecimal esperado.

Enlaces de interés

¿Qué es un rol de empleado?