Asociaciones a servicio

En este apartado, se encuentra la explicación técnica y detallada de todos los endpoints necesarios para gestionar la información relativa a las asociaciones a servicio a través de la API.

Aspectos que tener en cuenta

Considerando los datos que devuelve la API en estas peticiones, es necesario hacer una distinción entre dos tipos de estructuras: asociación a servicio y asociación a servicio actual.

Asociación a servicio

Es un concepto más general y completo que abarca todos los detalles posibles sobre la asociación de un empleado a un producto o sección. Incluye campos que proporcionan una descripción exhaustiva de la relación entre el empleado y el producto, permitiendo definir aspectos avanzados como la disponibilidad en distintos tipos de día, cesiones regulares y metadatos personalizados.

[
    {
        "ownerProduct": "string",
        "product": "string",
        "from": "yyyy-MM-dd",
        "to": "yyyy-MM-dd",
        "splitPresence": true,
        "unplannable": false,
        "card": "string",
        "roles": [],
        "disponibility": [
            {
                "from": "yyyy-MM-dd",
                "to": "yyyy-MM-dd",
                "ranges": [
                    {
                        "dayType": "string",
                        "startMinuteDay": 0,
                        "duration": 0
                    }
                ]
            }
        ],
        "regularCessions": [
            {
                "product": "string",
                "minutes": 0,
                "days": ["string"]
            }
        ],
        "metadata": {},
        "id": "string",
        "service": "string",
        "person": {
            "name": "string",
            "surname": "string",
            "group": "string",
            "email": "string",
            "birthday": "yyyy-MM-dd",
            "employeeId": "string",
            "metadata": {},
            "seniority": "yyyy-MM-dd",
            "virtual": false
        }
    }
]

Asociación a servicio

ownerProduct. Identificador del producto o sección al que pertenece el empleado.
product. Identificador del producto o sección donde va a trabajar el empleado. Puede ser igual al ownerProduct; si es distinto, se trata de una cesión.
from. Fecha de inicio de la asociación a servicio en formato yyyy-MM-dd.
to. Fecha de finalización de la asociación a servicio en formato yyyy-MM-dd. Puede ser null, indicando que no hay fecha de fin establecida.
splitPresence. Determina si se trata de un turno partido. El valor por defecto es true.
unplannable. Determina si el empleado será ignorado por el planificador, por lo que deberá planificarse a mano. El valor por defecto es false.
card. Identificador de la tarjeta del empleado en sistemas de fichajes.
roles. Lista de identificadores de roles que se atribuirán al empleado en esta asociación a servicio.
disponibility. Disponibilidad del empleado durante un período concreto. Por defecto, la disponibilidad de un empleado es total, considerando las limitaciones del contrato. Para cambiarla, será necesario enviar los siguientes datos:
- from. Fecha de inicio del periodo de la disponibilidad en formato yyyy-MM-dd.
- to. Fecha de finalización del periodo de la disponibilidad en formato yyyy-MM-dd. Puede establecerse como null siempre que la asociación a servicio también lo sea.
- ranges. Lista de disponibilidades para cada tipo de día. Estos rangos deben estar definidos en el contrato e incluyen los siguientes parámetros:
  - dayType. Tipo de día al que se aplica la disponibilidad. Las opciones disponibles del sistema son las siguientes: ALL, WEEKENDS, WORKED, HOLIDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. No obstante, se pueden definir otros tipos de día a nivel de negocio.
  - startMinuteDay. Inicio de la disponibilidad en minutos a partir de las 00:00. Por ejemplo, 600 para las 10:00.
  - duration. Duración del rango en minutos.
regularCessions. Determina si el empleado trabaja algunos días a la semana en otro producto o sección de manera sistemática. En caso de que existan cesiones regulares, se deberán definir a través de los siguientes campos:
- product. Identificador del producto o sección de destino donde el empleado va a trabajar.
- minutes. Número de minutos que el empleado trabajará en el producto o sección de destino.
- days. Lista de tipos de día que el empleado trabajará cedido. Valores admitidos: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
metadata. Cualquier dato adicional relativo a la asociación a servicio. La estructura de estos metadatos debe ser configurada previamente por el equipo de Orquest.
id. Identificador externo de la asociación a servicio.
service. Identificador externo del servicio.
person. Datos básicos del empleado:
- name. Nombre del empleado.
- surname. Apellido(s) del empleado.
- group. Si se han definido grupos dentro del negocio, el grupo al que pertenece el empleado.
- email. El email de empleado, si se ha establecido uno.
- birthday. La fecha de nacimiento con formato yyyy-MM-dd.
- employeeId*. Identificador externo del empleado.
- metadata. Datos adicionales sobre el empleado. La estructura de este campo debe ser previamente configurada por el equipo de Orquest.
- seniority. Antigüedad del empleado en formato yyyy-MM-dd.
- virtual: determina si se trata de un empleado real o uno virtual utilizado, por ejemplo, para realizar simulaciones.

Asociación a servicio actual

Se trata de un modelo simplificado que contiene solo los campos esenciales, por lo que se enfoca en los atributos necesarios para identificar la asociación actual y la relación del empleado con el servicio.

[
    {
        "ownerProduct": "string",
        "product": "string",
        "from": "yyyy-MM-dd",
        "to": "yyyy-MM-dd",
        "splitPresence": false,
        "unplannable": false,
        "id": "string",
        "employeeId": "string",
        "service": "string"
    }
]

Asociación a servicio actual

ownerProduct. Identificador del producto o sección al que pertenece el empleado.
product. Identificador del producto o sección donde va a trabajar el empleado. Puede ser igual al ownerProduct; si es distinto, se trata de una cesión.
from. Fecha de inicio de la asociación a servicio en formato yyyy-MM-dd.
to. Fecha de finalización de la asociación a servicio en formato yyyy-MM-dd. Puede ser null, indicando que no hay fecha de fin establecida.
splitPresence. Determina si se trata de un turno partido. El valor por defecto es true.
unplannable. Determina si el empleado será ignorado por el planificador, por lo que deberá planificarse a mano. El valor por defecto es false.
id. Identificador externo de la asociación a servicio.
employeeId. Identificador externo del empleado.
service. Identificador externo del servicio o tienda.

Así, la asociación a servicio proporciona información detallada sobre la relación, mientras que la asociación a servicio actual se centra en representar la asociación en curso de manera más simple y directa.