getDashboardData(JSON dataDash)
Al invocar este método, se obtienen toda la información que se va a mostrar en el dashboard en formato JSON.
Los atributos requeridos en el Json son que se recibe como parámetro son:
- current_date_ini: Fecha de Inicio de rango para obtener los datos en formato AAAA-MM-DD
- current_date_fin: Fecha de Fin de rango para obtener los datos en formato AAAA-MM-DD
Ejemplo de JSON:
let dataDash = {
'current_date_ini':'2021-01-11',
'current_date_fin':'2021-01-18',
}
Ejemplo de solicitud en JS:
try {
const dash = await _gpsApiv2.getDashboardData(dataDash);
} catch (error) {
console.error(error);
}
A continuación se describen los atributos que se reciben como respuesta de la solicitud en JSON:
Atributos | Definición |
---|---|
clients | Arreglo con los distintos estatus de los clientes |
deliveries |
Arreglo con los distintos estatus de los repartidores |
in_route | Arreglo con los distintos estatus de los pedidos en ruta |
orders | Arreglo con información de las ordenes |
vehicles | Arreglo con los vehículos asignados |
status | Nombre del estatus en el que se encuentra el elemento |
total | Total de elementos en cada sección |
Respuesta de ejemplo:
{
status:'200'
data: {
clients:[
0:{
status:'Con Pedido'
total:'0'
},
1:{
status:'Sin Pedido'
total:'20'
},
2:{
status:'Total'
total:'20'
},
]
deliveries:[
]
in_route:[
]
orders:[
]
vehicles:[
0:{
status:'Con Entregas'
total:'0'
},
1:{
status:'Sin Entregas'
total:'29'
},
2:{
status:'Total'
total:'29'
},
]
}
}