La API de viajes se usa para proporcionar el historial de viajes de objetos para el periodo solicitado.
Estructura de la solicitud:
GET /objects/{objectId}/trips?version=1&from_datetime=<..>&to_datetime=<..>&continuation_token=<..>&limit=<..>&api_key=<..> HTTP/1.1
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8
Parámetros de la respuesta:
| Parámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| objectId | Cadena | El ID del objeto externo | Sí |
| from_datetime | Fecha y hora | Encuentra registros desde la fecha y hora especificada. Ejemplo de fecha y hora: “2017-04-13T06:58:48.090Z” | Sí |
| to_datetime | Fecha y hora | Encuentra registros hasta la fecha y hora especificada. Ejemplo de fecha y hora: “2017-04-13T06:58:48.090Z” | No |
| continuation_token | Fecha y hora | Muestra desde cual fecha y hora se muestran los datos si se ha alcanzado el límite de registros. | No |
| limit | Número entero | Cuántos registros se incluyen en la respuesta (el valor por defecto - 100 registros, el valor máximo - 1000 registros). | No |
| version | Cadena | La versión de la API | Sí |
| api_key | Cadena | La clave de identificación del usuario | Sí |
Ejemplo de la respuesta;
{
"continuation_token": "2019-05-24T06:58:48.121Z",
"trips": [
{
"object_id": "ID0000",
"trip_type":"BUSINESS",
"trip_duration": 4781,
"mileage": 10.56,
"driver_ids": ["asdf321","123asdf","fdsa123"],
"trip_start": {
"datetime": "2019-05-24T06:58:48.121Z",
"longitude": 11.2222,,
"latitude": 33.444,
"address": {
"country": "Denmark",
"country_code": "DK",
"county": "",
"region": "",
"locality": "Herlev",
"street": "Unnamed Road",
"house_number": "",
"zip": "2730"
},
"trip_end": {
"datetime": "2019-05-24T06:58:48.121Z",
"longitude": 0,
"latitude": 0,
"address": {
"country": "Denmark",
"country_code": "DK",
"county": "",
"region": "",
"locality": "Herlev",
"street": "Unnamed Road",
"house_number": "",
"zip": "2730"
},
},
...
]
}Si se ha introducido un parámetro incorrecto, el sistema responderá con un código de error. Los códigos de errores se describen en API. Los parámetros sin datos no se incluirán en la respuesta. Una lista completa de parámetros de respuesta está disponible al final de este capítulo.
Parámetros de la respuesta:
| Parámetro | Tipo | Descripción | Unidades |
|---|---|---|---|
| continuation_token | Cadena | Se recibe el símbolo de continuación al solicitar una cantidad grande de registros para períodos largos, así superando el predeterminado límite de registros. El símbolo de continuación se mostrará al final de la respuesta y se puede usarlo para mostrar el siguiente conjunto de registros para el período seleccionado. Si no hay más registros después del símbolo de continuación, la respuesta será vacía. | |
| trips | Array | Contiene todos los parámetros según la solicitud | |
| object_id | Cadena | El ID del objeto | |
| trip_type | Enum | El tipo del viaje Valores posibles: UNKNOWN NONE PRIVATE BUSINESS WORK | |
| trip_duration | Fecha y hora | La duración del viaje | s |
| mileage | Número | Kilometraje conducido durante el viaje | m |
| driver_ids | Array | Contiene todos los IDs de conductor asignados al vehículo durante el viaje | |
| trip_start | Array | Contiene los parámetros del comienzo del viaje | |
| datetime | Fecha y hora | La fecha y hora de coordenada, generada en el hardware. Formato: "yyyy-mm-ddThh:mm:ss.sssZ" | Fecha y hora |
| longitude | Número | Longitud | Grados |
| latitude | Número | Latitud | Grados |
| address | Array | Contiene los parámetros de dirección | |
| country | Cadena | El nombre del país | |
| country_code | Cadena | El código del país | |
| county | Cadena | El nombre del condado | |
| region | Cadena | El nombre de la región | |
| locality | Cadena | El nombre de la localidad | |
| street | Cadena | El nombre de la calle | |
| house_number | Cadena | El número del inmueble | |
| zip | Cadena | El código ZIP | |
| trip_end | Array | Contiene los parámetros del fin del viaje |