API de Conductores
En Optiroute los conductores son asignados a las rutas de los planes de rutas.
La API de rutas de Optiroute permite administrarlos desde tu sistema a través del siguiente endpoint:
https://testing.optiroute.cl/api/v1/drivers/
Estados de conductores
Los conductores tienen los siguientes estados:
Nombre del estado | Número de estado | Descripción |
DISABLED | -1 | El conductor fue eliminado |
ENTERED | 0 | El conductor fue creado |
Objetos
Para interactuar con este endpoint se deben utilizar las estructuras de datos que se describirán a continuación.
Objeto conductor de respuesta
El objeto conductores de respuesta es un hash de cada dirección y sus propiedades, donde la clave es su propiedad id, que corresponde al Identificador único del conductor en Optiroute.
Propiedad | Tipo | Descripción |
id | Número | Identificador único de la dirección provisto por Optiroute |
name | Texto | Nombre del conductor |
email | Texto | Correo del conductor |
phone_number | Texto | Teléfono del conductor |
rut | Texto | Rut del conductor |
status | Número | Estado del conductor |
shift_start | Texto | Horario de inicio del turno por defecto del conductor |
shift_end | Texto | Horario de término del turno por defecto del conductor |
speed_factor | Texto | Factor de velocidad por defecto del conductor |
Acciones
A continuación se describen las acciones para administrar los conductores.
Obtener lista de conductores
Para obtener la lista de conductores desde Optiroute debes realizar una llamada tipo GET al endpoint de la API de conductores.
Obtener conductores particular
Para obtener el detalle de un conductor desde Optiroute debes realizar una llamada tipo GET en el endpoint de la API de conductores agregando el id de la conductor al final de la URL, de la siguiente manera:
https://testing.optiroute.cl/api/v1/drivers/{id}/
Si la llamada fue realizada correctamente la API deberá retornar un objeto de tipo conductor de respuesta.