Plataforma - OnReports
- Listar los reportes programados - getProgrammedReports
- Obtener la información del reporte programado - getScheduledReportResult
Listar los reportes programados - getProgrammedReports
POST https://api.service24gps.com/api/v1/onreports/getProgrammedReports
Este método devuelve el listado de los reportes programados de la plataforma OnReports.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|---|---|
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/onreports/getProgrammedReports' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "323334",
"name_report": "Reporte Alertas Emitidas"
},
{
"id": "323335",
"name_report": "Reporte de Eventos"
},
{
"id": "323336",
"name_report": "Reporte Distancia Recorrida"
},
{
"id": "323337",
"name_report": "Resumen de actividad, geocercas, paradas y ralentí."
},
{
"id": "323338",
"name_report": "Seguimiento completo, eventos, alertas"
}
]
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
---|---|---|
id |
Identificador único del reporte programado. |
Cadena de Texto |
name_report | Nombre del reporte programado. | Cadena de Texto |
Obtener la información del reporte programado - getScheduledReportResult
POST https://api.service24gps.com/api/v1/onreports/getScheduledReportResult
Este método devuelve la información de la última ejecución del reporte programado en la plataforma OnReports.
NOTA: El método getScheduledReportResult se encuentra en versión beta.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|---|---|
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
report_id |
(Requerido) Identificador único del reporte programado. El id del reporte programado se puede consultar en el método getProgrammedReports. |
982823 |
NOTA: Para enviar la solicitud del método getScheduledReportResult es necesario tener seleccionado la opción JSON en el formato del reporte en OnReports. En caso de no tener habilitada esta opción, se tendrá que contactar a soporte para hacer la solicitud de la activación del campo.
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/onreports/getScheduledReportResult' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'report_id="982823"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"columns": {
"activo": "Activo",
"placa": "Placa",
"viaje": "Viaje / Geocercas",
"comienzo": "Comienzo",
"geocerca_comienzo": "Geocerca comienzo",
"fin": "Fin",
"geocerca_fin": "Geocerca fin",
"kilometraje": "Kilometraje",
"tiempo_total": "Tiempo entre geocercas",
"velocidad_media": "Velocidad media",
"velocidad_maxima": "Velocidad máxima",
"conductor": "Conductor",
"tiempo_movimiento": "Tiempo en movimiento",
"tiempo_estacionado": "Tiempo estacionado"
},
"result": [
{
"activo": "Activo-001",
"placa": "ABC-123",
"viaje": "Viaje geocerca",
"comienzo": "2024-03-16 16:05:49",
"geocerca_comienzo": "GEOCERCA 1",
"fin": "2024-03-16 17:15:08",
"geocerca_fin": "GEOCERCA 2",
"kilometraje": "52.01",
"tiempo_total": "01:09:19",
"velocidad_media": "41.83",
"velocidad_maxima": 101,
"conductor": "-",
"tiempo_movimiento": "01:04:48",
"tiempo_estacionado": "00:00:00"
},
{
"activo": "Activo-002",
"placa": "ABc-1234",
"viaje": "Viaje geocerca",
"comienzo": "2024-03-16 17:22:28",
"geocerca_comienzo": "GEOCERCA 1",
"fin": "2024-03-16 17:41:59",
"geocerca_fin": "GEOCERCA 2",
"kilometraje": "17.32",
"tiempo_total": "00:19:31",
"velocidad_media": "51.27",
"velocidad_maxima": 98,
"conductor": "-",
"tiempo_movimiento": "00:18:01",
"tiempo_estacionado": "00:00:00"
},
{
"activo": "Activo-003",
"placa": "ABC-734",
"viaje": "Viaje geocerca",
"comienzo": "2024-03-17 14:05:50",
"geocerca_comienzo": "GEOCERCA 1",
"fin": "2024-03-17 14:21:15",
"geocerca_fin": "GEOCERCA 2",
"kilometraje": "5.46",
"tiempo_total": "00:15:25",
"velocidad_media": "17.40",
"velocidad_maxima": 45,
"conductor": "-",
"tiempo_movimiento": "00:15:25",
"tiempo_estacionado": "00:00:00"
}
]
}
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
---|---|---|
columns |
Columnas del reporte programado. |
JSON |
result | Información del reporte programado. | JSON |