API de análisis de tiempo de conductores

El propósito principal de la API de análisis de tiempo de conductores es mostrar los datos de tiempo de conducción y descanso para un conductor específico. Los datos mostrados se basan en la funcionalidad de análisis de tiempo.

Ejemplo de solicitud para un conductor específico:

GET /drivers/{driverId}/current-time-analysis?version=1&api_key=<…>
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8

Los siguientes parámetros son obligatorios para que la API funcione:

ParámeteroTipoDescripción
driverIdCadenaIdentificador del conductor (Este ID se puede adquirir enviando una solicitud a la API de conductores)
versionCadenaVersión de la API, actualmente solo version=1 está disponible
api_keyCadenaClave de identificación del usuario

Ejemplo de respuesta del servidor:

{
  "type": "PRIMARY",
  "calculated_until": "2018-05-31T14:47:47.000Z",
  "state": {
    "activity": "UNKNOWN",
    "started_at": "2018-05-24T11:10:00.000Z",
    "duration": 617820
  }, 
  "current_day": {
    "driving_status": "SINGLE",
    "driving": {
      "regular": {
        "duration": 0,
        "duration_limit": 32400
		},
      "extra": {
        "duration": 0,
        "duration_limit": 3600
		}
    },
    "working": {
      "duration": 0
    },
    "resting": {
      "rest_in_progress": false,
      "next_rest": null
    }
  },
  "current_week": {
    "driving": {
      "duration": 0,
      "duration_limit": 201600,
      "extended_daily_driving_periods": {
        "used": 0,
        "usage_limit": 2
      }
    },
    "working": {
      "duration": 0
    },
    "resting": {
      "rest_in_progress": false,
      "next_rest": null,
      "reduced_daily_rests": {
        "used":0,
        "usage_limit": 3
      }
    }
  },
  "previous_week": {
    "driving": {
      "duration": 0,
      "duration_limit": 201600
    },
    "resting": {
      "duration": 0
      }
  },
  "infringements": {
  "daily_driving_limit_exceeded": {
    "duration": 0
  },
  	"weekly_driving_limit_exceeded": {
  		"duration": 0
    }
  },
  "data_gap_duration": {
	"duration": 0
  }
 }

Si se ha introducido un parámetro o API_key incorrecto, el sistema responderá con un código de error. Los códigos de errores se describen en API.

Todos los parámetros de respuesta que se puede recibir:

ParámetroTipoDescripciónUnidades
typeCadenaIndica si el conductor está el principal o secundario, o sea si la tarjeta de conductor está insertada en la primera o segunda ranura del tacógrafo Texto
calculated_untilFechaLa fecha y hora cuando se hizo la solicitud
Formato: "yyyy-mm-ddThh:mm:ss.sssZ"
Según ISO8601
stateArrayContiene todos los parámetros de estado del conductor
activityCadenaEl estado del conductor cuando se hizo la solicitudTexto
started_atFechaLa fecha y hora cuando el conductor entró el estado
Formato: "yyyy-mm-ddThh:mm:ss.sssZ"
Según ISO8601
durationNúmero enteroEl tiempo total gastado por el conductor en el estadoSegundos
current_dayArrayContiene todos los parámetros del día actual
driving_statusCadenaIndica si hay un solo conductor o un equipoTexto
drivingArrayContiene todos los parámetros de conducción
regularArrayContiene todos los parámetros de conducción regular
durationNúmero enteroLa duración total de conducción regularSegundos
duration_limitNúmero enteroLa duración máxima permitida de conducción regularSegundos
extraArrayContiene todos los parámetros de conducción adicional
durationNúmero enteroLa duración total de conducción adicionalSegundos
duration_limitNúmero enteroLa duración máxima permitida de conducción adicionalSegundos
workingArrayContiene todos los parámetros de trabajo diario
durationNúmero enteroLa duración total de trabajo diarioSegundos
restingArrayContiene todos los parámetros de descanso diario
rest_in_progressBooleanoIndica si el conductor estaba descansando cuando se hizo la solicitudTrue (Verdadero) - False (Falso)
next_restFechaLa fecha y hora del siguiente descanso diario
Formato: "yyyy-mm-ddThh:mm:ss.sssZ"
Según ISO8601
current_weekArrayContiene todos los parámetros de la semana actual
drivingArrayContiene todos los parámetros de conducción
durationNúmero enteroLa duración total de conducción semanalSegundos
duration_limitNúmero enteroLa duración máxima permitida de conducción semanalSegundos
extended_daily_driving_periodsArrayContiene todos los parámetros de periodos de conducción extendida
usedNúmero enteroLa cantidad de usados periodos de conducción extendidaNúmero
usage_limitNúmero enteroLa cantidad máxima de periodos de conducción extendidaNúmero
workingArrayContiene todos los parámetros de trabajo semanal
durationNúmero enteroLa duración total de trabajo semanalSegundos
restingArrayContiene todos los parámetros de descanso semanal
rest_in_progressBooleanoIndica si el conductor estaba descansando cuando se hizo la solicitudTrue (Verdadero) - False (Falso)
next_restFechaLa fecha y hora del siguiente descanso semanal
Formato: "yyyy-mm-ddThh:mm:ss.sssZ"
Según ISO8601
reduced_daily_restsArrayContiene todos los parámetros de descanso diario reducido
usedNúmero enteroLa cantidad de usados periodos de descanso diario reducidoNúmero
usage_limitNúmero enteroLa cantidad máxima de periodos de descanso diario reducidoNúmero
previous_weekArrayContiene todos los parámetros de la semana previa
drivingArrayContiene todos los parámetros de conducción
durationNúmero enteroLa duración total de conducción la semana previaSegundos
duration_limitNúmero enteroLa duración máxima permitida de conducción semanalSegundos
restingArrayContiene todos los parámetros de descanso para la semana previa
durationNúmero enteroLa duración total de descanso la semana previaSegundos
infringementsArrayContiene todos los parámetros de infracción
daily_driving_limit_exceededArrayContiene todos los parámetros de conducción diaria excesiva
durationNúmero enteroLa duración total de conducción diaria excesivaSegundos
weekly_driving_limit_exceededArrayContiene todos los parámetros de conducción semanal excesiva
durationNúmero enteroLa duración total de conducción semanal excesivaSegundos
data_gap_durationArrayContiene todos los parámetros de falta de datos
durationNúmero enteroLa duración total para la cual no se recibieron ningunos datosSegundos

Se puede ver los puntos finales de API, los parámetros de solicitudes y las respuestas en “Swagger” haciendo clic en este enlace: https://api.fm-track.com

‹   API de viajes
API de conductores  ›