Plataforma - OnReports
- Listar reportes - getReports
- Listar los reportes programados - getProgrammedReports
- Obtener la información del reporte programado - getScheduledReportResult
Listar reportes - getReports
POST https://api.service24gps.com/api/v1/getReports
Obtiene el listado de reportes asignados al usuario.
Ver parámetros de solicitud:
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getReports' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "33",
"nombre": "Distancia recorrida",
"descripcion": "En este reporte podrá ver la distancia recorrida en kilometros que realizó el activo en diferentes días, horarios y rango de fechas (puede utilizar horario o jornada laboral)",
"columnas": [
"Activo",
"Conductor",
"Placa",
"Fecha inicial",
"Hora inicial",
"Lugar inicio",
"Fecha final",
"Hora final",
"Lugar final",
"Tiempo de viaje",
"Distancia recorrida"
],
"filtros": {
"sino_mostrar_detalle": {
"tipo": "boolean",
"titulo": "Detalle de la distancia recorrida",
"descripcion": "Muestra el total de km del periodo de tiempo que se haya elegido y no por dia."
},
"sino_calcular_paradas": {
"tipo": "boolean",
"titulo": "Calcular paradas",
"descripcion": "Muestra un mejor detalle cuando los vehiculos tienen una velocidad menor a 10 km/h"
},
"sino_horario_trabajo": {
"tipo": "boolean",
"titulo": "¿Usar horario de trabajo?",
"descripcion": "Utiliza el horario configurado para obtener por cada dia los reportes dentro de ese rango."
},
"detalle_distancia_recorrida": {
"tipo": "boolean",
"titulo": "Detalle de distancia recorrida",
"descripcion": "Muestra todos los puntos reportados por el equipo en el periodo de fechas seleccionados y agrega las columnas: Odometro, Velocidad y Evento",
"valor": "0"
}
},
"columnas_no_seleccionadas": [
1,
5,
8,
9
]
}
}Ver campos de respuesta:
| Campo |
Descripción |
Formato |
|---|---|---|
| id | Identificador único del reporte. | Entero |
| nombre | Nombre asignado al reporte. | Cadena de Texto |
| descripcion |
Breve descripción del reporte. |
Cadena de Texto |
|
columnas |
Columnas del reporte. |
Cadena de Texto |
|
filtros |
Filtros del reporte. |
Cadena de Texto |
|
columnas _no_seleccionadas |
Columnas no seleccionadas del reporte. |
Entero |
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": "000001",
"name_report": "Reporte de paradas",
"attached_format": [
"XLS",
"PDF",
"JSON"
],
"asset_groups": [],
"assets": {
"000001": "Activo Simulado 1",
"000002": "Activo Simulado 2"
},
"start_date": "2024-09-25",
"start_time": "00:00:00",
"end_date": "2024-09-25",
"end_time": "23:59:59",
"time_range": "Hoy",
"days_to_send_report": [
"Lunes",
"Martes",
"Miércoles",
"Jueves",
"Viernes",
"Sábado",
"Domingo"
],
"columns": [
"Activo",
"Fecha",
"Hora",
"Placa",
"Descripcion",
"Tiempo parado",
"Latitud",
"Longitud",
"Domicilio",
"Lugar",
"Geocerca",
"Grupo Vehiculo",
"Ver mapa"
],
"send_report": "1",
"send_report_email": "test@gmail.com"
},
{
"id": "000002",
"name_report": "Sensores: Ignición",
"attached_format": [
"XLS",
"PDF",
"JSON"
],
"asset_groups": [],
"assets": {
"000001": "Activo Simulado 1",
"000002": "Activo Simulado 2"
},
"start_date": "2024-09-25",
"start_time": "00:00:00",
"end_date": "2024-09-25",
"end_time": "23:59:59",
"time_range": "Hoy",
"days_to_send_report": [
"Lunes",
"Martes",
"Miércoles",
"Jueves",
"Viernes",
"Sábado",
"Domingo"
],
"columns": [],
"send_report": "1",
"send_report_email": "test@gmail.com"
},
{
"id": "000003",
"name_report": "Seguimiento completo",
"attached_format": [
"XLS",
"PDF"
],
"asset_groups": [],
"assets": {
"000001": "Activo Simulado 1",
"000002": "Activo Simulado 2"
},
"start_date": "2024-09-25",
"start_time": "00:00:00",
"end_date": "2024-09-25",
"end_time": "23:59:59",
"time_range": "Hoy",
"days_to_send_report": [
"Lunes",
"Martes",
"Miércoles",
"Jueves",
"Viernes",
"Sábado",
"Domingo"
],
"columns": [
"Fecha",
"Hora",
"Activo",
"Conductor",
"Direccion",
"Orientacion",
"Velocidad",
"Evento",
"Latitud",
"Longitud",
"Odometro",
"Lugar mas cercano",
"Placa",
"Temperatura",
"Temperatura2",
"Ver mapa",
"Buffer",
"TimeStamp",
"Geocerca"
],
"send_report": "1",
"send_report_email": "test@gmail.com"
}
]
}Ver campos de respuesta:
| Campo |
Descripción |
Formato |
|---|---|---|
| id |
Identificador único del reporte programado. |
Entero |
| name_report | Nombre del reporte programado. | Cadena de Texto |
| attached_format | Adjuntos que generara el reporte. | Arreglo |
| asset_groups | Grupos de Activos seleccionados | Arreglo |
| assets | Activos seleccionados. | Arreglo |
| start_date | Fecha de inicio del reporte. | Cadena de Texto |
| start_time | Hora de inicio del reporte. | Cadena de Texto |
| end_date | Fecha final del reporte. | Cadena de Texto |
| end_time | Hora final del reporte. | Cadena de Texto |
| time_range | Rango de fechas de ejecución del reporte. | Cadena de Texto |
| days_to_send_report | Días de la semana que se enviara el reporte programado. | Arreglo |
| columns | Columnas seleccionadas. | Arreglo |
| send_report | Enviar automáticamente el reporte por correo. | Entero |
| send_report_email | Correo electrónico en donde se enviara el 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: Para enviar la solicitud del método getScheduledReportResult es necesario tener seleccionado la opción JSON en el formato del reporte en 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== |
| report_id |
(Requerido) Identificador único del reporte programado. El id del reporte programado se puede consultar en el método getProgrammedReports. |
000001 |
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/onreports/getScheduledReportResult' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'report_id="000001"' Respuesta de ejemplo:
{
"status": 200,
"headers": {
"last_execution": "2024-09-25 12:00:00",
"start_datetime": "2024-09-25 00:00:00",
"end_datetime": "2024-09-25 23:59:59",
"execution_id": "87ddc52d2e65e",
"client_id": "123456",
"destination_url": "https://google.com/getTestRequest",
"saved_report_id": "000001",
"saved_report_name": "Reporte de paradas",
"report_type": "",
"selected_assets": {
"000001": "Activo Simulado 1",
"000002": "Activo Simulado 2"
},
"assets_groups": []
},
"data": {
"columns": {
"IdVehiculo": "Activo",
"Fecha": "Fecha",
"Hora": "Hora",
"Placa": "Placa",
"Descripcion": "Descripcion",
"Tiempo_parado": "Tiempo parado",
"Latitud": "Latitud",
"Longitud": "Longitud",
"Domicilio": "Domicilio",
"Lugar": "Lugar",
"Geocerca": "Geocerca",
"grupo_activo": "Grupo Vehiculo",
"link_gm": "Ver mapa"
},
"result": {
{
"activo": "Activo",
"fecha": "2024-09-25",
"hora": "00:00:00",
"placa": "Simulado 1",
"descripcion": "Parado desde 2024-09-25 00:00:00 hasta 2024-09-25 12:00:00",
"tiempo_parado": "12:00:00",
"latitud": "19.032639",
"longitud": "-98.200619",
"domicilio": "1er Rtno. Osa Menor 2-oficina 301, 72810 San Bernardino Tlaxcalancingo, Pue.",
"lugar": "Almacen general",
"geocerca": "Centro de distribución",
"grupo_activo": "",
"link_gm": "<a href=\"https://maps.google.com/?ie=UTF8&q=19.018831, -98.266287\" target=\"_blank\">Ver mapa </a>"
}
}
}
}Ver campos de respuesta:
| Campo |
Descripción |
Formato |
|---|---|---|
| columns |
Columnas del reporte programado. |
JSON |
| result | Información del reporte programado. | JSON |
| headers | JSON con información extra del reporte programado. | JSON |
Formato de respuesta headers
Ver formato:
| Nombre | Descripción | Valor de la propiedad | Ejemplo |
|---|---|---|---|
| Headers |
Formato de respuesta de la petición. |
|
{
"last_execution": "2024-09-25 12:00:00", "start_datetime": "2024-09-25 00:00:00", "end_datetime": "2024-09-25 23:59:59", "execution_id": "87ddc52d2e65e", "client_id": "123456", "destination_url": "https://google.com/getTestRequest",
"saved_report_id": "000001", "saved_report_name": "Reporte de paradas", "report_type": "", "selected_assets": { "000001": "Activo Simulado 1", "000002": "Activo Simulado 2" }, "assets_groups": [] } |