# Activos
Métodos relacionados a los activos
# Lista de vehículos - vehicleGetAll
##### POST https://api.service24gps.com/api/v1/vehicleGetAll
Lista los vehículos asignados al usuario autentificado en la API.
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/vehicleGetAll' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"id": "1980",
"nombre": "Jeep Patriot",
"patente": "NTX9553",
"idgps": "0580012342332337",
"gatewayip": "107.170.254.11",
"conductor": "Salvador Lopez",
"grupo": null,
"marca": "Jeep",
"modelo": "",
"color": "",
"anio": "0",
"numero_serie": "N",
"tipo_vehiculo": "Camioneta"
}
]
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del vehículo dentro de la plataforma. | Entero |
nombre | Nombre que identifica al vehículo en la plataforma.
| Cadena de Texto |
patente | Placa/patente del vehículo.
| Cadena de Texto |
idgps
| Equipo GPS instalado en el vehículo.
| Cadena de Texto |
gatewayip
| IP en la que se encuentra reportando el GPS.
| Cadena de Texto
|
conductor
| Nombre del conductor asociado al vehículo.
| Cadena de Texto
|
grupo
| Nombre del grupo al que pertenece el vehículo.
| Cadena de Texto
|
marca
| Marca del vehículo (VolksWagen, Ford, etc...)
| Cadena de Texto |
modelo
| Modelo del vehículo (Vento, Figo, etc...)
| Cadena de Texto
|
color
| Color de la carrocería del vehículo.
| Cadena de Texto
|
anio
| Indica el año en que fue lanzado a la venta el vehículo.
| Cadena de Texto
|
numero\_serie
| Número de serie asociado al activo.
| Cadena de Texto
|
tipo\_vehiculo
| Indica si el activo es un: automóvil, peatón, etc...
| Cadena de Texto
|
# Lista de vehículos + infoextra - vehicleGetAllComplete
##### POST https://api.service24gps.com/api/v1/vehicleGetAllComplete
Lista los vehículos asignados al usuario autentificado en la API.
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/vehicleGetAllComplete' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"id": "1980",
"nombre": "Auto Test",
"patente": "NTX9553",
"idgps": "0580012342332337",
"gatewayip": "107.170.254.11",
"conductor": "User Test",
"grupo": "Test Group",
"marca": "Ford",
"modelo": "Mustang",
"color": "Rojo",
"anio": "2015",
"numero_serie": "N123456789",
"num_economico": "rd23",
"tipo_vehiculo": "Automovil",
"icono_vehiculo": "./Iconos/Vehiculos/01.png",
"idequipo_gps": "0",
"idtipo_vehiculo": "3",
"idmarca_vehiculo": "0",
"idconductor": "0",
"idgrupo_vehiculo": "0"
}
]
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del vehículo dentro de la plataforma. | Entero |
nombre | Nombre que identifica al vehículo en la plataforma.
| Cadena de Texto |
patente | Placa/patente del vehículo.
| Cadena de Texto |
idgps
| Equipo GPS instalado en el vehículo.
| Cadena de Texto |
gatewayip
| IP en la que se encuentra reportando el GPS.
| Cadena de Texto
|
conductor
| Nombre del conductor asociado al vehículo.
| Cadena de Texto
|
grupo
| Nombre del grupo al que pertenece el vehículo.
| Cadena de Texto
|
marca
| Marca del vehículo (VolksWagen, Ford, etc...)
| Cadena de Texto |
modelo
| Modelo del vehículo (Vento, Figo, etc...)
| Cadena de Texto
|
color
| Color de la carrocería del vehículo.
| Cadena de Texto
|
anio
| Indica el año en que fue lanzado a la venta el vehículo.
| Cadena de Texto
|
numero\_serie
| Número de serie asociado al activo.
| Cadena de Texto
|
num\_economico
| Número económico del vehículo
| Cadena de Texto
|
tipo\_vehiculo
| Indica si el activo es un: automóvil, peatón, etc...
| Cadena de Texto
|
icono\_vehiculo
| URL de la imagen del vehiculo
| Cadena de Texto
|
idequipo\_gps
| Identificador del dispositivo.
| Entero
|
idtipo\_vehiculo
| Identificador del tipo de vehículo.
| Entero
|
idmarca\_vehiculo
| Identificador de la marca del vehiculo.
| Entero
|
idconductor
| Identificador asignado al conductor.
| Entero
|
idgrupo\_vehiculo
| Identificador del grupo que pertenece el vehículo.
| Entero
|
# Listar los contenedores de activos - getDataContainers
##### POST https://api.service24gps.com/api/v1/getDataContainers
Lista todos los contenedores de uno o varios remolques de todos los activos del cliente.
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/getDataContainers' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"unitid": "MTR2",
"unitplate": "MTR2",
"gpsidentif": "5107BE5A902E6256",
"gpsdate": "2022-03-02T23:09:09",
"gpslat": "-15.348761848591401",
"gpslong": "-75.1446473753456",
"event": "Ubicación",
"containers": [
{
"id": "152",
"worder": "2151",
"containerno": "Contedor 1",
"bookingno": "1231",
"client": "User Test",
"origin": "Sonora, Mexico",
"destination": "Puerto Manzanillo, Mexico",
"eta": "15564",
"self_billing": "215",
"naviera": "",
"gross_weight": "500kg"
},
{
"id": "285",
"worder": "2151",
"containerno": "Contedor 2",
"bookingno": "1231",
"client": "User Test",
"origin": "Sonora, Mexico",
"destination": "Puerto Manzanillo, Mexico",
"eta": "15564",
"self_billing": "215",
"naviera": "",
"gross_weight": "500kg"
}
]
}
]
}
```
# Odómetro de activo(s) - getOdometer
##### POST https://api.service24gps.com/api/v1/getOdometer
Este método permíte consultar el odómetro de uno o varios activos en una fecha específica.
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== |
equipo | IMEI o Identificador único del dispositivo configurado en la plataforma. Equipo o equipos separados por “,”
| 0580012342332337 |
fecha
| Fecha en la que se calculará el odómetro del activo. | 2021-04-27 |
hora
| Hora en la que se calculará el odómetro del activo. | 23:59:59 |
odometro\_gps
| Si la fecha se envía vacía devolverá el último odómetro reportado por el GPS. Si se envía una fecha en específico entonces se devolverá el último odómetro reportado para ese día.
0 = Odómetro calculado por la plataforma.
1 = Odómetro reportado por el GPS.
| 1 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/getOdometer' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'equipo="0580012342332337"' \
--form 'fecha="2021-04-27"' \
--form 'hora="23:59:59"' \
--form 'odometro_gps="1"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"0580012342332337": {
"Fecha": "2021-04-27",
"Kilometros": 0,
"Odometro": "0.00",
"Horas": 0
}
}
]
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
Fecha
| Fecha a la que pertenece el odómetro.
| Fecha (aaaa-mm-dd)
|
Kilometros
| Distancia recorrida por el activo en la fecha indicada.
| Distancia en kilómetros
|
Odometro
| Odómetro del activo a la fecha consultada.
| Kilómetros
|
Horas
| Horas de uso de motor correspondientes a la fecha.
| Flotante
|
# Agregar información extra en los detalles de activos. insertPositionData + infoextra
Basado en el documento de protocolo de comunicación **generic** estamos necesitando ingresar información en los reportes del equipo GPS y la misma queremos que se muestre en la plataforma tanto en el detalle nuevo del activo como en los eventos o alertas.
A continuación se muestra dónde se visualiza esta información personalizada, es importante agregar un título llamado **información extra** sobre las filas que se agregan.
Nuevo detalle de eventos y alertas Nuevo detalle del activo en columna o ventana
##### [ ](https://docs.redgps.com/uploads/images/gallery/2022-01/image-1641306003413.png)[](https://docs.redgps.com/uploads/images/gallery/2022-01/image-1641306032499.png)
#### **Uso del método del webservice api/v1/insertPositionData**
##### POST https://api.service24gps.com/api/v1/insertPositionData
Recibe en el body de la petición los siguientes campos: apikey, token, imei, checksum, reports.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
imei | identificador en plataforma del dispositivo | 1234567890 |
checksum | primeros 4 caracteres del md5 de reports | f118 |
reports | string en formato json de ubicaciones | |
reports es un array de objetos, así sea un solo reporte debe estar dentro de un array.
##### Solicitud de ejemplo:
```shell
curl --location --request POST ‘https://api.service24gps.com/api/v1/insertPositionData’\
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'imei="1234567890"' \
--form 'reports="[{\"stamp\":\"20211207230535\",\"latlng\":\"-98.2318825,18.9692315\",\"direction\":62,\"speed\":124,\"satellites\":2,\"event\":42,\"battery\":20,\"infoextra\":{\"qr_buffer\":0,\"qr_id\":\"uid9320824\",\"qr_idProceso\":\"1000\"}}]"' \
--form 'checksum="f118"'
```
##### Respuesta de ejemplo:
```JSON
[{
"stamp":"20211108163547",
"latlng":"-98.2318825,18.9692315",
"direction":202,
"speed":0,
"satellites":5,
"event":17,
"battery":0,
"infoextra": {
"qr_buffer": "0",
"qr_idProceso": "2971599",
"qr_uid": "MiLugar1"
}
}]
```
La información se enviará en los reportes utilizando la llave existente **infoextra** con el método del webservice **api/v1/onapp/insertPositionData**
**Límites: el largo total de “infoextra” + “sensor” y “ad” no debe superar los 5 kb.**

##### Ejemplo de envío de posición:
```JSON
{
"stamp": "20211119235129",
"latlng": "18.9691414,-98.2318728",
"speed": 5.511588048934937,
"direction": 179.85799,
"battery": 87,
"event": "146",
"infoextra": {
"qr_buffer": "0",
"qr_idProceso": "2971599",
"qr_uid": "MiLugar1"
}
}
```
#### Ejemplos de uso de la llave **infoextra** para que sean mostradas dentro de los datos recibidos por el dispositivo.
Para cargar esta información tenemos 3 formatos posibles los cuales cumplen diferentes necesidades.
##### **1. Formato de datos tipo llave valor**
Este formado solo se completa el nombre y el valor a mostrar, es un modo simple de agregar información. Pero tiene la limitante que no se puede dar formato o interacción a esta información dentro de la plataforma.

##### Ejemplo de código:
```JSON
[
{
"stamp": "20211117215015","latlng": "19.0185679,-98.2660656",
"infoextra": {
"lámpara 1": "encendida",
"lámpara 2": "apagada",
"0": "prueba"
}
}
]
```
Así se se mostrará la información dentro de la plataforma:
lámpara 1 encendida |
lámpara 2 apagada |
0 prueba |
##### **2. Formato de datos tipo llave valor extendido**
Este formado tiene más opciones que el anterior, donde podremos definir unidad, color icono y más acciones sobre los elementos que verá el cliente dentro del detalle del activo.
Las llaves requeridas son label y value, para el uso de este, las demás llaves son opcionales.
Tabla de opciones que soporta este tipo de elementos:
**Llave**
| **Requerida**
| **Tipo de valor**
| **Descripción**
|
label
| Sí
| text
| Se utiliza para definir el nombre de la fila a mostrar.
|
value
| Sí
| varchar
| Se utiliza para mostrar el valor de este elemento.
|
unit
| No
| varchar
| Es la unidad que se desea mostrar, ejemplo: “km/h”, ”horas”, ”litros”.
|
color
| No
| hexa
| Se puede definir el color del valor a mostrar, este color incluye el color del valor y su respectiva unidad.
|
icon
| No
| icon-string
| Se puede definir un icono a mostrar antes del valor, los iconos soportados, son los utilizados en la librería de desarrollo de la plataforma.
|
href
| No
| varchar
| Se utiliza para agregar una url y con ello la fila agregada en la plataforma tenga el link a la url especificada.
Soporta variables como \_IMEI\_, \_PLATE\_, \_ASSET\_
|
onclick
| No
| varchar
| Se utiliza si se desea que la fila dentro de la plataforma, ejecute una función javascript.
Soporta variables como \_IMEI\_, \_PLATE\_, \_ASSET\_
|
##### Ejemplo de código:
```JSON
{
"stamp": "20211117215015","latlng": "19.0185679,-98.2660656",
"infoextra": {
"0":{
"label":"lampara 1",
"value": "345.56",
"unit":"litros",
"icon":"i-lock-2",
"color":"#700000",
"href":"http://www.urldestino.com?_PLATE_",
"onclick":"funcionjavascript(_IMEI_)",
},
"1":{
"label":"lampara 1",
"value": "4478",
"unit":"grados",
"icon":"i-gps",
"color":"#005582”
}
}
}
```
Así se se mostrará la información dentro de la plataforma:

##### **3. Formato de datos tipo texto**
Este formato, sirve para mostrar un mensaje tipo texto dentro de la plataforma. El mismo soporta opciones para personalizar el mismo y/o generar acciones. Las llave requerida es text, las demás llaves son opcionales.
Tabla de opciones que soporta este tipo de elementos:
**Llave**
| **Requerida**
| **Tipo de valor**
| **Descripción**
|
text
| Sí
| text
| Se utiliza para definir el texto a mostrar, y el mismo tiene un límite de 255 caracteres. en el caso que envíe más texto, el mismo será truncado.
|
color
| No
| hexa
| Define el color del texto a mostrar.
|
bgcolor
| No
| hexa
| Define el color de fondo de la caja que contiene el texto a mostrar.
|
href
| No
| varchar
| Se utiliza para agregar una url y con ello la fila agregada en la plataforma tenga el link a la url especificada.
Soporta variables como \_IMEI\_, \_PLATE\_, \_ASSET\_
|
onclick
| No
| varchar
| Se utiliza si desea que la fila dentro de la plataforma, ejecute una función javascript.
Soporta variables como \_IMEI\_, \_PLATE\_, \_ASSET\_
|
##### Ejemplo de código:
```JSON
{
"stamp": "20211117215015","latlng": "19.0185679,-98.2660656",
"infoextra": {
"0":{
"text":"aquí debemos agregar el texto que se desea mostrar dentro de la plataforma",
"color":"#700000",
"href":"http://www.urldestino.com?_PLATE_",
"onclick":"funcion_javascript(_IMEI_)",
},
"1":{
"text":"Otro texto que podemos mostrar",
"color":"#005582”,
"bgcolor":"#0034”,
}
}
}
```
Así se se mostrará la información dentro de la plataforma:
aquí debemos agregar el texto que se desea mostrar dentro de la plataforma
|
Otro texto que podemos mostrar
|
# Listar clientes que pertenecen a un activo - getClientsByVehicle
##### POST https://api.service24gps.com/api/v1/getClientsByVehicle
Lista los clientes que están asignados a un activo especifico.
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== |
idvehiculo | Identificador del vehiculo | 8 | 51651 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/getClientsByVehicle' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'\
--form 'idvehiculo="51651"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"idcliente": "42251",
"cliente": "Empresa CEO"
},
{
"idcliente": "1129759",
"cliente": "Sucursal Norte"
},
{
"idcliente": "15470",
"cliente": "Empresa de carga ICO"
},
{
"idcliente": "8229",
"cliente": "Sucursal Sur"
}
]
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
idcliente | Identificador único del cliente. | Entero |
cliente | Nombre del cliente.
| Cadena de Texto |
# Obtener / visualizar los tanques para PEMEX - showTanks
##### POST https://api.service24gps.com/api/v1/showTanks
Se obtiene los reportes de las unidades de los últimos 5 minutos, los valores retornados es un formato requerido por parte del documento de PEMEX**: "Carga de datos de rastreo de autotanques con presentación de servicios para Pemex Logística".**
Ver parámetros de solicitud:
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/showTanks' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"ID_UNIDAD": "XX805",
"FECHA": "08/07/2022 09:57:37",
"LATITUD": "25.39214",
"LONGITUD": "-100.11898",
"VELOCIDAD": "11",
"OBSERVACIONES": "",
"COMPANIA": "ONCETG"
},
{
"ID_UNIDAD": "XX317",
"FECHA": "08/07/2022 09:58:20",
"LATITUD": "27.59561",
"LONGITUD": "-99.58542",
"VELOCIDAD": "0",
"OBSERVACIONES": "",
"COMPANIA": "ONCETG"
}
]
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
ID\_UNIDAD | Placa o nombre de la unidad (activo), sin espacios y guiones.
| Texto |
FECHA | Fecha hora del reporte, Formato: DD/MM/YYY hh:mm:ss
Zona Horaria de la Ciudad de
México
| Date |
LATITUD | Latitud del reporte en formato: **WGS84**
| Texto |
LONGITUD
| Longitud del reporte en formato: **WGS84**
| Texto |
VELOCIDAD | Velocidad del reporte
| Entero |
OBSERVACIONES | Notas o comentarios de la unidad
| Texto |
COMPANIA | Nombre de la compañía o empresa que pertenecen las unidades
| Texto |