# Equipos
# Datos históricos de eventos del equipo - historyGetEvents
##### POST https://api.service24gps.com/api/v1/historyGetEvents
Este método permite consultar los datos históricos de los eventos de un equipo para un rango de fechas y horas especificados.
Ver parámetros de solicitud:
Parámetros | Descripción | Longitud | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 50 | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método [**getToken**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | 500 | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
equipo | IMEI o Identificador único del dispositivo configurado en la plataforma.
| 200
| 0580012342332337 |
fechaIni
| Fecha Inicial de los datos. | 19 | 2021-04-27 00:00:00 |
fechaFin
| Fecha Final de los datos.
| 19
| 2021-04-27 23:59:59 |
format
| Si se pasan horas en **fechaIni** y **fechaFin** debe enviar “**DateTime**”, de lo contrario utilice “**Date**”.
| 8
| DateTime |
idsEvents
| Se específica un o muchos Id de los eventos a consultar, separados por coma sin espacios. Si no se especifican se obtienen todos los eventos que no sean ubicación.
| | 1321,1322,1323,1324,1325,1326,1336,1337,1338,1339 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/historygetevents' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'equipo="0580012342332337"' \
--form 'fechaIni="2021-04-27 00:00:00"' \
--form 'fechaFin="2021-04-27 23:59:59"' \
--form 'format="DateTime"' \
--form 'idsEvents="1321,1322,1323,1324,1325,1326,1336,1337,1338,1339"'
```
```JSON
{
"status": 200,
"data": {
"equipo": "0580012342332337",
"latitud": "19.528530",
"longitud": "--99.171165",
"idstatus": "1",
"gmt": "-6",
"fecha": "2024-01-04",
"hora": "10:14:18",
"fecha_reporte": "20240104101418",
"idevento": "348",
"velocidad": "0",
"orientacion": "0",
"senal": "0",
"satelites": "0",
"inputs": "0|0|0|0|0|0|0|0|0|0|0|0|0|0|0",
"odometro": "0",
"bateria_gps": "86",
"bateria_veh": "0",
"ignicion": "1",
"idconductor": "34110",
"domicilio": "Camino a San Juan Ixtacala 479, San Juan, Gustavo A. Madero, Mexico City, Mexico",
"de_buffer": "0",
"datos_extras": "{\"parameters\":{\"out_1\":\"0\",\"out_2\":\"0\",\"out_3\":\"0\",\"out_4\":\"0\",\"out_5\":\"0\",\"out_6\":\"0\",\"out_7\":\"0\",\"out_8\":\"0\"},\"outputs\":\"0|0|0|0|0|0|0|0\",\"Time_stamp_insert\":\"20210427201542\",\"tipo_dato\":{\"1\":\"2021-04-28 01:15:42\",\"13\":\"2021-04-27 21:04:29\",\"55\":\"2021-04-27 21:04:30\",\"14\":\"2021-04-27 21:05:42\",\"3\":\"2021-04-27 21:03:42\"},\"gw\":\"Escuchar-ST4340-TCP.php\",\"ip\":\"107.170.254.11\",\"kp\":\"6088b73e3a7f5\"}",
"grupo": "CONDUCTORES MX",
"conductor": "CONDUCTOR1",
"patente": "ABC123",
"activo": "ACTIVO 1"
}
}
```
##### Respuesta de ejemplo:
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
equipo
| Número de serie o IMEI que permite identificar el dispositivo.
| Entero
|
latitud
| Latitud de la posición del vehículo.
| Grados decimales
|
longitud
| Longitud de la posición del vehículo.
| Grados decimales
|
idstatus
| Status de la información que reportó el equipo:
1 = Información actual
2 = Información a futuro.
| Entero
|
gmt
| Greenwich Mean Time.
| Cadena de texto
|
fecha
| Fecha de la posición del vehículo.
| DateTime
|
hora
| Hora de la posición del vehículo.
| HH::MM:SS
|
fecha\_reporte
| Fecha y hora de la posición del vehículo.
| Timestamp
|
idevento
| Identificador del evento que reportó el equipo GPS.
| Entero
|
velocidad
| Velocidad en km/h que detecta el equipo GPS.
| Entero
|
orientacion
| Orientación en grados en la que reportó el equipo GPS.
| Entero
|
senal
| Señal GSM del equipo GPS.
| Entero
|
satelites
| Cantidad de satélites.
| Entero
|
inputs
| Estados de cada entrada del equipo:
0 = Desactivada
1 = Activada
| Cadena de texto
|
odometro
| Metros (mts) que ha recorrido el vehículo, detectado por el GPS.
| Entero
|
bateria\_gps
| Porcentaje o voltaje del nivel de la batería interna del GPS.
| Entero | Decimales
|
bateria\_veh
| Voltaje (v) de la batería del vehículo.
| Decimales
|
ignicion
| Status Ignición:
0 = OFF
1 = ON
2 = Desconocida
| Entero
|
IdConductor
| Id del conductor autentificado, Ibutton
| Entero
|
domicilio
| Domicilio.
| Cadena de texto
|
de\_buffer
| Status del tipo de reporte:
0 = Sin Buffer
1 = Buffer
| Entero
|
datos\_extras
| Valores que son obtenidos del protocolo OBDII.
| JSON
|
grupo
| Nombre del grupo que pertenece.
| Cadena de texto
|
conductor
| Nombre del conductor.
| Cadena de texto
|
patente
| Nombre de la patente.
| Cadena de texto
|
activo
| Nombre del activo.
| Cadena de texto
|
# Datos históricos equipo - historyGet
##### POST https://api.service24gps.com/api/v1/historyGet
Este método permite consultar los datos históricos de un equipo para un rango de fechas y horas especificados.
Ver parámetros de solicitud:
Parámetros | Descripción | Longitud | Ejemplo |
---|
apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 50 | 25sdsd234234aa93sdsdsd37c70118e72 |
token | **(Requerido)** Token devuelto por el método getToken. | 500 | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
equipo | **(Requerido)** IMEI o Identificador único del dispositivo configurado en la plataforma.
| 200
| 0580012342332337 |
fechaIni
| **(Requerido)** Fecha Inicial de los datos. | 19 | 2023-03-08 00:00:00 |
fechaFin
| **(Requerido)** Fecha Final de los datos.
| 19
| 2023-03-08 23:59:59 |
format
| **(Requerido)** Si se pasan horas en **fechaIni** y **fechaFin** debe enviar “DateTime”, de lo contrario utilice “Date”.
| 8
| DateTime |
limite
| **(Opcional)** Permite establecer un límite de filas de datos a recibir del WS, si no especifica un límite se regresan todos los datos.
| | 1 |
**Nota:** El limite máximo para consultar datos históricos es de 15 días por equipo.
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/historyGet' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'equipo="0580012342332337"' \
--form 'fechaIni="2023-03-08 00:00:00"' \
--form 'fechaFin="2023-03-08 23:59:59"' \
--form 'format="DateTime"' \
--form 'limite="1"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"equipo": "0580012342332337",
"latitud": "+19.528530",
"longitud": "-99.171165",
"iporigen": "",
"puerto": "",
"idstatus": "1",
"gmt": "-5",
"fecha": "2023-03-08",
"hora": "23:59:39",
"fecha_reporte": "20230308235939",
"idevento": "1",
"velocidad": "0",
"orientacion": "0",
"senal": "65",
"satelites": "20",
"inputs": "0|0|0|0|0|0|0|0|0|0|0|0|0|0|0",
"odometro": "57373562",
"bateria_gps": "100",
"bateria_veh": "13.83",
"ignicion": "1",
"idconductor": "0",
"domicilio": "Camino a San Juan Ixtacala 479, San Juan, Gustavo A. Madero, Mexico City, Mexico",
"de_buffer": "0",
"datos_extras": "{\"parameters\":{\"out_1\":\"0\",\"out_2\":\"0\",\"out_3\":\"0\",\"out_4\":\"0\",\"out_5\":\"0\",\"out_6\":\"0\",\"out_7\":\"0\",\"out_8\":\"0\"},\"outputs\":\"0|0|0|0|0|0|0|0\",\"Time_stamp_insert\":\"20210427201542\",\"tipo_dato\":{\"1\":\"2021-04-28 01:15:42\",\"13\":\"2021-04-27 21:04:29\",\"55\":\"2021-04-27 21:04:30\",\"14\":\"2021-04-27 21:05:42\",\"3\":\"2021-04-27 21:03:42\"},\"gw\":\"Escuchar-ST4340-TCP.php\",\"ip\":\"107.170.254.11\",\"kp\":\"6088b73e3a7f5\"}",
"grupo": "Flota 1",
"conductor": "",
"patente": "ABC-813",
"activo": "Activo-01"
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato | |
---|
equipo
| Número de serie o IMEI que permite identificar el dispositivo.
| Entero
| |
latitud
| Latitud de la posición del vehículo.
| Grados decimales
| |
longitud
| Longitud de la posición del vehículo.
| Grados decimales
| |
iporigen
| Ip de origen de reporte del equipo GPS.
| Cadena de texto
| |
puerto
| Puerto de origen de reporte del equipo GPS.
| Entero
| |
idstatus
| Status de la información que reportó el equipo:
1 = Información actual
2 = Información a futuro.
| Entero
| |
gmt
| Greenwich Mean Time.
| Cadena de texto
| |
fecha
| Fecha
| aaaa-mm-dd
| |
hora
| Hora
| hh:mm:ss
| |
fecha\_reporte
| Fecha hora de la posición del vehículo.
| DateTime
| |
idevento
| Identificador del evento que reportó el equipo GPS.
| Entero
| |
velocidad
| Velocidad en km/h que detecta el equipo GPS.
| Entero
| |
orientacion
| Orientación en grados en la que reportó el equipo GPS.
| Entero
| |
senal
| Señal GSM del equipo GPS.
| Entero
| |
satelites
| Cantidad de satélites.
| Entero
| |
inputs
| Estados de cada entrada del equipo:
0 = Desactivada
1 = Activada
| Cadena de texto
| |
odometro
| Metros (mts) que ha recorrido el vehículo, detectado por el GPS.
| Entero
| |
bateria\_gps
| Porcentaje o voltaje del nivel de la batería interna del GPS.
| Entero | Decimales
| |
bateria\_veh
| Voltaje (v) de la batería del vehículo.
| Decimales
| |
ignicion
| Status Ignición:
0 = OFF
1 = ON
2 = Desconocida
| Entero
| |
IdConductor
| Id del conductor autentificado, Ibutton
| Entero
| |
de\_buffer
| Status del tipo de reporte:
0 = Sin Buffer
1 = Buffer
| Entero
| |
datos\_extras
| Valores que son obtenidos del protocolo OBDII.
| JSON
| |
grupo
| Nombre del grupo
| Cadena de texto
| |
conductor
| Nombre del conductor
| Cadena de texto
| |
patente
| Patente del activo
| Cadena de texto
| |
activo
| Nombre del activo
| Cadena de texto
| |
# Obtener listado de marcas y modelos - getBrandsAndModels
##### POST https://api.service24gps.com/api/v1/getBrandsAndModels
Obtiene el listado completo de marcas y modelos de dispositivos disponibles en la plataforma.
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:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/getBrandsAndModels' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"id": "299",
"marca": "Zenda",
"modelos": [
{
"id": "77",
"modelo": " ZD-VT2"
},
{
"id": "1006",
"modelo": "ZD-VT1"
}
]
},
{
"id": "150",
"marca": "Yulongda technology limited",
"modelos": [
{
"id": "1474",
"modelo": "GT06H"
},
{
"id": "371",
"modelo": "YuLongDa GT06"
}
]
},
{
"id": "384",
"marca": "Accurate Technology",
"modelos": [
{
"id": "1533",
"modelo": "TK100"
}
]
}
]
}
```
# Obtener alertas por día - getAlerts
##### POST https://api.service24gps.com/api/v1/getAlerts
Obtiene las alertas generadas en la fecha indicada por un equipo o todos los equipos del usuario.
Ver parámetros de solicitud:
Parámetros | Descripción | Longitud | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 50 | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | 500 | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
equipo | Equipo o equipos del cual se requieren las alertas (si es vacío regresa alertas de todos los activos). | 200 | |
fecha | Fecha de la cual se desean obtener las alertas (si se envía vacía se obtienen las alertas del día en curso). | 10 | |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/getAlerts' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'equipo="354148072188807"' \
--form 'fecha="2022-02-24"' \
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"Equipo": "354148072188807",
"Fecha": "2022-02-24",
"Hora": "08:16:16",
"Descripcion": "Unidad Generó BOTON DE PANICO el 2022/02/24 08:16:16
",
"Latitud": "18.98043888996881",
"Longitud": "-98.22312211997996",
"Domicilio": "Boulevard Periférico Ecológico, Constitución Loma Bella, 72474 Puebla, Puebla",
"StatusAlerta": "FUERA DE LA GEOCERCA",
"TipoAlerta": "Geocerca E/S"
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato | |
---|
Equipo | Equipo asignado al vehículo que ejecutó la alerta. | Entero | |
Fecha | Fecha en la que la alerta se ejecutó. | DateTime | |
Hora | Hora de la alerta (se maneja en formato de 24 hrs.)
| DateTime | |
Descripción
| Texto descriptivo de la alerta.
| Cadena de Texto | |
Latitud
| Latitud correspondiente al punto en que se originó la alerta.
| Flotante
| |
Longitud
| Longitud correspondiente al punto en que se originó
la alerta.
| Flotante
| |
Domicilio
| Dirección correspondiente a la latitud y longitud
reportada por el equipo.
| Cadena de Texto
| |
StatusAlerta
| Nombre del estado del alerta, puede ser los siguientes:
- IGNICIÓN ON
- IGNICIÓN OFF
- DENTRO DE LA GEOCERCA
- FUERA DE LA GEOCERCA
- TEMPERATURA LIMITE INFERIOR
- TEMPERATURA LIMITE SUPERIOR
| Cadena de Texto
| |
TipoAlerta
| Nombre del tipo de alerta que se generó.
| Cadena de Texto
| |
# Lista de eventos - getEventTypes
##### POST https://api.service24gps.com/api/v1/getEventTypes
Obtiene el listado de todos los eventos disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros | Descripción | Longitud | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 50 | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | 500 | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/getEventTypes' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"1": "Ubicación",
"2": "Botón SigMen",
"3": "Activo Detenido",
"4": "Botón de Pánico ON",
"5": "Puerta Conductor",
...
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del evento en el sistema.
| Entero |
nombre | Nombre del evento
| Texto |
# Lista de sensores - GetSensors
##### POST https://api.service24gps.com/api/v1/getSensors
Obtiene el listado de todos los sensores disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros | Descripción | Longitud | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 50 | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método **[getToken](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef)**. | 500 | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/getSensors' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"1": "Ignición ON / OFF",
"2": "Desconexión de Batería Principal",
"3": "Botón de Pánico",
"4": "Corte Remoto de Combustible",
"5": "Apertura / Cierre de puertas",
...
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del sensor.
| Entero |
nombre | Nombre del sensor
| Texto |