Consultar asociaciones a servicio activas
Este endpoint permite consultar las asociaciones a servicio activas de un servicio.
GET /api/v1/businesses/{businessId}/services/{serviceId}/service-associations/activeSi los datos incluidos en la petición son correctos —tanto el businessId como el serviceId—, la respuesta contendrá todas las asociaciones a servicio con fecha de fin posterior a la fecha actual (o no establecida).
A continuación, se muestra un fragmento de respuesta:
[
{
"ownerProduct": "0001-G",
"product": "0001-G",
"from": "2021-06-25",
"splitPresence": true,
"unplannable": false,
"roles": [],
"disponibility": [
{
"from": "2021-06-25",
"ranges": [
{
"dayType": "ALL",
"startMinuteDay": 0,
"duration": 1440
}
]
}
],
"service": "0001",
"person": {
"name": "John",
"surname": "Smith",
"birthday": "1987-05-07",
"employeeId": "152015",
"virtual": false
}
},
{
"ownerProduct": "0001-G",
"product": "0002",
"from": "2021-06-25",
"splitPresence": true,
"unplannable": false,
"roles": [],
"disponibility": [
{
"from": "2021-06-25",
"ranges": [
{
"dayType": "ALL",
"startMinuteDay": 0,
"duration": 1440
}
]
}
],
"service": "0001",
"person": {
"name": "Mark",
"surname": "Murphy",
"birthday": "1987-05-07",
"employeeId": "1006357",
"metadata": {
"position": "developer"
},
"virtual": false
}
},
{
"ownerProduct": "0001-G",
"product": "0001-G",
"from": "2021-10-01",
"splitPresence": true,
"unplannable": false,
"roles": [],
"disponibility": [
{
"from": "2021-10-01",
"ranges": [
{
"dayType": "ALL",
"startMinuteDay": 0,
"duration": 1440
}
]
}
],
"regularCessions": [
{
"product": "081818",
"minutes": 360,
"days": [
"MONDAY"
]
}
],
"service": "0001",
"person": {
"name": "Ann",
"surname": "Williams",
"birthday": "1987-05-07",
"employeeId": "1006356",
"virtual": false
}
},
{
"ownerProduct": "0001-G",
"product": "0002",
"from": "2024-10-02",
"to": "2024-10-16",
"splitPresence": false,
"unplannable": false,
"roles": [],
"disponibility": [
{
"from": "2024-10-02",
"to": "2024-10-16",
"ranges": [
{
"dayType": "ALL",
"startMinuteDay": 0,
"duration": 1440
}
]
}
],
"metadata": {
"code": "SSA"
},
"service": "0002",
"person": {
"name": "Emily",
"surname": "Cork",
"birthday": "1987-05-07",
"employeeId": "1006352",
"virtual": false
}
}
]Como se puede ver en el ejemplo, los datos de la respuesta dependen de la información que se haya definido para cada uno de los empleados y de las asociaciones: si hay metadatos, cesiones regulares, etc.
Aspectos que tener en cuenta
La petición devolverá todas las asociaciones a servicio y cesiones en las que el ownerProduct coincida con los productos del servicio indicado en la URL.
Si hay cesiones regulares definidas para algún empleado del servicio, también aparecerán en la respuesta.
Aquellos empleados que no tengan configurado el identificador externo (employeeId) en el sistema, no aparecerán en la respuesta.
Si no hay asociaciones a servicio activas, la petición devolverá un array vacío [].
Si el servicio indicado en la URL no existe en el negocio, la petición devolverá un error 404 Not Found, especificando en el mensaje not exits.
Enlaces de interés
¿Qué es una asociación a servicio? ¿Y una cesión?