# WebService
# Introducción
El objetivo del presente documento es explicar brevemente la interface de integración con los diferentes servicios que ofrece la Plataforma de Monitoreo, por parte de sus clientes o empresas externas autorizadas.
### Tecnología de integración
Para la integración de los Servicios Web de la Plataforma de Monitoreo, se ha diseñado una arquitectura abierta, segura y compatible con las tecnologías más utilizadas en la industria actualmente, es por ello que la interface que ofrecemos se encuentra desarrollada bajo los estándares de RESTful Web Services según se describe en el presente documento.
### Requisitos para uso de los servicios web
Para poder utilizar los Servicios Web, cada cliente/distribuidor deberá solicitarlo previamente describiendo las características que necesita integrar así como los usuarios para los que solicita el acceso, una vez obtenida la autorización, le será entregada un `APIKEY` (llave de identificación) que lo identificará en nuestros servicios y diferentes características que le fueron autorizadas.
### Observaciones
Se deja expresa constancia que la arquitectura e interface que aquí se documenta pertenece a nuestras soluciones, y nos reservamos el derecho de modificar o ajustar la misma en forma total o parcial a nuestro solo criterio, en la medida que lo consideremos necesario. Quienes utilizan esta interface reconocen que ante cualquier cambio deberán ajustar sus productos o herramientas según lo requiera sin ningún tipo de reclamo o perjuicio para nosotros.
### Especificaciones de uso
- Todas las peticiones al servicio serán realizadas utilizando el método web POST a través de la dirección URL [https://api.service24gps.com/api/v1/](https://api.service24gps.com/api/v1/) seguido de la acción a realizar descritas en el presente documento.
- Entre cada petición debe existir una diferencia mínima de treinta segundos.
- En todas las peticiones se deben enviar las llaves de autenticación `APIKEY` y `TOKEN` a través de parámetros.
- La respuesta siempre es devuelta en formato json e incluye los campos status y data.
- Los parámetros de cada petición se deben enviar como está especificado en la documentación de cada método, el cual es susceptible a mayúsculas y minúsculas.
# Método de autenticación - getToken
##### POST https://api.service24gps.com/api/v1/gettoken
Para obtener acceso las aplicaciones y herramientas de los clientes deben solicitar a través del servicio una llave (Token) de autenticación que le permitirá hacer uso de los servicios durante **seis horas continuas**, una vez transcurrido este periodo de tiempo, se debe volver a solicitar otro Token de autenticación.
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 | Debe ir en blanco como cadena vacía. | 500 | |
| username | Un usuario autorizado para usar el servicio por parte del cliente y debe estar definido previamente. | 150 | usuario |
| password | Contraseña asociada al usuario. | 50 | contraseña |
| get\_info | Opcional, si se desea obtener el idusuario, usuario, idcliente, nombre de cliente, token y el tiempo restante del token se debe utilizar este parámetro. | 1 | 0 |
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 | Debe ir en blanco como cadena vacía. |
500 | |
| username | Un usuario autorizado para usar el servicio por parte del cliente y debe estar definido previamente. |
150 | usuario |
| password | Contraseña asociada al usuario. |
50 | contraseña |
| get\_info | Bandera (1 o 0) para obtener además del token el tiempo restante de vida del mismo, información de usuario y cliente. |
1 | 1 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id\_user | Identificador único del usuario en plataforma. | Entero |
| id\_cli | Identificador único del cliente en plataforma. | Entero |
| name\_user | Nombre del usuario en plataforma.
| Cadena de Texto |
| name\_cli
| Nombre del cliente en plataforma.
| Cadena de Texto |
| token
| Cadena de texto que ayuda a autenticarte.
| Cadena de Texto
|
| time\_left
| Cantidad de minutos restantes para el uso del token
| Cadena de Texto
|
**IMPORTANTE:** No recomendamos utilizar este método para consultar de forma recurrente las posiciones de todos los Activos. Si necesitas recibir continuamente la información reportada por tus Activos en un sistema externo, utiliza un [Web Service genérico](https://docs.redgps.com/books/webservices-de-retransmision-de-datos/page/webservice-de-reenvio-generico/es).
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== |
| UseUTCDate | Valor booleano (Opcional por defecto es 0)
0 = Como la envió la unidad de rastreo.
1 = Especifica si la fecha del reporte es en formato UTC.
| 1
| 0 |
| sensores | Valor booleano
0 = No trae la información de los sensores.
1 = Especifica si se desea obtener la información de sensores.
| 1
| 1 |
**Nota:** Los campos con valor **-1** se refieren que no se han enviado por el dispositivo de rastreo.
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| UnitId | Valor por el qué es identificada la unidad o vehículo. | Cadena de Texto |
| UnitPlate | Se refiere a la placa/patente del vehículo. | Cadena de Texto |
| GpsIdentif | Número de serie o IMEI que permite identificar el dispositivo de rastreo
| Cadena de Texto, con longitud de 16 caracteres. |
| ReportDate
| Fecha/hora de la posición
| aaaa-mm-dd hh:mm:ss |
| Latitude
| Latitud de la posición del vehículo.
| Grados decimales
|
| Longitude
| Longitud de la posición del vehículo.
| Grados decimales
|
| UrlLocation
| Url de localización
| Cadena de Texto
|
| Altitude
| Altitud de la posición del vehículo.
| Metros
|
| GpsSpeed
| Orientación del vehículo, Norte, Sur, Este, etc. | Kilómetros / hora |
| Direction
| N,S,E,O,NO,NE,SO,SE
| Orientación del vehículo, Norte, Sur, Este, etc.
|
| Satellites
| Número de satélites con Fix de la posición.
| Entero
|
| Ignition
| Status Ignición:
0 = OFF
1 = ON
2 = Desconocida
| Entero
|
| Odometer
| Odómetro del vehículo en la posición.
| Metros
|
| IdEvento
| Identificador del evento que reportó el equipo GPS.
| Entero
|
| Domicilio
| Dirección correspondiente a la latitud y longitud reportada por el equipo.
| Cadena de texto
|
| Puerto
| Puerto de origen de reporte del equipo GPS.
| Entero
|
| IpOrigen | Ip de origen de reporte del equipo GPS | Cadena de texto
|
| BateriaGps
| Nivel de voltaje o porcentaje del equipo GPS
| Cadena de texto
|
| BateriaVeh
| Nivel de voltaje de la fuente conectada al GPS.
| Cadena de texto
|
| Grupo
| Nombre del grupo al que pertenece el vehículo.
| Cadena de texto
|
| Conductor
| Nombre del conductor asociado al vehículo.
| Cadena de texto
|
| Inputs
| Estados de cada entrada del equipo:
0 = Desactivada
1 = Activada.
| Cadena de texto
|
| TipoDato
| Tipo de dato.
| Cadena de texto
|
| Senal
| Señal del equipo GPS.
| Entero
|
| Fecha/hora de inserción.
| aaaa-mm-dd hh:mm:ss
|
| Sensores
| Json de datos de los sensores
| JSON
|
Ver formato:
| Nombre | Descripción | Valor de la propiedad | Ejemplo |
|---|
| **Sensores** | Formato de respuesta de la petición.
| - **82:** Id del sensor.
- **Bateria\_gps:** nombre del sensor.
- Valores enviados por el equipo relacionado al sensor (Consulta el listado de sensores en [**getSensors**](https://docs.redgps.com/books/webservice/page/lista-de-sensores-getsensors)).
| "82":{ "Bateria\_gps":{ "nombre": "Bateria\_gps", "valor": "0", "fecha": "2023-03-14 12:01:51" } |
**IMPORTANTE:** No recomendamos utilizar este método para consultar de forma recurrente las posiciones de todos los Activos. Si necesitas recibir continuamente la información reportada por tus Activos en un sistema externo, utiliza un [Web Service genérico](https://docs.redgps.com/books/webservices-de-retransmision-de-datos/page/webservice-de-reenvio-generico/es).
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== |
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
|
| odometro
| Valor del odometro.
| Cadena de Texto
|
| tipo\_vehiculo
| Indica si el activo es un: automóvil, peatón, etc.
| Cadena de Texto
|
| notas
| Información adicional del vehículo.
| Cadena de Texto
|
| idgrupo\_vehiculo
| Identificador único del grupo que pertenece el vehículo.
| Cadena de Texto
|
**IMPORTANTE:** No recomendamos utilizar este método para consultar de forma recurrente las posiciones de todos los Activos. Si necesitas recibir continuamente la información reportada por tus Activos en un sistema externo, utiliza un [Web Service genérico](https://docs.redgps.com/books/webservices-de-retransmision-de-datos/page/webservice-de-reenvio-generico/es).
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== |
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
|
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== |
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 |
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
|
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 | |
**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:
| **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
|
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 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idcliente | Identificador único del cliente. | Entero |
| cliente | Nombre del cliente.
| Cadena de Texto |
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== |
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 |
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Respuesta de ejemplo:
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| Id | Identificador único del grupo de activos.
| Entero |
| name | Nombre del grupo de activos.
| Cadena de texto. |
| idcliente\_sistema
| Identificador único del cliente.
| Cadena de texto. |
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| licencia | **(Opcional)** Número de Licencia. | 123456 |
**Nota:** Si requiere solo la información de un conductor en especifico, debe mandar en la solicitud el parámetro **licencia** con el número de licencia que tiene asignado el conductor.
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/driverGetAll' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"id": "43530",
"numero": "0987654321",
"alias": "test_new_driver",
"nombre": "Test Nombre",
"apellido": "New Driver",
"identificador": "TEST0987654NWD",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR001",
"licencia": "78979TEST123",
"vigencia": "2022-05-14",
"direccion": "test de domicilio de conductor test",
"email": "test@test.com",
"idvehiculo": "37922",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test1",
"usuario": "driver_test1",
"password": "MTIzNDU2"
},
{
"id": "43531",
"numero": "0987654321",
"alias": "test_new_driver2",
"nombre": "Test Nombre 2",
"apellido": "New Driver 2",
"identificador": "TEST89956156",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR002",
"licencia": "78979TEST1232",
"vigencia": "2022-05-15",
"direccion": "test de domicilio de conductor test2",
"email": "test2@test.com",
"idvehiculo": "37923",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test2",
"usuario": "driver_test2",
"password": "MTIzNDU2"
},
{
"id": "43532",
"numero": "098765432133",
"alias": "test_new_driver3",
"nombre": "Test Nombre 3",
"apellido": "New Driver 3",
"identificador": "TEST895662563",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR003",
"licencia": "78979TEST1233",
"vigencia": "2022-06-15",
"direccion": "test de domicilio de conductor test3",
"email": "test3@test.com",
"idvehiculo": "37924",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test3",
"usuario": "driver_test3",
"password": "MTIz"
}
]
}
```
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único asignado al conductor.
| Entero |
| numero | Código interno para identificar al conductor.
| Cadena de texto |
| alias | Nombre alterno para identificar al conductor.
| Cadena de texto |
| nombre
| Nombre del conductor. | Cadena de texto
|
| apellido
| Apellido del conductor.
| Cadena de texto
|
| identificador
| Código de iButton o RFID asignado al conductor.
| Cadena de texto
|
| fecha\_alta
| Fecha en que se creó el conductor en el sistema.
| Date (aaaa-mm-dd) |
| telefono | Identificador único de la ruta en el sistema.
| Cadena de texto |
| cedula
| Número de cédula.
| Cadena de texto |
| licencia
| Número de licencia.
| Cadena de texto |
| vigencia
| Fecha en que expira la licencia del conductor.
| Date (aaaa-mm-dd) |
| direccion
| Ubicación del domicilio del conductor.
| Cadena de texto |
| email
| E-mail de contacto del conductor.
| Cadena de texto |
| idvehiculo
| Id del vehículo asignado al conductor.
| Entero |
| idgrupo
| Id del grupo al que pertenece el conductor.
| Entero |
| nombregrupo
| Nombre del grupo al que pertenece el conductor.
| Cadena de texto |
| observaciones
| Observaciones realizadas por el operador.
| Cadena de texto |
| usuario
| Usuario del conductor.
| Cadena de texto |
| password
| Contraseña del conductor codificada en base64.
| Cadena de texto |
Todos los **parámetros** deben enviarse en la solicitud, los marcados con **\*** es obligatorio que tengan un valor.
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== |
| nombre | Nombre del conductor. \*
| Test Nombre 3 |
| apellido
| Apellido del conductor.
| New Driver 3
|
| alias
| Nombre alterno para identificar al conductor.
| test\_new\_driver3
|
| identificador
| Código de iButton o RFID asignado al conductor.
| TEST895662563
|
| numero
| Código interno para identificar al conductor.
| 0987654321
|
| telefono
| Número de teléfono del conductor. \*
| 1234567890
|
| cedula
| Número de cédula.
| FSGBSTR003
|
| licencia
| Número de licencia. \*
| 78979TEST1233
|
| vigencia
| Fecha en que expira la licencia del conductor. \*
| 2022-06-15
|
| direccion
| Ubicación del domicilio del conductor. \*
| test de domicilio de conductor test3
|
| email
| E-mail de contacto del conductor. \*
| test3@test.com
|
| idvehiculo
| Id del vehículo asignado al conductor. \*
| 37924
|
| observaciones
| Observaciones realizadas por el operador.
| Observación de conductor test3
|
| idgrupo
| Identificador del grupo
| 3
|
| user
| Usuario del conductor. **(Opcional)**
| driver\_test3
|
| password
| Contraseña del conductor. **(Opcional)**
| pass123
|
**Nota**: Si el **usuario** a crear ya existe, se mostrará el siguiente mensaje.
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"code": 30700,
"message": "No se pudo crear el usuario driver_test"
}
}
```
# Actualizar conductor - updateDriver
##### POST https://api.service24gps.com/api/v1/updateDriver
Permite realizar la modificación de la información de un conductor. **\* Campos requeridos.**
Todos los **parámetros** deben enviarse en la solicitud, los marcados con **\*** es obligatorio que tengan un valor.
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== |
| Id del conductor \*
| 123456 |
| nombre | Nombre del conductor. \*
| Update Test Nombre 3 |
| apellido
| Apellido del conductor.
| New Driver 3
|
| alias
| Nombre alterno para identificar al conductor.
| test\_new\_driver3
|
| identificador
| Código de iButton o RFID asignado al conductor.
| TEST895662563
|
| numero
| Código interno para identificar al conductor.
| 0987654321
|
| telefono
| Número de teléfono del conductor. \*
| 1234567890
|
| cedula
| Número de cédula.
| FSGBSTR003
|
| licencia
| Número de licencia. \*
| 78979TEST1233
|
| vigencia
| Fecha en que expira la licencia del conductor. \*
| 2022-06-15
|
| direccion
| Ubicación del domicilio del conductor. \*
| test de domicilio de conductor test3
|
| email
| E-mail de contacto del conductor. \*
| test3@test.com
|
| idvehiculo
| Id del vehículo asignado al conductor.
| 37924
|
| observaciones
| Observaciones realizadas por el operador.
| Observación de conductor test3
|
| idgrupo
| Identificador del grupo
| 0
|
| user
| Usuario del conductor. **(Opcional)**
| driver\_test3
|
| password
| Contraseña del conductor. **(Opcional)**
| pass123
|
**Nota**: El **usuario** a actualizar debe pertenecer al cliente, de lo contrario no se realiza la actualización y se muestra el siguiente mensaje.
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"code": 30700,
"message": "El usuario driver_test3 ya existe"
}
}
```
# Eliminar conductor - deleteDriver
##### POST https://api.service24gps.com/api/v1/deleteDriver
Este método permite eliminar un conductor especifico.
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== |
| idConductor | Identificador único del conductor en el sistema.
| 138225 |
**Nota:** Si en la respuesta de la solicitud aparece **"status": 30700** es un error al obtener los datos.
##### Respuesta de ejemplo:
```JSON
{
"status": 30700,
"data": ""
}
```
# Listar conductores con grupo y vehículo - driverInfoGetAll
##### POST https://api.service24gps.com/api/v1/driverInfoGetAll
Obtiene la lista de todos los conductores del cliente con la relación vehículo y grupo conductor.
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único asignado al conductor.
| Entero |
| numero | Código interno para identificar al conductor.
| Cadena de texto |
| alias | Nombre alterno para identificar al conductor.
| Cadena de texto |
| nombre
| Nombre del conductor. | Cadena de texto
|
| apellido
| Apellido del conductor.
| Cadena de texto
|
| identificador
| Código de iButton o RFID asignado al conductor.
| Cadena de texto
|
| fecha\_alta
| Fecha en que se creó el conductor en el sistema.
| Date (aaaa-mm-dd) |
| telefono | Identificador único de la ruta en el sistema.
| Cadena de texto |
| cedula
| Número de cédula.
| Cadena de texto |
| licencia
| Número de licencia.
| Cadena de texto |
| vigencia
| Fecha en que expira la licencia del conductor.
| Date (aaaa-mm-dd) |
| direccion
| Ubicación del domicilio del conductor.
| Cadena de texto |
| email
| E-mail de contacto del conductor.
| Cadena de texto |
| idvehiculo
| Id del vehículo asignado al conductor.
| Entero |
| idgrupo
| Id del grupo al que pertenece el conductor.
| Entero |
| observaciones
| Observaciones realizadas por el operador.
| Cadena de texto |
| idgrupo\_conductor
| Identificador del grupo que pertenece el conductor.
| Entero |
| nombrevehiculo
| Nombre del vehículo.
| Cadena de texto |
| patente
| Patente del vehículo.
| Cadena de texto |
| nombregrupo
| Nombre del grupo al que pertenece el conductor.
| Cadena de texto |
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== |
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== |
| licencia | Número de licencia. | 78979TEST123 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único asignado al conductor.
| Entero |
| numero | Código interno para identificar al conductor.
| Cadena de texto |
| alias | Nombre alterno para identificar al conductor.
| Cadena de texto |
| nombre
| Nombre del conductor. | Cadena de texto
|
| apellido
| Apellido del conductor.
| Cadena de texto
|
| identificador
| Código de iButton o RFID asignado al conductor.
| Cadena de texto
|
| fecha\_alta
| Fecha en que se creó el conductor en el sistema.
| Date (aaaa-mm-dd) |
| telefono | Identificador único de la ruta en el sistema.
| Cadena de texto |
| cedula
| Número de cédula.
| Cadena de texto |
| licencia
| Número de licencia.
| Cadena de texto |
| vigencia
| Fecha en que expira la licencia del conductor.
| Date (aaaa-mm-dd) |
| direccion
| Ubicación del domicilio del conductor.
| Cadena de texto |
| email
| E-mail de contacto del conductor.
| Cadena de texto |
| idvehiculo
| Id del vehículo asignado al conductor.
| Entero |
| idgrupo
| Id del grupo al que pertenece el conductor.
| Entero |
| nombregrupo
| Nombre del grupo al que pertenece el conductor.
| Cadena de texto |
| observaciones
| Observaciones realizadas por el operador.
| Cadena de texto |
| usuario
| Usuario del conductor.
| Cadena de texto |
| password
| Contraseña del conductor.
| Cadena de texto |
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== |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único del cliente
| Entero |
| nombre | Nombre asignado al cliente
| Texto |
| es\_suspendido | Bandera o estado si está o no suspendido,.
1 = suspendido
0 = no suspendido
| Booleano |
| razon\_social | Razón social del cliente
| Texto |
| cuit\_rfc | RFC del cliente
| Texto |
| ciudad | Ciudad de dónde es el cliente
| Texto |
| domicilio | Domicilio o dirección de dónde es el cliente
| Texto |
| telefonos | Teléfono(s) del cliente
| Texto |
| Contacto(s) del cliente
| Texto |
| email | Correo electrónico del cliente
| Texto |
| last\_update | Fecha Hora de la última actualización del cliente
| FechaHora |
| fecha\_suspendido | Fecha de cuándo se suspendió el cliente
| Fecha |
| es\_activo | Bandera o estado si está activo o no el cliente.
1 = activo
0 = no activo
| Booleano |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e7 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| **(Opcional)** Identificador único del cliente. **Sólo cuando se va actualizar.** | 11 |
| **(Requerido)** Nombre que va tener el cliente. | Test nombre |
| razon\_social | **(Requerido)** Razón social del cliente. | Test Razon Social |
| idzona\_horaria | **(Opcional)** Identificador único de la zona horaria
\- Obtener los tipos en el método **[getTimeZone](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-de-zonas-horarias-gettimezone).**
| 1 |
| IdTipo\_informacion\_tributaria | **(Opcional)** Identificador del tipo de información tributaria.
\- Si no requiere tipo, se asigna 0
\- Obtener los tipos en el método **[getTypesTax](https://docs.redgps.com/books/webservice/page/listar-tipos-tributarios-gettypestax).**
| 5 |
| email | **(Requerido)** Correo del cliente. | test@test.com |
| rfc | **(Opcional)** RFC del cliente. | RFC0123456789 |
| ciudad | **(Opcional)** Ciudad de dónde es el cliente. | Puebla |
| domicilio | **(Opcional)** Domicilio o dirección del cliente. | Test domicilio |
| codpostal | **(Opcional)** Código postal de la ubicación del cliente. | 72111 |
| contactos | **(Opcional)** Datos del contacto. | test contacto |
| telefonos | **(Opcional)** Teléfono(s) para contactar al cliente. | 2228562144 |
| descripcion | **(Opcional)** Alguna descripción o información del cliente. | Test Cliente Descripcion |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único del cliente
| Entero |
Ver parámetros de solicitud:
| **Parámetros** | **Parámetros** | **Ejemplo** |
| apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| Identificador único del cliente. | 11 |
| Valor a actualizar:
1 = suspende
0 = activa
| 1
|
| razon\_suspend | Razón, motivo o causa del porque se suspende. | motivo test |
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== |
| Identificador único del cliente | 11 |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único del usuario
| Entero |
| nombre | Nombre asignado al usuario
| Texto |
| usuario | Nombre del usuario, para después iniciar sesión en plataforma
| Texto |
| last\_update | Fecha hora de la última actualización del usuario
| FechaHora |
| last\_update\_password | Fecha hora de la última actualización de la contraseña del usuario
| FechaHora |
| es\_activo | Bandera o estado si está activo o no el cliente, 1 = activo, 0 = no activo
| Booleano |
| loginas | Link o url para el inicio de sesión de la plataforma
| Texto |
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)** o token devuelto por plataforma. | 500 | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| iduser | Identificador único del usuario en plataforma. | Entero |
| idcliente | Identificador único del cliente en plataforma. | Entero |
| nameuser | Nombre del usuario en plataforma.
| Cadena de Texto |
| nameclient
| Nombre del cliente en plataforma.
| Cadena de Texto |
| user
| Usuario para ingresar a plataforma.
| Cadena de Texto
|
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| **(Opcional)** Identificador único del usuario. **Sólo cuando se va actualizar.** | | 1 |
| **(Requerido)** Nombre que va tener el usuario. | | User 111 |
| user | **(Requerido)** Usuario con el que se va autenticar. | | user\_111 |
| password | **(Requerido)** Contraseña para el usuario. | | 123456 |
| email | **(Requerido)** Correo electrónico del usuario. | | user111@gmail.com |
| idcliente | **(Requerido)** Identificador único del cliente al que va pertenecer el usuario. | | 11 |
| idzona\_horaria | **(Opcional)** Identificador único de la zona horaria.
\- Obtener los tipos en el método **[getTimeZone](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-de-zonas-horarias-gettimezone).**
| | 1 |
| parar\_motor | **(Opcional)** Activar comando de paro de motor.
1 = Si
0 = No | | 0 |
| enviar\_sms | **(Opcional)** Enviar comando y alertas por SMS.
1 = Si
0 = No | | 0 |
| cargar\_geocercas\_al\_inicio | **(Opcional)** Cargar geocercas al inicio de cada sesión.
1 = Si
0 = No | | 1 |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único del usuario
| Entero |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e7 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| **(Requerido)** Nombre que va tener el activo. | Test nombre |
| tipo\_vehiculo | **(Requerido)** Identificador único del tipo del activo.
- Obtener los tipos en el método **[getVehiclesType](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-tipo-de-vehiculos-getvehiclestype)[.](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-tipo-de-vehiculos-getvehicletype)** | 1 |
| marca | **(Opcional)** Identificador único de marca del activo.
- Obtener los tipos en el método **[getVehiclesBrands](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-marcas-de-activos-getvehiclesbrands)**[**.**](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-marcas-de-activos-getbrandtype) | 1 |
| modelo | **(Requerido)** Modelo del activo. | Mazda |
| anio | **(Opcional)** Año del activo.
| 2017 |
| patente | **(Opcional)** Patente del activo. | test123 |
| idcliente | **(Opcional)** Identificador único del cliente. | 11 |
| equipo\_gps | **(Requerido)** Equipo GPS del activo. | 123456789 |
| color | **(Opcional)** Color del activo. | Negro |
| numero\_serie | **(Opcional)** Número de serie del activo. | 55500056544 |
| numero\_motor | **(Opcional)** Número de motor del activo. | M211 |
| numero\_economico | **(Opcional)** Número económico del activo. | 0227 |
| rendimiento\_combustible | **(Opcional)** Rendimiento del combustible. | 0 |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único del activo.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idvehiculo | **(Requerido)** Identificador único del vehículo a actualizar. | 11 |
| **(Requerido)** Nombre que va ocupar el vehículo. | Activo 01 |
| modelo | **(Opcional)** Nombre del modelo del vehículo. | Ibiza |
| anio | **(Opcional)** Año del vehículo. | 2021 |
| numero\_economico | **(Opcional)** Número económico del vehículo. | 2 |
| estado | **(Requerido)** Bandera, para establecer si está activo o no el vehículo:
1 = Activo
0 = No activo
| 1 |
| patente | **(Opcional)** Placa o patente del vehículo. | XX-AAA-10 |
| patente\_caja | **(Opcional)** Placa o patente del vehículo, si tiene caja o remolque. | XX-AAA-11 |
| color | **(Opcional)** Color del vehículo. | Rojo |
| rendimiento\_combustible | **(Opcional)** El rendimiento del combustible del vehículo. | 1 |
| numero\_serie | **(Opcional)** El número de serie del vehículo. | SERIE-XXX-10 |
| numero\_motor | **(Opcional)** Número de motor del vehículo. | MOTOR-XXX-11 |
| **(Requerido)** Nombre del equipo GPS del activo. Ver en endpoint: [**getDevices**](https://docs.redgps.com/books/webservice/page/obtener-dispositivos-getdevices) | 123123123156 |
**Nota:** El **equipo\_gps** no debe estar asignado a otro activo, debe estar disponible.
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/updateAsset' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--from 'idvehiculo="11"' \
--form 'nombre="Activo 01"' \
--form 'model="Ibiza"' \
--form 'anio="2021"' \
--form 'numero_economico="11"' \
--form 'estado="1"' \
--form 'patente="XX-AAA-10"' \
--form 'patente_caja="XX-AAA-11"' \
--form 'color="Rojo"' \
--form 'rendimiento_combustible="1"' \
--form 'numero_serie="SERIE-XXX-10"' \
--form 'numero_motor="MOTOR-XXX-11"' \
--form 'equipo_gps="123123123156"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": 11
}
```
Ver campos de respuesta:
| Campo | **Descripción**
| **Formato** |
|---|
| id | Identificador único del vehículo
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idvehiculo | **(Requerido)** Identificador único del vehículo. | 110011 |
| **(Opcional)** Identificador único del cliente | 42106 |
| cliente | **(Requerido)** Nombre del cliente | User Test |
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== |
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== |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único de la tarjeta sim
| Entero |
| nombre | Nombre asignado a la tarjeta sim
| Texto |
| compania | Nombre de la compañía de la tarjeta sim
| Texto |
| numero | Número de la tarjeta sim
| Entero |
| nip | Número personal de la tarjeta sim
| Entero |
| notas | Descripción para la tarjeta sim
| Texto |
| fecha\_alta | Fecha de cuando se creó la tarjeta sim
| Fecha |
| mb\_plan | Megabytes del plan (sólo si tiene)
| Entero |
| es\_prepago | Bandera o estado si de prepago la tarjeta sim, 1 = prepago, 0 = no prepago
| Booleano |
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== |
| idsim | Identificador único de la tarjeta sim.
**Sólo cuando se va actualizar.**
| 11 |
| Nombre que va tener la tarjeta sim \* | Sim 01 |
| nro\_tel | Número telefónico de la tarjeta sim \* | 2224567810 |
| nro\_nip | NIP de la tarjeta sim \* | 1120 |
| Identificado único de la compania (Se obtiene del endpoint: **getCompaniasCelular**) | 2 |
| Bandera, para establecer si es prepago o no.
1 = Prepago
2 = No prepago
| 1 |
| Descripción o información extra de las notas | Esta es mi sim 01 |
| Cantidad de megabytes en el plan | 10 |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único de la tarjeta sim
| Entero |
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. | SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw== |
| imei | **(Requerido)** Identificador único / imei del dispositivo gps.
| 6d7b91026765abcd |
| checksum | **(Requerido)** Primeros 4 caracteres del md5 de reports.
| e71a |
| reports
| **(Requerido)** String en formato json de ubicaciones
| \[
{
"stamp": "20220502184600",
"latlng": "4.6892583,-74.1159799",
"direction": 0,
"speed": 0,
"sig": 10,
"satellites": 15,
"event": 1,
"battery": 40,
"bat": 100,
"odm": 500,
"bato": 50,
"acc": 1,
"alt": "10",
}
\]
|
Nota: **reports** es un array de objetos, así sea un solo reporte debe estar dentro de un array.
Ver tabla de parámetros reports:
| Parámetros | Descripción | Ejemplo |
|---|
| stamp | **(Requerido)** Fecha y hora en GMT 0. | "stamp": "20230510235500" |
| latlng | **(Requerido)** Latitud y longitud. | "latlng": "4.6892583,-74.1159799" |
| direction | **(Requerido)** Dirección.
| "direction": 0 |
| speed | **(Requerido)** Velocidad del dispositivo.
| "speed": 0 |
| sig | (Opcional) Señal GSM.
Entre 0-10
| "sig": 10 |
| satellites | **(Requerido)** Satélite. | "satellites": 15
|
| event | **(Requerido)** Tipo de evento.
Ejemplo:
1: Ubicación
2: Botón SigMen
Obtener listado de eventos en [**getEventTypes**](https://docs.redgps.com/books/webservice/page/lista-de-eventos-geteventtypes)
| "event": 1
|
| battery | **(Requerido)** Batería del dispositivo.
Entre 0 - 100 %
| "battery": 40
|
| bato | (Opcional) Batería Vehículo.
Entre 0 - 100 volts
| "bato": 100
|
| acc | (Opcional) Estado de ignición.
Ejemplo:
1: Encendido
0: Apagado
| "acc": 1
|
| odm | (Opcional) Odómetro.
| "odm": 500
|
| alt | (Opcional) Altitud.
| "alt": "10"
|
| ad | (Opcional) Información adicional para el envió de información de sensores en formato JSON.
|
|
| infoextra | (Opcional) Información extra para el dispositivo en formato JSON.
| "infoextra": { "qr\_buffer": "0", "qr\_idProceso": "2971599", |
**Nota:** La key "**errors**" es un array con todos los errores encontrados al procesar las tramas. En los errores se usa el mismo índice que en las tramas para relacionar en que reporte se originó.
##### Respuesta de ejemplo si el checksum no coincide:
```JSON
{
"status": 200,
"data": {
"checksum": "3824",
"match_checksum": 0
}
}
```
##### Tipos de formato en infoextra
Ver formatos:
| Formato | Descripción | Nombre de la propiedad | Valor de la propiedad | Ejemplo |
|---|
| **Tipo llave valor** | Este formato solo se completa el nombre y el valor a mostrar, es un modo simple de agregar información.
Tiene la limitante que no se puede dar formato o interacción a esta información dentro de la plataforma.
| "lampara 1" | "encendido" | "infoextra":{ "lampara 1": "encendido", "lampara 3": "encendido" } |
| **Tipo llave valor extendido** | Este formato tiene mas opciones, donde podremos definir las acciones sobre los elementos que vera el cliente dentro del detalle del activo.
**Llave:**
- **(Requerido)** label
- **(Requerido)** value
- (Opcional) unit
- (Opcional) color
- (Opcional) icon
- (Opcional) href
- (Opcional) onclick
| "label" | "Litros"
| "infoextra":{ "0":{ "label": "Litros", "value": "11.12", "unit": "litros", "icon": "i-lock-2", "color": "#987456", "href": "https://example.com", "onclick": "function\_litro(\_litro\_)" }, "1":{ "label": "Litros 2", "value": "114.2", "unit": "litros", "icon": "i-lock-2", "color": "#158456" } } |
| **Tipo llave texto** | Este formato sirve para mostrar un mensaje de tipo texto dentro de la plataforma.
**Llave:**
- **(Requerido)** text
- (Opcional) color
- (Opcional) bgcolor
- (Opcional) href
- (Opcional) onclick
| "text"
| "Mensaje de prueba"
| "infoextra":{ "0":{ "text": "Mensaje de prueba", "color": "#987456", "bcolor": "#284650", "href": "https://example.com", "onclick": "function\_msg(\_msg\_)" }, "1":{ "text": "Mensaje a plataforma", "color": "#458756", } } |
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== |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único del dispositivo
| Entero |
| nombre | Nombre asignado al dispositivo, regularmente es el IMEI.
| Texto |
| tipo | Tipo de dispositivo.
| Texto |
| marca | Marca del dispositivo
| Texto |
| modelo | Modelo del dispositivo
| Texto |
| imei | Código pregrabado del dispositivo
| Texto |
| numero telefónico | Número celular del dispositivo
| Texto |
| estado | Bandera o estado si está activo o no el dispositivo, 1 = activo, 0 = no activo
| Booleano |
| notas | Nota extra o descripción del dispositivo
| Texto |
| idsim | Identificador único de la tarjeta sim (chip telefónico)
| Entero |
| fecha\_alta | Fecha de la alta del dispositivo
| Fecha |
| idcliente\_propietario | ID del cliente propietario del Activo
| Entero |
| cliente\_propietario | Nombre del cliente propietario del Activo
| Texto |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e7 |
| token | **(Requerido)** Token devuelto por el método **[getToken](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef)**. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| **(Opcional)** Tipo de equipo.
- Obtener los tipos en el método **[getTypesDevices](https://docs.redgps.com/books/webservice/page/gettypesdevice).** | 1 |
| nombre | **(Requerido)** Nombre del equipo. | 000123 |
| imei | **(Opcional)** IMEI del equipo. | 000123 |
| marca | **(Requerido)** Marca del equipo.
\- Obtener los tipos en el método **[getBrands.](https://docs.redgps.com/books/webservice/page/getbrands)**
| 1 |
| modelo | **(Requerido)** Modelo del equipo.
- Obtener los tipos en el método **[getModels.](https://docs.redgps.com/books/webservice/page/getmodel)** | 1 |
| chip\_telefonico | **(Opcional)** Número telefónico. | 2222112233 |
| idzona\_horaria | **(Opcional)** Identificador único de la zona horaria.
\- Obtener los tipos en el método **[getTimeZone](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-de-zonas-horarias-gettimezone).**
| 1 |
| idpais | **(Opcional)** Identificador único del país.
\- Obtener los países en el método **[getCountrys](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-de-paises-getcountrys)**
| 1 |
**Nota:** Cuando supere el límite permitido para crear equipos se mostrará la siguiente respuesta.
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": 30700,
"message": "This is a Free account, it has exceeded the allowed limit of created devices"
}
}
```
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| Nombre | Nombre del equipo.
| Texto |
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== |
| **(Opcional)** Identificador único del dispositivo a actualizar | 11 |
| idsim | **(Opcional)** Identificador único de la tarjeta sim (chip telefónico). Ver endpoint: **getSims** | 9 |
| **(Requerido)** Nombre que va ocupar el dispositivo, puede ser el imei del equipo, según el tipo de marca. | 87198978126384923 |
| **(Opcional)** Identificador único de los tipos disponibles. Ver en endpoint: **getTypesDevices** | 1 |
| **(Opcional)** Identificador único de las marcas disponibles. Ver en endpoint: **getBrands** | 2 |
| **(Opcional)** Identificador único de los modelos disponibles. Ver en endpoint: **getModels** | 1 |
| estado | **(Opcional)** Bandera, para establecer si está activo o no el dispositivo.
1 = Activo
0 = No activo
| 0 |
| imei | **(Opcional)** Imei del dispositivo | 87198978126384923 |
| notas | **(Opcional)** Descripción o texto extra para el dispositivo | Este es un dispositivo nuevo, de la marca Suntech |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único del dispositivo
| Entero |
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== |
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
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== |
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== |
| idmodelo | Identificador único del modelo del equipo a consultar.
Los modelos disponibles en plataforma se obtienen en el método [**getModels**](https://docs.redgps.com/books/webservice/page/getmodel). | 1 |
• Cuatribanda GSM (850 / 900 / 1800 / 1900 Mhz). • Sensor de movimiento y alertas vibratorias. • Diseñado para uso personal o vendedores. • Habilitado para actualizaciones remotas. • Programable con botón de pánico para emergencias. • Resistente al agua, estandar IPX5. • 10 a 12 días de rastreo con una sola carga.
",
"descripcion": "TT8750 es un potente localizador GPS, que está diseñado para los animales domésticos, vehículos y bienes de seguimiento. con sensibilidad de recepción superior, TTFF rápido y GSM frecuencias 850/900/1800/1900. Su ubicación puede ser en tiempo real o programar un seguimiento por el servidor back-end o terminales especificados. Sobre la base de la protocolo integrado, TT8750 puede comunicarse con el servidor de back-end a través de GPRS / GSM informes de la red, y la transferencia de Geo-cercas, el estado del dispositivo de emergencia y GPS programado posición.
",
"desc_corta": "El TT8750 es el dispositivo de seguimiento perfecto con GPS en tiempo real para aplicaciones compactas y encubiertas que requieren de 1 a 2 semanas de duracion de batería.
"
}
]
}
```
# Datos del cliente - getClientData
##### POST https://api.service24gps.com/api/v1/getClientData
Este método devuelve la información del cliente que esta ocupando el apikey.
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del cliente. | Entero |
| nombre | Nombre asignado al cliente. | Cadena de Texto |
| razon\_social | Razón social del cliente.
| Cadena de Texto |
| cuit\_rfc
| RFC (Registro Federal de Contribuyentes) del cliente.
| Cadena de Texto |
| ciudad
| Ciudad de origen del cliente.
| Cadena de Texto
|
| domicilio
| Domicilio o dirección del cliente.
| Cadena de Texto
|
| codpostal
| Código postal del cliente.
| Cadena de Texto
|
| contactos
| Nombre de contacto(s) del cliente. | Cadena de Texto |
| telefonos
| Número de contacto(s) del cliente.
| Cadena de Texto
|
| skype
| Skype del cliente. | Cadena de Texto
|
| email
| Correo electrónico del cliente.
| Cadena de Texto
|
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== |
| idCliente | Identificador único del cliente. | 11 |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| imei | Imei del dispositivo
| Texto |
| dispositivo | Nombre del dispositivo | Texto |
| sim | Nombre del chip telefónico o sim
| Texto |
| nro\_telefonico | Número del chip telefónico o sim
| Texto |
| activo | Nombre del activo o vehículo
| Texto |
| placa | Placa del vehículo.
| Texto |
| fecha\_de\_alta\_sim | Fecha de cuando se creó la sim en el sistema
| Texto |
| fecha\_de\_alta\_imei | Fecha de cuando se creó el dispositivo
| Texto |
| fecha\_de\_alta\_activo | Fecha de cuando se creó el activo/vehículo
| Texto |
| marca | Nombre de la marca del dispositivo
| Texto |
| modelo | Nombre del modelo del dispositivo
| Texto |
| idvehiculo | Identificador único del vehículo
| Texto |
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== |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único del tipo tributario.
| Entero |
| nombre | Nombre del tipo tributario.
| Texto |
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. | SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw== |
| client | **(Requerido) String en formato json de datos del cliente a crear**
| {
"city":"ciudad",
"country\_id":"2",
"time\_zone\_id":"16",
"state\_id":"21",
"postal\_code":"72000",
"phone":"1234567890",
"email":"correo@host.com",
"name":"nombre",
"register\_number":"numero registro",
"business\_name":"nombre",
"full\_address":"direccion",
"custom\_field":\[
{
"name":"nombre campo uno",
"value":"valor uno"
},
{
"name":"nombre campo dos",
"value":"valor dos"
}
\]
}
|
| users | **(Requerido) String en formato json de** datos para crear usuarios..
| \[
{
"name": "nombre usuario",
"username": "usuario",
"password": "contraseña",
"email": "correo@host.com",
"assets": \[
"placa"
\],
"profile\_id": 1,
"send\_email\_welcome": 1
},
{
"name": "nombre usuario",
"username": "usuario",
"password": "contraseña",
"email": "correo@host.com",
"assets": \[
"placa"
\],
"profile\_id": 1,
"send\_email\_welcome": 0
}
\]
|
| assets | **(Requerido)** String en formato json de datos para crear equipos, activos y sims
| \[
{
"asset": {
"name": "activo",
"plate": "placa",
"asset\_type\_id": "1",
"asset\_brand\_id": "5",
"model": "2022",
"year": "2022",
"custom\_field": \[
{
"name": "nombre campo uno",
"value": "valor uno asset"
},
{
"name": "nombre campo dos",
"value": "valor uno asset"
}
\]
},
"device": {
"device\_type\_id": "1",
"name": "equipo",
"imei\_uid": "2022202220222022",
"brand\_id": "1",
"model\_id": "1",
"time\_zone\_id": "16",
"unlink\_vehicle": "2023-01-01"
},
"sim": {
"name": "nombre",
"company\_id": "1",
"phone\_number": "12345678900",
"nip\_number": "123456"
},
"IdSensors\_template": 1415
}
\]
|
Nota: users y assets son un array de objetos, así sea un solo elemento debe estar dentro de un array.
Ver tabla de parámetros client:
| Parámetros | Descripción | Ejemplo |
|---|
| city | **(Requerido)** Ciudad. | "city": "ciudad"
|
| country\_id | **(Requerido)** Id pais. | "country\_id": "2" |
| time\_zone\_id | **(Requerido)** Id zona horaria. | "time\_zone\_id":"16" |
| state\_id | (Opcional) Estado. | "state\_id":"21", |
| postal\_code | (Opcional) Código postal. | "postal\_code": 72000 |
| phone | (Opcional) Teléfono. | "phone":"1234567890"
|
| email | (Opcional) Correo electrónico. | "email":"correo@host.com"
|
| name | **(Requerido)** Nombre. | "name":"nombre"
|
| register\_number | (Opcional) RFC. | "register\_number":"numero registro"
|
| business\_name | (Opcional) Razón social. | "business\_name":"nombre"
|
| full\_addres | (Opcional) Domicilio. | "full\_address":"direccion"
|
| custom\_fields | (Opcional) Campos personalizados. | "custom\_field":\[
{
"name":"nombre campo uno",
"value":"valor uno"
}, {
"name":"nombre campo dos",
"value":"valor dos"
}
\] |
Ver tabla de parámetros users:
| Parámetros | Descripción | Ejemplo |
|---|
| name | (Opcional) Nombre del usuario. | "name": "nombre usuario" |
| username | **(Requerido)** Usuario. | "username": "usuario" |
| password | (Opcional) Contraseña. | "password": "contraseña" |
| email | **(Requerido)** Correo. | "email": "correo@host.com" |
| assets | (Opcional) activos. | "assets": \[
"placa"
\] |
| profile\_id | (Opcional) Grupo sistema. | "profile\_id": 1
|
| send\_email\_welcome | (Opcional) Enviar correo de bienvenida. | "send\_email\_welcome": 0
|
Ver tabla de parámetros assets:
| Parámetros | Descripción | Ejemplo |
|---|
| asset | **(Requerido)** String en formato json de vehículo | "name": "nombre usuario"
{
"name": "activo",
"plate": "placa",
"asset\_type\_id": "1",
"asset\_brand\_id": "5",
"model": "2022",
"year": "2022",
"custom\_field": \[
{
"name": "nombre campo uno",
"value": "valor uno asset"
},
{
"name": "nombre campo dos",
"value": "valor uno asset"
}
\]
}
|
| device | **(Requerido)** String en formato json de Equipo. | {
"device\_type\_id": "1",
"name": "equipo",
"imei\_uid": "202220222022202212055",
"brand\_id": "1",
"model\_id": "1",
"time\_zone\_id": "16",
"unlink\_vehicle": "2023-01-01"
}
|
| sim | **(Requerido)** String en formato json de chip. | {
"name": "sim12055",
"company\_id": "1",
"phone\_number": "1234567890012055",
"nip\_number": "123456"
}
|
| IdSensors\_template | (Opcional) Plantilla. | "IdSensors\_template": 1415 |
Ver tabla de parámetros asset:
| Parámetros | Descripción | Ejemplo |
|---|
| name | **(Requerido)** Nombre. | "name": "activo12055",
|
| plate | **(Requerido)** Placa. | "plate": "placa" |
| asset\_type\_id | **(Requerido)** Id tipo. | "asset\_type\_id": "1" |
| marca | (Opcional) Id Marca. | "asset\_brand\_id": "5" |
| model | (Opcional) Modelo. | "model": "2022" |
| year | (Opcional) Año. | "year": "2022", |
| assets | (Opcional) Campos personalizados. | "custom\_field": \[ {
"name":"nombre campo uno",
"value":"valor uno asset"
}, {
"name":"nombre campo dos",
"value":"valor uno asset"
}\] |
Ver tabla de parámetros device:
| Parámetros | Descripción | Ejemplo |
|---|
| device\_type\_id | **(Requerido)** Id tipo dispositivo. | "device\_type\_id": "1" |
| name | **(Requerido)** Nombre. | "name": "equipo" |
| imei\_uid | (Opcional) Imei. | "imei\_uid": "202220222022202212055" |
| brand\_id | **(Requerido)** Id marca. | "brand\_id": "1" |
| model\_id | **(Requerido)** Id modelo. | "model\_id": "1" |
| time\_zone\_id | (Opcional) Id zona horaria. | "time\_zone\_id": "16"
|
| unlink\_vehicle | (Opcional) Fecha. | "unlink\_vehicle": "2023-01-01"
|
Ver tabla de parámetros sim:
| Parámetros | Descripción | Ejemplo |
|---|
| name | **(Requerido)** Nombre. | "name": "sim12055" |
| company | (Opcional) Id compania. | "company\_id": "1" |
| phone\_number | **(Requerido)** Númeor de telefono. | "phone\_number": "1234567890012055" |
| nip\_number | (Opcional) nip. | "nip\_number": "123456" |
Ver campos de respuesta:
| **Descripción**
| **Tipo** |
| Descripción cliente creado
| JSON |
| Listado usuarios creados
| JSON |
| Listado tarjetas creadas
| JSON |
| Listado equipos creados
| JSON |
| Listado activos creados
| JSON |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método [**getToken**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método [**getToken**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método [**getToken**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
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== |
| asset\_id | **(Requerido)** Identificador único del Activo en el sistema.
| 123456 |
**Nota:** Si no existe el registro del Activo se mostrará un mensaje de error.
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": 40100,
"message": "The vehicle does not exist"
}
}
```
# Eliminar equipo GPS - deleteDevice
##### POST https://api.service24gps.com/api/v1/deleteDevice
Este método permite eliminar un Equipo GPS especifico y los Activos asociados al equipo.
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== |
| device\_id | **(Requerido)** Identificador único del Equipo GPS en el sistema.
El identificador se puede obtener en el método [**getDevices.**](https://docs.redgps.com/books/webservice/page/obtener-dispositivos-getdevices)
| 123456 |
**Nota:** Si no existe el registro del Equipo GPS se mostrará un mensaje de error.
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": 40100,
"message": "The GPS device does not exist"
}
}
```
# Obtiene el listado de paises - getCountrys
##### POST https://api.service24gps.com/api/v1/getCountrys
Obtiene el listado de países.
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método [**getToken**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| licencia | **(Opcional)** Número de Licencia. | 123456 |
**Nota:** Si requiere solo la información de un conductor en especifico, debe mandar en la solicitud el parámetro **licencia** con el número de licencia que tiene asignado el conductor.
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/driverGetAll' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"id": "43530",
"numero": "0987654321",
"alias": "test_new_driver",
"nombre": "Test Nombre",
"apellido": "New Driver",
"identificador": "TEST0987654NWD",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR001",
"licencia": "78979TEST123",
"vigencia": "2022-05-14",
"direccion": "test de domicilio de conductor test",
"email": "test@test.com",
"idvehiculo": "37922",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test1",
"cliente": "DEMO Cliente 1",
"usuario": "driver_test1",
"password": "cGFzczEyMw==",
"idcliente": "6660"
},
{
"id": "43531",
"numero": "0987654321",
"alias": "test_new_driver2",
"nombre": "Test Nombre 2",
"apellido": "New Driver 2",
"identificador": "TEST89956156",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR002",
"licencia": "78979TEST1232",
"vigencia": "2022-05-15",
"direccion": "test de domicilio de conductor test2",
"email": "test2@test.com",
"idvehiculo": "37923",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test2",
"cliente": "DEMO Cliente 2",
"usuario": "driver_test2",
"password": "g7z8zGFzcyM78=",
"idcliente": "6661"
},
{
"id": "43532",
"numero": "098765432133",
"alias": "test_new_driver3",
"nombre": "Test Nombre 3",
"apellido": "New Driver 3",
"identificador": "TEST895662563",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR003",
"licencia": "78979TEST1233",
"vigencia": "2022-06-15",
"direccion": "test de domicilio de conductor test3",
"email": "test3@test.com",
"idvehiculo": "37924",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test3",
"cliente": "DEMO Cliente 3",
"usuario": "driver_test3",
"password": "c789epczEyM78=",
"idcliente": "6662"
}
]
}
```
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único asignado al conductor.
| Entero |
| numero | Código interno para identificar al conductor.
| Cadena de texto |
| alias | Nombre alterno para identificar al conductor.
| Cadena de texto |
| nombre
| Nombre del conductor. | Cadena de texto
|
| apellido
| Apellido del conductor.
| Cadena de texto
|
| identificador
| Código de iButton o RFID asignado al conductor.
| Cadena de texto
|
| fecha\_alta
| Fecha en que se creó el conductor en el sistema.
| Date (aaaa-mm-dd) |
| telefono | Identificador único de la ruta en el sistema.
| Cadena de texto |
| cedula
| Número de cédula.
| Cadena de texto |
| licencia
| Número de licencia.
| Cadena de texto |
| vigencia
| Fecha en que expira la licencia del conductor.
| Date (aaaa-mm-dd) |
| direccion
| Ubicación del domicilio del conductor.
| Cadena de texto |
| email
| E-mail de contacto del conductor.
| Cadena de texto |
| idvehiculo
| Id del vehículo asignado al conductor.
| Entero |
| idgrupo
| Id del grupo al que pertenece el conductor.
| Entero |
| nombregrupo
| Nombre del grupo al que pertenece el conductor.
| Cadena de texto |
| observaciones
| Observaciones realizadas por el operador.
| Cadena de texto |
| cliente
| Nombre del cliente al que pertenece el conductor
| Cadena de texto |
| usuario
| Usuario del conductor.
| Cadena de texto |
| password
| Contraseña del conductor.
| Cadena de texto |
| idcliente
| Id del cliente al que pertenece el conductor
| Entero |
**IMPORTANTE:** No recomendamos utilizar este método para consultar de forma recurrente las posiciones de todos los Activos. Si necesitas recibir continuamente la información reportada por tus Activos en un sistema externo, utiliza un [Web Service genérico](https://docs.redgps.com/books/webservices-de-retransmision-de-datos/page/webservice-de-reenvio-generico/es).
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del vehículo. | Entero |
| nombre | Nombre asignado al vehículo | Cadena de Texto |
| patente | Patente del vehículo
| Cadena de Texto |
| idgps
| identificador gps
| Cadena de Texto |
| gatewayip
| ip del gateway
| Cadena de Texto
|
| conductor
| Nombre del conductor
| Cadena de Texto
|
| grupo
| Nombre del grupo
| Cadena de Texto
|
| marca
| Marca del vehículo | Cadena de Texto
|
| modelo
| Modelo del vehículo
| Cadena de Texto
|
| color
| Color de vehículo
| Cadena de Texto
|
| anio
| Año del vehículo
| Cadena de Texto
|
| numero\_serie
| Numero de serie
| Cadena de Texto
|
| num\_economico
| Número económico
| Cadena de Texto
|
| tipo\_vehiculo
| Tipo de activo (Automovil, Camión, etc...)
| Cadena de Texto
|
| icono\_vehiculo
| Icono asignado al activo en la plataforma
| Cadena de Texto
|
| ignorar\_equipo
| Indica si se deben descartar las tramas del equipo
| Entero
|
| Identificador único del equipo gps
| Entero
|
| Identificador único del tipo de activo
| Entero
|
| Identificador único de la marca del activo
| Entero
|
| Identificador único del conductor
| Entero
|
| Identificador único del grupo al que pertenece el activo
| Entero
|
| Id del cliente propietario del activo
| Entero
|
| Nombre del cliente propietario del activo
| Cadena de Texto
|
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==
|
| num\_factura | Número de la factura | 8 | **23435** |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| listado de plataformas.
| JSON |
| Listado de clasificaciones.
| JSON |
| Listado de tipos.
| JSON |
| Listado de acciones.
| JSON |
| Listado de status ticket.
| JSON |
**Nota**: El método **gettickets** solo muestra los tickets de clientes que están habilitados, si están eliminados no se mostrará la información en la respuesta.
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](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef)**. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idCliente | **(Opcional)** Identificador único del cliente.
-Consultar el id de los clientes en el método **[getClients](https://docs.redgps.com/books/webservice/page/getclients)**. | 16572 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| Identificador único del ticket en el sistema.
| Entero |
| Nombre del cliente.
| Cadena de Texto |
| Nombre asignado al ticket.
| Cadena de Texto |
| Número telefónico del contacto.
| Cadena de Texto
|
| Correo electrónico del contacto.
| Cadena de Texto
|
| Nombre de la plataforma.
| Cadena de Texto
|
| Nombre de la clasificación.
| Cadena de Texto
|
| Nombre del tipo del ticket.
| Cadena de Texto |
| Descripción sobre el ticket.
| Cadena de Texto
|
| Estatus del ticket.
| Cadena de Texto
|
| Fecha del ticket.
| Cadena de Texto
|
| Hora del ticket.
| Cadena de Texto
|
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== |
| nombre | Nombre con el que se identificará el ticket dentro de la plataforma.
| cliente |
| telefono
| Número telefónico de contacto
| 123456789
|
| email
| Correo electrónico de contacto
| test@test.com |
| idPlataforma
| Identificador único de plataforma
| 1 |
| idClasificacion
| Identificador único de clasificación
| 1 |
| idTipo
| Identificador único de tipo
| 1 |
| idCliente
| Identificador único de cliente
| 1 |
| activos
| Lista de activos separados por coma
| activo 1. activo2, activo 3 |
| fechaInicio
| Fecha inicio
| 2022-01-01 |
| fechaFin
| Fecha fin
| 2022-01-21 |
| descripcion
| Descripción sobre el ticket.
| Buena tarde, Se solicita apoyo |
Ver campos de respuesta:
| idticket | Identificador único del ticket
| Entero |
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== |
| file\[\]
| Arreglo de archivos
| file\[\]=@"/home/Usuario/Escritorio/prueba.jpg"
file\[\]=@"/home/Usuario/Escritorio/cliente.jpg"
|
Ver campos de respuesta:
| Url imagenes | Url de las imagenes
| JSON |
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](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef)**[.](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef) | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| IdTicket | **(Requerido)** Identificador único de ticket a responder.
| 288282 |
| IdAccionticket
| **(Requerido)** Identificador único de acción.
| 3
|
| descripcion
| **(Requerido)** Descripción sobre el detalle del ticket.
| Buena tarde, Se solicita apoyo |
| alertamail
| **(Requerido)** Bandera para enviar alerta por mail **(true)** o no **(false).**
| true |
| alertasms
| **(Requerido)** Bandera para enviar alerta por sms **(true)** o no **(false).**
| false |
| alertasoporte
| **(Requerido)** Bandera para enviar a soporte **(true)** o no **(false).**
| false |
| mostraralusuario
| **(Requerido)** Bandera para mostrar al usuario **(true)** o no **(false).**
| false |
| imageurl
| **(Opcional)** Array de url de imágenes devuelto por el método **[uploadimageticket.](https://docs.redgps.com/books/webservice/page/subir-imagenes-para-ticket-uploadimageticket)**
| \['https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQUumUUHBnkkeyb0oTT5GnX6dgjYN1wAmp5ohsRZB3YcQ&s=10' \] |
| idstatus\_ticket
| **(Opcional)** Identificador único de status del ticket.
El catálogo de status ticket se puede obtener en el método [**getDataTicket**.](https://docs.redgps.com/books/webservice/page/lista-de-datos-para-generar-ticket)
| 3 |
Ver campos de respuesta:
| idticket | Identificador único del detalle del ticket.
| Entero |
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](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef).** | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| Idticket | **(Requerido)** Identificador único del ticket. | 898915 |
Estimados, solicito el apoyo para obtener la información de mi equipo.
\n",
"Detalle": [
{
"Idticket_detalle": "33547,
"Usuario": "cliente1",
"Fecha": "2023-07-10",
"Hora": "09:01:52",
"Respuesta": "Hola buenos días:\n\nle daremos seguimiento al tema.",
"Leido": "No"
},
{
"Idticket_detalle": "33546
"Usuario": "cliente1",
"Fecha": "2023-07-05",
"Hora": "15:49:34",
"Respuesta": "Hola buenos dias, pueden enviar el número del equipo.",
"Leido": "Sí"
},
{
"Idticket_detalle": "33545,
"Usuario": "cliente1",
"Fecha": "2023-07-05",
"Hora": "09:27:42",
"Respuesta": "Buenos días, se envió la información. \n\nsaludos",
"Leido": "Sí"
}
]
}
}
```
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| Identificador único del ticket.
| Entero |
| Descripción del ticket.
| Texto |
| Detalle del ticket.
| JSON |
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 |
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
|
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/history/get' \
--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
| |
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== |
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken/es). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idgrupo | **(Opcional)** Identificador único del grupo de Activos. Este parámetro tiene prioridad sobre **equipo;** si se especifica, la consulta se realizará para los Activos pertenecientes al grupo indicado. Para obtener los identificadores disponibles, consulte el método **[getAssetGroups.](https://docs.redgps.com/books/webservice/page/listado-de-grupo-de-activos-getassetgroups/es)**
**Nota:** Si se desea realizar la consulta únicamente para un equipo, este parámetro debe enviarse vacío.
| 45665 |
| equipo | **(Requerido)** IMEI del equipo del cual se desean obtener las alertas. Este parámetro será considerado únicamente cuando **idgrupo** no se especifique.
| |
| fecha\_inicio | **(Requerido)** Fecha de inicio del rango para la consulta de alertas. | |
| fecha\_fin | **(Requerido)** Fecha de fin del rango para la consulta de alertas. | |
Si los parámetros **idgrupo** y **equipo** se envían vacíos, la consulta devolverá las alertas de todos los Activos asociados al usuario.
Si ambos campos de fecha se dejan vacíos, la consulta se realizará para el día actual.
Solo es posible consultar rangos de hasta **14 días**.
##### Solicitud de ejemplo:
```shell
curl --location 'https://api.service24gps.com/api/v1/getAlerts' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idgrupo="45665"' \
--form 'equipo="354148072188807"' \
--form 'fecha_inicio="2026-08-01"' \
--form 'fecha_fin="2026-08-14"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"Equipo": "354148072188807",
"Fecha": "2026-08-10",
"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. | Cadena de Texto | |
| 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.
| Cadena de Texto
| |
| Longitud
| Longitud correspondiente al punto en que se originó
la alerta.
| Cadena de Texto
| |
| 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
| |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del evento en el sistema.
| Entero |
| nombre | Nombre del evento
| Texto |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del sensor.
| Entero |
| nombre | Nombre del sensor
| Texto |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idCerca | Identificador único de la geocerca en el sistema.
| Entero |
| idtipo\_cerca | Indica el tipo de geocerca.
1 = Poligonal o dibujo
2 = Circular
3 = Lineal o ruta
| Entero |
| tipo\_cerca | Nombre del tipo de geocerca.
| Cadena de Texto |
| nombre | Nombre con el que se identifica la geocerca dentro de la plataforma.
| Cadena de Texto |
| color
| Color con el que se muestra e identifica la geocerca en la plataforma.
| Cadena de Texto **(RGB hexadecimal)** |
| puntos
| Punto o puntos que conforman la geocerca.
| JSON
|
| radio
| Radio en metros que abarca la **geocerca circular**.
| Entero
|
| limite\_velocidad
| Velocidad máxima (Km/h) permitida en la geocerca.
| Entero
|
| solo\_mi\_usuario
| Indica si la geocerca solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
| Entero |
| visible
| Indica si la geocerca se debe o no mostrar.
1 = Mostrar
0 = Ocultar
| Entero
|
| umbral
| Datos de la **geocerca lineal o ruta**, el cual contiene los puntos del polígono y la tolerancia.
| JSON
|
| grupo
| Nombre del grupo que pertenece la geocerca.
| Cadena de Texto
|
| compartida
| Indica si la geocerca es compartida.
1 = Compartida
0 = No compartida
| Entero
|
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| nombre | **(Requerido)** Nombre con el que se identificará la geocerca dentro de la plataforma.
| GeoHome |
| puntos
| **(Requerido)** Punto o puntos que conformarán la geocerca.
| \[{"lat":-12.087574155453476,"lng":-77.08396062254906},{"lat":-12.087672508218587,"lng":-77.08401560783386},{"lat":-12.087707915205174,"lng":-77.08394654095173},{"lat":-12.087658083148632,"lng":-77.08388954401016},{"lat":-12.087618086359699,"lng":-77.08389893174171},{"lat":-12.08758989189834,"lng":-77.08392508327961},{"lat":-12.08757546682392,"lng":-77.08395726978779}\]
|
| tipo\_cerca
| **(Requerido)** Indica el tipo de geocerca a crear.
1 = Poligonal o dibujo
2 = Circular
3 = Lineal o ruta.
| 1 |
| color
| **(Opcional)** Color con el que se mostrará e identificará la geocerca en la plataforma, en formato RGB hexadecimal.
| \#223344 |
| radio
| **(Opcional)** Radio en metros que abarcará la geocerca circular.
| 0 |
| limite\_velocidad
| **(Opcional)** Velocidad máxima (Km/h) permitida en la geocerca.
| 50 |
| solo\_mi\_usuario
| **(Opcional)** Indica si la geocerca solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
| 1 |
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== |
| idCerca | **(Requerido)** Identificador único de la geocerca en el sistema.
| 138225 |
| nombre | Nombre con el que se identificará la geocerca dentro de la plataforma.
| GeoHome |
| puntos
| Punto o puntos que conformarán la geocerca.
| \[{"lat":-12.087574155453476,"lng":-77.08396062254906},{"lat":-12.087672508218587,"lng":-77.08401560783386},{"lat":-12.087707915205174,"lng":-77.08394654095173},{"lat":-12.087658083148632,"lng":-77.08388954401016},{"lat":-12.087618086359699,"lng":-77.08389893174171},{"lat":-12.08758989189834,"lng":-77.08392508327961},{"lat":-12.08757546682392,"lng":-77.08395726978779}\]
|
| color
| Color con el que se mostrará e identificará la geocerca en la plataforma, en formato RGB hexadecimal.
| \#223344 |
| radio
| Radio en metros que abarcará la geocerca circular.
| 0 |
| limite\_velocidad
| Velocidad máxima (Km/h) permitida en la geocerca.
| 50 |
| solo\_mi\_usuario
| Indica si la geocerca solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
| 0 |
| visible
| Indica si la geocerca se debe o no mostrar.
1 = Mostrar
0 = Ocultar
| 1 |
**Nota:** Si la geocerca es de **tipo compartida**, no permitirá actualizar y mostrará un mensaje de error .
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": 30300,
"msg": "La geocerca es compartida, no se puede actualizar"
}
}
```
# Eliminar geocerca - deleteGeofence
##### POST https://api.service24gps.com/api/v1/deleteGeofence
Este método permite eliminar una geocerca especifica.
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== |
| idCerca | **(Requerido)** Identificador único de la geocerca en el sistema.
| 138225 |
**Nota:** Si la geocerca es de **tipo compartida**, no permitirá eliminar y mostrará un mensaje de error .
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": 30300,
"msg": "La geocerca es compartida, no se puede eliminar"
}
}
```
# Lugares
Métodos relacionados con los lugares.
# Lista de lugares - getPlaces
##### POST https://api.service24gps.com/api/v1/getPlaces
Obtiene el listado de todos los lugares que pertenecen al usuario o cliente.
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idLugar | Identificador único del lugar en el sistema.
| Entero |
| nombre | Nombre con el que se identificará el lugar en el sistema.
| Cadena de Texto |
| direccion
| Dirección en la que se ubica el lugar.
| Cadena de Texto |
| latitud
| Latitud correspondiente al lugar que se dará de alta.
| Flotante
|
| longitud
| Longitud correspondiente al lugar que se dará de alta.
| Flotante
|
| descripcion
| Comentario o descripción breve sobre el lugar.
| Cadena de Texto
|
| telefono
| Número telefónico o de contacto vinculado al lugar.
| Cadena de Texto |
| email
| Dirección de correo electrónico vinculado al lugar.
| Cadena de Texto |
| grupoLugar
| Identificador del grupo al que pertenece el lugar.
| Entero |
| grupo
| Nombre del grupo al que pertenece el lugar
| Cadena de texto |
| solo\_mi\_usuario
| Indica si el lugar solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
| Entero |
| icono
| Icono con el que se identificará el lugar en el sistema.
| Cadena de Texto |
| visible
| Indica si el lugar se debe o no mostrar.
1 = Mostrar
0 = Ocultar
| Entero
|
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== |
| nombre | Nombre con el que se identifica el lugar en el sistema.
| Colegio 1 |
| direccion | Dirección en la que se ubica el lugar.
| Aztecas 158, Hab la Romana, 54030 Tlalnepantla de Baz, Méx. |
| latitud | Latitud correspondiente al lugar.
| |
| longitud
| Longitud correspondiente al lugar.
| -99.191248 |
| descripcion | Comentario o descripción breve sobre el lugar.
| |
| telefono | Número telefónico o de contacto vinculado al lugar.
| |
| email | Dirección de correo electrónico vinculado al lugar.
| prueba@prueba.com |
| solo\_mi\_usuario | Indica si el lugar solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
| 0 |
| icono | Icono con el que se identificará el lugar en el sistema.
| /images/Lugares/new\_596\_retail\_shop\_building.png |
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== |
| idLugar | Identificador único del lugar en el sistema.
| 556987 |
| nombre | Nombre con el que se identifica el lugar en el sistema.
| Colegio 2 |
| direccion | Dirección en la que se ubica el lugar.
| Aztecas 158, Hab la Romana, 54030 Tlalnepantla de Baz, Méx. |
| latitud | Latitud correspondiente al lugar.
| |
| longitud
| Longitud correspondiente al lugar.
| -99.191248 |
| descripcion | Comentario o descripción breve sobre el lugar.
| |
| telefono | Número telefónico o de contacto vinculado al lugar.
| |
| email | Dirección de correo electrónico vinculado al lugar.
| |
| solo\_mi\_usuario | Indica si el lugar solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
| 0 |
| icono | Icono con el que se identificará el lugar en el sistema.
| /images/Lugares/new\_596\_retail\_shop\_building.png |
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== |
| idLugar | Identificador único de la geocerca en el sistema.
| 144825 |
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== |
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== |
| fecha\_inicio | Fecha inicio a consultar, si no se manda este parámetro se utiliza la fecha actual. | 2021-11-01 |
| fecha\_fin | Fecha fin a consultar, si no se manda este parámetro se utiliza la fecha actual. | 2021-11-02 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del mensaje sms dentro de la plataforma. | Entero |
| fecha\_hora | Fecha hora que se envió el mensaje de sms (GMT Hora de México centro) | Fecha Hora (Y-m-d H:i:s)
|
| destinatario | Número telefónico al que se envió el mensaje sms | Cadena de Texto
|
| mensaje | Texto o contenido que se envió
| Cadena de Texto |
| enviado | Bandera para validar si se envió el mensaje: 1 = Enviado, 0 = No enviado
| Valor booleano |
| device | Identificador único del dispositivo (GPS)
| Cadena de Texto |
| gateway | Servicio SMS Gateway que se utilizó para el envío del mensaje.
| Cadena de Texto |
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== |
| id | Identificador único del mensaje sms. | 11 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del mensaje sms dentro de la plataforma. | Entero |
| fecha\_hora | Fecha hora que se envió el mensaje de sms (GMT Hora de México centro) | Fecha Hora (Y-m-d H:i:s)
|
| destinatario | Número telefónico al que se envió el mensaje sms | Cadena de Texto
|
| mensaje | Texto o contenido que se envió
| Cadena de Texto |
| enviado | Bandera para validar si se envió el mensaje: 1 = Enviado, 0 = No enviado
| Valor booleano |
| device | Identificador único del dispositivo (GPS)
| Cadena de Texto |
| gateway | Servicio SMS Gateway que se utilizó para el envío del mensaje.
| Cadena de Texto |
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== |
| to | Número telefónico del destinatario | 2226308920 |
| message | Texto a mandar o encolar. | Hola mundo! |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del mensaje sms dentro de la plataforma. | Entero |
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== |
| device | Identificador único del dispositivo (GPS) | 1743201963 |
| message | Texto a mandar o encolar. | Hola mundo! |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del mensaje sms dentro de la plataforma. | Entero |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| type | El tipo de aplicación que solicita codificado en Base64. | Mg== |
| uid | IMEI o identificador único del dispositivo codificado en Base64.
| MTIzNDU2Nzg5 |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| Authorization | Token generado por el método auth. | eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4\_5lSMRgTMU |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| imei | IMEI o identificador único del dispositivo codificado en Base64.
| MTIzNDU2Nzg5 |
| Authorization | Token generado por el método auth. | eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4\_5lSMRgTMU |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| idruta\_proceso | Id de la ruta en proceso en base64.
| MA== |
| imei | IMEI o identificador único del dispositivo codificado en Base64.
| MTIzNDU2Nzg5 |
| idruta | Id de la ruta en base 64.
| MTcwMTQ= |
| Authorization | Token generado por el método auth. | eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4\_5lSMRgTMU |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| token | Token generado por el método auth. | eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4\_5lSMRgTMU |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| Authorization | Token generado por el método auth. | eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4\_5lSMRgTMU |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| Authorization | Token generado por el método auth. | eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4\_5lSMRgTMU |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| Authorization | Token generado por el método auth. | eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4\_5lSMRgTMU |
| oldApp | IMEI o identificador único del dispositivo codificado en Base64 de la app tracker compartida (liberar equipo). | QVBQU0hBUkVENDE4OTYxNjUxMDk2NjAzNzIz |
| newApp | IMEI o identificador único del dispositivo codificado en Base64 de la app tracker compartida (asignar equipo). | QVBQU0hBUkVENDE4OTYxNjUxMDk2ODc2NDQ3 |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| Authorization | Token generado por el método auth. | eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4\_5lSMRgTMU |
| imei | IMEI o identificador único del dispositivo codificado en Base64. | MTIzNDU2Nzg5 |
Ver parámetros de solicitud:
| **Parámetros** | **Descripción** | **Ejemplo** |
| Authorization | Token generado por el método auth. | eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4\_5lSMRgTMU |
| uiddevice | Identificador único del dispositivo. | c1698794d07a\_tp785\_689721 |
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== |
| fecha\_inicio | Fecha inicial desde la que se buscarán las rutas. | 2021-05-05 |
| fecha\_final | Fecha final hasta donde se realizará la búsqueda de las rutas. | 2021-05-05 |
Ver campos de respuesta:
| **Campo** | **Descripción**
| **Formato** |
| id | Identificador único de la ruta programada
| Entero |
| nombre | Nombre asignado a la ruta programada
| Texto |
| fecha\_inicio
| Fecha programada de inicio de la ruta
| Fecha (aaaa-mm-dd) |
| hora\_inicio
| Hora programada de inicio de la ruta
| Hora (hh:mm:ss) |
| fecha\_fin
| Fecha programada para finalizar la ruta
| Fecha (aaaa-mm-dd) |
| hora\_fin
| Hora programada para finalizar la ruta
| Hora (hh:mm:ss) |
| idruta
| Identificador único de la ruta de la cual se tomaron los puntos
| Entero |
| fecha\_completado
| Fecha en que se finalizó la ruta
| Fecha (aaaa-mm-dd) |
| hora\_completado
| Hora en que se finalizó la ruta
| Hora (hh:mm:ss) |
| activo
| Nombre del activo que está realizando la ruta
| Nombre |
| Placa / patente correspondiente al activo
| Texto |
| Comentario creado por el sistema sobre el estado de la ruta.
| Texto |
| Indica si la ruta se creó manualmente o a partir de una programación automática.
| Entero |
| Icono asignado al activo para identificarlo en el sistema
| Texto |
| Identificador único del equipo GPS asignado al activo
| Entero |
| Identificador único del activo que está realizando la ruta
| Entero |
| Nombre del grupo al que pertenece el vehículo.
| Texto |
| Indica el status en el que se encuentra la ruta (Iniciada, Pendiente, En proceso, Cancelada)
| Texto |
| Definición de los lugares que conforman la ruta
| Texto JSON\* |
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== |
| idruta
| Identificador único de la ruta que se va a utilizar para la programación de salida de ruta.
| 2533 |
| idactivo
| Identificador único del activo que realizará el recorrido de la ruta seleccionada.
| 13953 |
| nombre
| Nombre asignado a la ruta programada
| OnBus APII |
| definicion
| Definición de los puntos
| {
"distancia":"80",
"frecuenciaSalida":"10",
"lugares":\[
{
"id":"11789",
"tipo":"2",
"orden":"1",
"nombre":"TERMINAL BOGOTA",
"dist\_pa":"0",
"latLng":"4.611841,-74.17858",
"fEstimada":"",
"timeBetween":"0",
"distLleg":"500",
"orientacion":"",
"salidaEstimada":"2018-05-05 18:01:18"
}
\],
"conductor1":\[
{
"id":2300,
"codigo":"KS8374",
"nombre":"Karla Segovia"
}
\],
"conductor2":\[
{
"id":2297,
"codigo":"CM5732",
"nombre":"Luis Morales"
}
\],
"creado":"2021-05-05 18:01:18"
} |
| fecha\_inicio
| Fecha en la que deberá iniciar la salida de ruta
| 2021-05-05 |
| hora\_inicio
| Hora en la que deberá iniciar la salida de ruta
| 17:00:00 |
| fecha\_fin
| Fecha en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo)
| 2021-05-05 |
| hora\_fin
| Hora en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo)
| 19:50:00 |
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== |
| id
| Identificador único de la ruta programada en el sistema.
| |
| nombre
| Nombre asignado a la ruta programada
| OnBus APII |
| definicion
| Definición de los puntos
| {
"distancia":"80",
"frecuenciaSalida":"10",
"lugares":\[
{
"id":"11789",
"tipo":"2",
"orden":"1",
"nombre":"TERMINAL BOGOTA",
"dist\_pa":"0",
"latLng":"4.611841,-74.17858",
"fEstimada":"",
"timeBetween":"0",
"distLleg":"500",
"orientacion":"",
"salidaEstimada":"2018-05-05 18:01:18"
}
\],
"conductor1":\[
{
"id":2300,
"codigo":"KS8374",
"nombre":"Karla Segovia"
}
\],
"conductor2":\[
{
"id":2297,
"codigo":"CM5732",
"nombre":"Luis Morales"
}
\],
"creado":"2021-05-05 18:01:18"
} |
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== |
| idruta
| Identificador único de la ruta programada.
| 138225 |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| distancia | Distancia en metros para considerar que se llegó a un lugar, éste valor aplica para los lugares que tengan distLleg = 0.
| Entero |
| lugares | Información de los lugares que conforman la ruta.
| Arreglo de objetos |
| descripcion | Descripción breve de la ruta.
| Cadena de texto |
| tiempoEstimado
| Fecha en la que se crea la ruta. | Date (dd-mm-aaaa)
|
| id
| Identificador único de la ruta en el sistema.
| Entero
|
| nombre
| Nombre con el que se identifica la ruta en el sistema.
| Cadena de texto |
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== |
| nombre | Nombre con el que se identifica la ruta en el sistema.
| Test RouteOnBus |
| definicion
| Definición de los puntos.
| {
"distancia": 80,
"lugares": \[
{
"id": "234210",
"tipo": 1,
"orden": "6",
"nombre": "numero 6",
"dist\_pa": 227,
"latLng": "19.030686,-98.211428",
"fEstimada": "",
"tolerancia": "0",
"timeBetween": 5,
"distLleg": 15,
"orientacion": "",
"completado": "0",
"ViajeHora": "0",
"ViajeMin": "5",
"TiempoParado": "0",
"RadioPunto": "15",
"HoraConfigHorario": "Invalid date"
}
\],
"descripcion": "Ruta test",
"tiempoEstimado": "31-01-2018",
"nombre": "Ruta de Prueba."
}
|
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== |
| id | Identificador único de la ruta en el sistema.
| Update Test Nombre 3 |
| nombre
| Nombre con el que se identificará la ruta en el sistema.
| New Driver 3
|
| definicion
| Definición de los puntos.
| {
"distancia": 80,
"lugares": \[
{
"id": "2300129",
"tipo": 1,
"orden": "6",
"nombre": "numero 6",
"dist\_pa": 227,
"latLng": "19.030686,-98.211428",
"fEstimada": "",
"tolerancia": "0",
"timeBetween": 5,
"distLleg": 15,
"orientacion": "",
"completado": "0",
"ViajeHora": "0",
"ViajeMin": "5",
"TiempoParado": "0",
"RadioPunto": "15",
"HoraConfigHorario": "Invalid date"
}
\],
"descripcion": "Ruta test",
"tiempoEstimado": "31-01-2018",
"id": "2300129",
"nombre": "Ruta de Prueba."
}
|
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== |
| idRuta | Identificador único de la ruta en el sistema.
| 138225 |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del producto. | Entero |
| idcliente\_distribuidor | Identificador único del distribuidor. | Entero |
| idcliente\_sistema | Identificador único del cliente.
| Entero |
| nombre
| Nombre del producto.
| Cadena de texto |
| descripcion
| Descripción del producto.
| Cadena de texto
|
| costo
| Costo.
| Entero
|
| impuesto
| Impuesto.
| Flotante
|
| idmoneda
| Identificador único de la moneda.
| Entero
|
| peso
| Peso.
| Flotante
|
| volumen
| Volumen.
| Flotante
|
| unidad\_peso
| Unidad de peso.
| Entero
|
| unidad\_volumen
| Unidad de volumen.
| Entero
|
| idtipo\_activo\_producto\_od
| Identificador único del activo del producto.
| Entero
|
| codigo\_producto
| Código del producto
| Cadena de texto
|
| estado
| Estado. | Entero
|
| valor\_unidad\_peso
| Valor unidad de peso. | Cadena de texto
|
| valor\_unidad\_volumen
| Valor unidad de volumen. | Cadena de texto
|
| nombre\_moneda
| Nombre de la moneda. | Cadena de texto
|
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del cliente. | Entero |
| nombre | Nombre del cliente. | Cadena de texto |
| razon\_social | Razón social.
| Cadena de texto |
| identificador
| Identificador.
| Entero |
| contacts
| Contacto del cliente.
| Json
|
| address
| Dirección del cliente.
| Json
|
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== |
| order\_id | Identificador único de la orden. | 5307 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único de la orden. | Entero |
| costo\_total
| Costo total.
| Cadena de texto
|
| Fecha inicio. | Timestamp |
| Fecha fin.
| Timestamp
|
| idcliente\_od | Identificador único del cliente. | Entero |
| idalmacen\_od | Identificador único del almacén. | Entero |
| idstatus\_pedido\_od
| Identificador único del pedido.
| Entero |
| subtotal
| Subtotal.
| Cadena de texto
|
| impuesto
| Impuesto.
| Cadena de texto
|
| idmoneda
| Identificador único del tipo de moneda.
| Entero
|
| num\_factura
| Número de factura.
| Cadena de texto
|
| peso\_total
| Peso total.
| Cadena de texto
|
| volumen\_total
| Volumen total.
| Cadena de texto
|
| idcliente\_distribuidor
| Identificador único del distribuidor.
| Entero
|
| idcliente\_sistema
| Identificador único del cliente.
| Entero
|
| idusuario\_sistema
| Identificador único del usuario.
| Entero
|
| comentarios | Comentario sobre la orden. | Cadena de texto
|
| iddomicilio\_cliente\_od
| Identificador único del domicilio.
| Entero
|
| numero\_pedido
| Número del pedido.
| Cadena de texto
|
| tiempo\_servicio
| Tiempo del servicio.
| Cadena de texto
|
| cantidad
| Cantidad.
| Cadena de texto
|
| estado
| Estado de la orden
| Entero
|
| codigo\_rastreo
| Código de rastreo.
| Cadena de texto
|
| cliente | Nombre del cliente.
| Cadena de texto |
| status\_pedido
| Status de la orden.
| Cadena de texto
|
| moneda
| Moneda.
| Cadena de texto
|
| idvehiculo\_od | Identificador único del vehículo. | Entero |
| detalle | detalle de la orden | Array |
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== |
| begin\_date | Fecha de inicio.
| 2022-05-01 |
| end\_date | Fecha fin.
| 2022-05-30 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único de la orden. | Entero |
| idcliente\_od | Identificador único del cliente. | Entero |
| cliente | Nombre del cliente.
| Cadena de texto |
| idstatus\_pedido\_od
| Identificador único del pedido.
| Entero |
| status
| Status de la orden.
| Cadena de texto
|
| idmoneda
| Identificador único del tipo de moneda.
| Entero
|
| moneda
| Moneda.
| Cadena de texto
|
| Fecha inicio. | Timestamp |
| Fecha fin.
| Timestamp
|
| num\_factura
| Número de factura.
| Cadena de texto
|
| subtotal
| Subtotal.
| Cadena de texto
|
| impuesto
| Impuesto.
| Cadena de texto
|
| costo\_total
| Costo total.
| Cadena de texto
|
| peso\_total
| Peso total.
| Cadena de texto
|
| volumen\_total
| Volumen total.
| Cadena de texto
|
| comentarios | Comentario sobre la orden. | Cadena de texto
|
| iddomicilio\_cliente\_od
| Identificador único del domicilio.
| Entero
|
| tiempo\_servicio
| Tiempo del servicio.
| Cadena de texto
|
| numero\_pedido
| Número del pedido.
| Cadena de texto
|
| cantidad
| Cantidad.
| Cadena de texto
|
| horario\_entrega
| Horario de entrega.
| Cadena de texto
|
| codigo\_rastreo
| Código de rastreo.
| Cadena de texto
|
| vehiculo
| Nombre del vehículo.
| Cadena de texto
|
| placa
| Placa del vehículo.
| Cadena de texto
|
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](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken/es)**. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| inicio | **(Requerido)** Fecha de inicio.
| 2025-05-01 09:00:00 |
| fin | **(Requerido)** Fecha fin.
| 2025-05-01 10:00:00 |
| idcliente\_od | **(Requerido)** Identificador único del cliente.
El id se puede obtener en el método [**getAllClient**](https://docs.redgps.com/books/webservice/page/listar-clientes-getallclient/es)
| 2078 |
| idstatus\_pedido\_od | **(Opcional)** Identificador único del status del pedido.
El id se puede obtener en el método [**getStatuses**](https://docs.redgps.com/books/webservice/page/listar-status-getstatuses/es)
| 1 |
| num\_factura
| **(Opcional)** Número de factura.
| 1992 |
| num\_pedido
| **(Opcional)** Número de pedido.
| 405
|
| comentario
| **(Opcional)** Comentario sobre el pedido.
| productos nuevos
|
| iddomicilio
| **(Requerido)** Identificador único del domicilio.
El id se puede obtener en el método [**getAllAddressClient**](https://docs.redgps.com/books/webservice/page/listar-direcciones-getalladdressclient/es)
| 14999
|
| pago
| **(Opcional)** Pago del pedido.
| 0
|
| tiempo\_servicio
| **(Requerido)** Tiempo de servicio.
| 10
|
| afecta\_inventario
| **(Opcional)** Afecta inventario.
| 1
|
| idalmacen\_od
| **(Opcional)** Identificador único del almacén.
El id se puede obtener en el método [**getAllWareHouse**](https://docs.redgps.com/books/webservice/page/listar-almacenes-getallwarehouse/es)
| 150
|
| detalle
| **(Requerido)** Detalle de los productos.
| \[{"idproducto\_od":"41","cantidad":"5"}\]
|
| peso\_total
| **(Opcional)** Peso total.
| 200
|
| volumen\_total
| **(Opcional)** Volumen total,
| 50
|
| costo\_total
| **(Opcional)** Costo total.
| 0
|
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== |
| order\_id | Identificador único de la orden.
| 5309 |
| inicio | Fecha de inicio.
| 2022-05-13 13:37:00 |
| fin | Fecha fin.
| 2022-05-16 13:37:00 |
| idcliente\_od | Identificador único del cliente.
| 27 |
| idstatus\_pedido\_od | Identificador único del status del pedido.
| 1 |
| num\_factura
| Número de factura.
| 852526 |
| num\_pedido
| Número de pedido.
| 224
|
| comentario
| Comentario sobre el pedido.
| productos nuevos
|
| iddomicilio
| Identificador único del domicilio.
| 436
|
| pago
| Pago del pedido.
| 0
|
| tiempo\_servicio
| Tiempo de servicio.
| 10
|
| afecta\_inventario
| Afecta inventario.
| 1
|
| idalmacen\_od
| Identificador único del almacén.
| 13
|
| detalle
| Detalle de los productos.
| \[{"idproducto\_od":"41","cantidad":"5"}\]
|
| peso\_total
| Peso total.
| 200
|
| volumen\_total
| Volumen total,
| 50
|
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== |
| order\_id | Identificador único de la orden.
| 5309 |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del account. | Entero |
| idcliente\_od | Identificador único del cliente. | Entero |
| cliente | Nombre del cliente
| Cadena de Texto |
| idmoneda
| Identificador único de la moneda. | Entero |
| moneda
| Moneda.
| Cadena de Texto
|
| saldo
| Saldo.
| Flotante
|
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== |
| idcliente\_od | Identificador único del cliente. | 4 |
| amount | Monto de la cuenta. | 500 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| account\_id | Identificador único del account. | Entero |
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== |
| account\_id | Identificador único de la cuenta. | 792 |
| amount | Monto de la cuenta. | 5000 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| account\_id | Identificador único del account. | Entero |
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== |
| account\_id | Identificador único de la cuenta. | 792 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| account | Identificador único del account. | Entero |
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== |
| idcliente | Identificador único del cliente. | 4 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del account (cuenta). | Entero |
| cliente | Nombre del cliente (cuenta).
| Cadena de Texto |
| moneda
| Moneda (cuenta).
| Cadena de Texto
|
| saldo
| Saldo (cuenta).
| Flotante
|
| fecha\_realizado
| Fecha de movimiento (movimientos).
| Timestamp
|
| saldo\_anterior
| Saldo anterior (movimientos).
| Flotante
|
| monto\_operacion
| Monto agregado (movimientos).
| Flotante
|
| realizado\_por
| Movimiento realizado (movimientos).
| Cadena de Texto
|
| monto
| Monto total de la cuenta.
| Flotante
|
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== |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del almacén. | Entero |
| nombre | Nombre del almacén. | Cadena de texto |
| idvehiculo | Identificador único del vehículo.
| Entero |
| idcliente\_sistema
| Identificador único del cliente.
| Entero |
| idcliente\_distribuidor
| Identificador único del distribuidor.
| Entero
|
| descripcion
| Descripción del almacén.
| Cadena de texto
|
| idpais
| Identificador único del país.
| Entero
|
| idprovincia | Identificador único de la provincia. | Entero |
| Nombre de la ciudad.
| Cadena de texto
|
| calle
| Calle.
| Cadena de texto
|
| numero\_int | Número de interior. | Entero |
| numero\_ext | Número de exterior. | Entero |
| cp | Código postal. | Cadena de texto |
| latitud | Latitud. | Cadena de texto |
| longitud | Longitud. | Cadena de texto |
| estado | Estado del almacén. | Entero |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único de la zona | Entero |
| nombre | Nombre de la zona. | Cadena de texto |
| descripcion | Descripción de la zona.
| Cadena de texto |
| almacen
| Nombre del almacén.
| Cadena de texto |
| idalmacen
| Identificador único del almacén.
| entero
|
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== |
| idcliente | Identificador único del cliente. | 5 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del contacto. | Entero |
| nombre | Nombre del contacto. | Cadena de texto |
| notas | Notas.
| Cadena de texto |
| idcliente\_od
| Identificador único del cliente.
| Entero |
| datos\_contacto
| Datos del contacto.
| Json
|
| estado
| Estado
| Entero
|
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== |
| idcontacto | Identificador único del contacto. | 56 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| nombre | Nombre del contacto. | Cadena de texto |
| notas | Notas.
| Cadena de texto |
| telefono
| Teléfono del contacto.
| Cadena de texto |
| email
| Email del contacto.
| Cadena de texto
|
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== |
| idvehiculo | Identificador único del vehículo. | 37922 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único. | Entero |
| idvehiculo | Identificador único del vehículo. | Entero |
| peso\_maximo | Peso máximo.
| Flotante |
| volumen\_maximo
| Volumen máximo
| Flotante |
| tipo\_lugar\_salida
| Tipo del lugar.
| Cadena de texto
|
| unidad\_peso
| Unidad de peso.
| Entero
|
| unidad\_volumen
| Unidad de volumen.
| Entero
|
| cantidad
| Cantidad.
| Entero
|
| idtipo\_activo\_producto\_od
| Identificador único del tipo activo.
| Entero
|
| inicio\_labores
| Fecha de inicio.
| time
|
| fin\_labores
| Fecha fin.
| time
|
| datos\_tipo\_activo
| Datos del tipo activo.
| Json
|
| tipo\_carga
| Tipo de carga.
| Entero
|
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del inventario. | Entero |
| idcliente\_distribuidor | Identificador único del distribuidor. | Entero |
| idcliente\_sistema | Identificador único del cliente.
| Entero |
| idalmacen\_od
| Identificador único del almacén.
| Entero |
| cantidad
| Cantidad.
| Entero
|
| subtotal
| Subtotal.
| Entero
|
| total
| Total.
| Flotante
|
| impuesto
| Impuesto
| Flotante
|
| idmoneda
| Identificador único de la moneda.
| Entero
|
| timestamp
| Tiempo.
| TimeStamp
|
| estado
| Estado.
| Entero
|
| nombre\_zona
| Nombre de la zona.
| Cadena de texto
|
| nombre\_almacen
| Nombre del almacén.
| Cadena de texto
|
| nombre\_producto
| Nombre del producto.
| Cadena de texto
|
| nombre\_moneda
| Nombre de la moneda.
| Cadena de texto
|
| idproducto
| Identificador único del producto. | Entero
|
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== |
| begin\_date | Fecha de inicio.
| 2022-05-01 |
| end\_date | Fecha fin.
| 2022-05-30 |
| add\_past\_orders | -Mostrar pedidos pasados cuando no hay en la fecha solicitada: **1**
-Mostrar solo pedidos con la fecha indicada: 0
| 0 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único de la orden. | Entero |
| comentarios | Comentario sobre la orden. | Cadena de texto
|
| Fecha inicio. | Timestamp |
| Fecha fin.
| Timestamp
|
| Identificador único del formulario.
| Entero
|
| Identificador único del vehículo od.
| Entero
|
| Identificador único del vehículo.
| Entero
|
| Identificador único del conductor.
| Entero
|
| peso\_maximo
| Peso máximo.
| Flotante
|
| volumen\_maximo
| Volumen máximo.
| Flotante
|
| lugar\_salida
| Identificador único del lugar.
| Entero
|
| tipo\_lugar\_salida
| Tipo del lugar.
| Cadena de texto
|
| pedidos
| Detalle del pedido
| Json
|
| salida\_iniciada | Salida iniciada. | Bolean |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del vehículo. | Entero |
| nombre | Nombre asignado al vehículo | Cadena de Texto |
| patente | Patente del vehículo
| Cadena de Texto |
| idgps
| identificador gps
| Entero |
| gatewayip
| ip del gateway
| Cadena de Texto
|
| conductor
| Nombre del conductor
| Cadena de Texto
|
| grupo
| Nombre del grupo
| Cadena de Texto
|
| marca
| Marca del vehículo | Cadena de Texto
|
| modelo
| Modelo del vehículo
| Cadena de Texto
|
| color
| Color de vehículo
| Cadena de Texto
|
| anio
| Año del vehículo
| Cadena de Texto
|
| numero\_serie
| Numero de serie
| Cadena de Texto
|
| latitud\_salida
| latitud
| Cadena de Texto
|
| longitud\_salida
| longitud
| Cadena de texto
|
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== |
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== |
| address | Domicilio.
| Av. Paseo de la Reforma, Juárez, Cuauhtémoc, 06500 Ciudad de México, CDMX |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| lat | Latitud | Cadena de texto
|
| Longitud | Cadena de texto |
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken/es). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idcliente | Identificador único del cliente. El id se puede obtener en el método [**getAllClient**](https://docs.redgps.com/books/webservice/page/listar-clientes-getallclient/es) | 1792 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del domicilio. | Numérico |
| nombre | Nombre de la dirección. | texto |
| idpais | Identificador único del país. | Numérico |
| idprovincia | Identificador único de la provincia. | Numérico |
| ciudad | Nombre de la ciudad. | texto |
| calle | Nombre de la calle. | texto |
| numero\_int | Número de interior del domicilio. | Numérico |
| numero\_ext | Número de exterior del domicilio. | Numérico |
| codigo\_postal | Código postal. | texto |
| idtipo\_domicilio | Identificador único del tipo de domicilio. | Numérico |
| idcliente\_od | Identificador único del cliente. | Numérico |
| idcontacto\_cliente\_od | Identificador único del contacto del cliente. | Numérico |
| latitud | Latitud | texto |
| longitud | Longitud | texto |
| datos\_extras | Información adicional | JSON |
| estado | Nombre del estado. | texto |
| pais | Nombre del país. | texto |
| provincia | Nombre de la provincia. | texto |
| contacto | Nombre del contacto. | texto |
| domicilio\_completo | Domicilio completo. | texto |
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken/es). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| nombre | **(Requerido)** Nombre del cliente. | Test Client |
| razon\_social | **(Opcional)** Razón social. | RS-0001 |
| identificador | **(Requerido)** Identificador único del cliente. | ID-001 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id\_cliente | Identificador único del cliente. | Entero |
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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken/es). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| identifier | Identificador del cliente en OnDelivery. | ID-001 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del cliente. | Entero |
| nombre | Nombre del cliente. | Texto |
| contacts | Contacto del cliente. | JSON |
| address | Dirección del cliente. | JSON |
| razon\_social | Razón social del cliente. | Texto |
| identificador | Identificador del cliente. | Texto |
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== |
| idvehiculo
| Identificador único del vehículo dentro de la plataforma. | 53008 |
| equipo
| IMEI / Identificador del equipo GPS en plataforma. | 354148072188807 |
| fecha\_ini
| Fecha de inicio del rango sobre el cual se va a realizar la búsqueda de información del viaje | 2021-05-05 |
| fecha\_fin
| Fecha fin del rango sobre el cual se va a realizar la búsqueda de información del viaje | 2021-05-05 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| inicio\_viaje
| Contiene la información de inicio del viaje (fecha, hora y domicilio)
| Objeto |
| final\_viaje
| Contiene la información de fin de viaje (fecha, hora y domicilio)
| Objeto |
| duracion\_viaje
| Tiempo total de viaje (en segundos)
| Entero |
| distancia\_viaje
| Distancia total recorrida durante el viaje (en metros)
| Entero
|
| calificacion\_viaje
| Calificación final del viaje
| Flotante
|
| categorias
| Información de las categorías evaluadas durante el viaje
| Arreglo de Objetos
|
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](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken/es)**. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| username | Un usuario autorizado para usar el servicio por parte del cliente y debe estar definido previamente. | usuario |
| password | Contraseña asociada al usuario. | contraseña |
| form\_id | Id del formulario a consultar. | 41 |
| start\_date | Fecha de inicio de la búsqueda. | 2025-11-01 |
| end\_date | Fecha de fin de la búsqueda | 2025-12-01 |
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== |
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
|
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](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef).** | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
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 |
**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](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| report\_id | **(Requerido)** Identificador único del reporte programado.
El id del reporte programado se puede consultar en el método **[getProgrammedReports.](https://docs.redgps.com/books/webservice/page/metodo-para-listar-los-reportes-programados-getprogrammedreports)**
| 000001 |
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 |
Ver formato:
| Nombre | Descripción | Valor de la propiedad | Ejemplo |
|---|
| **Headers** | Formato de respuesta de la petición.
| - **last\_execution:** Fecha y hora de ultima ejecución del reporte programado.
- **start\_datetime:** Fecha y hora de inicio del reporte programado.
- **end\_datetime:** Fecha y hora final del reporte programado.
- **execution\_id:** Id único del reporte programado.
- **client\_id:** Id cliente sistema.
- **destination\_url:** Url de destino en donde se enviara una petición POST cuando se termine de procesar el reporte programado.
- **saved\_report\_id:** Id del reporte programado.
- **saved\_report\_name:** Nombre del reporte programado.
- **report\_type:** Tipo de reporte.
- **selected\_assets:** Activos seleccionados.
- **assets\_groups:** Grupos de Activos seleccionados.
|
{
"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": \[\]
}
|
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== |
| id | Identificador único de la ruta en el sistema.
| 1382123 |
| idruta | Identificador único de la ruta que se va a utilizar para la programación de salida de ruta.
| 34534 |
| idactivo | Identificador único del activo que realizará el recorrido de la ruta seleccionada.
| 245855 |
| nombre | Nombre con el que se identificará la ruta dentro de la plataforma.
| Prueba nombre ruta |
| definición
| Definición de puntos.
| {
"distancia":80,
"lugares":\[
{
"id":"36589",
"tipo":1,
"orden":"1",
"nombre":"Departamento 1",
"dist\_pa":0,
"latLng":"18.900479,-98.435602",
"fEstimada":"",
"tolerancia":0,
"timeBetween":0,
"distLleg":0,
"orientacion":""
} \],
"waypoints":\[
\],
"puntos":\[
\],
"rutas":\[
\],
"sinoGarmin":0,
"useRoutePlaces":0
}
|
| fecha\_inicio
| Fecha en la que deberá iniciar la salida de ruta.
| 2022-02-27
|
| hora\_inicio
| Hora en la que deberá iniciar la salida de ruta.
| 15:30:00
|
| fecha\_fin
| Fecha en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).
| 2022-02-28
|
| hora\_fin
| Hora en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).
| 20:00:00
|
| dias
| Días de la semana en que se ejecutará la salida de
ruta, los valores aceptados son: Lu, Ma, Mi, Ju, Vi.
Sa, Do; los días se separan con el signo “-”.
| Lu-Mi-Vi-Sa
|
| periodo
| Periodo en que se reprogramará la ruta, los valores
aceptados son:
1 = Todos los días
2 = Todas las semanas
3 = Todos los meses
4 = Todos los años
5 = Continuamente
| 2
|
| repetir
| Indica la frecuencia de días, semanas, meses o años en que se debe repetir la ruta.
| 1
|
| veces
| Número de veces que se debe cumplir la ruta antes de finalizarla (enviar 0 en caso de no utilizarlo).
| 0
|
| termina
| Indica cuando se debe considerar la ruta como
finalizada. Los valores aceptados son:
1 = Nunca, la ruta se repite indefinidamente
2 = Después de n veces (la cantidad de repeticiones
se especifica en el parámetro anterior “veces”)
3 = Finaliza en una fecha y hora específica (la fecha
se indica en “fecha\_fin” y “hora\_fin”)
4 = Finaliza automáticamente al llegar al último
punto.
| 4
|
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único de la ruta programada.
| Entero |
| nombre | Información de los lugares que conforman la ruta.
| Arreglo de objetos |
| fecha\_inicio
| Fecha programada de inicio de la ruta.
| Date (aaaa-mm-dd) |
| hora\_inicio | Hora programada de inicio de la ruta. | Time (hh:mm:ss)
|
| fecha\_fin
| Fecha programada para finalizar la ruta.
| Date (aaaa-mm-dd)
|
| hora\_fin
| Hora programada para finalizar la ruta.
| Time (hh:mm:ss)
|
| idruta
| Identificador único de la ruta de la cual se tomaron
los puntos.
| Entero |
| fecha\_completado | Fecha en que se finalizó la ruta.
| Date (aaaa-mm-dd) |
| hora\_completado | Hora en que se finalizó la ruta
| Time (hh:mm:ss) |
| activo | Nombre del activo que está realizando la ruta.
| Cadena de texto |
| placa | Placa / patente correspondiente al activo.
| Cadena de texto |
| comentario | Comentario o descripción breve sobre la ruta
| Cadena de texto |
| icono | Icono asignado al activo para identificarlo en el sistema.
| Cadena de texto |
| equipo | Equipo GPS asignado al activo.
| Entero |
| idactivo | Identificador único del activo que está realizando la ruta.
| Entero |
| estado | Indica el estado actual de la ruta.
| Cadena de texto |
| distancia | Distancia en metros para considerar que se llegó a un lugar, éste valor aplica para los lugares que tengan distLleg = 0.
| Entero |
| lugares | Información de los lugares que conforman la ruta.
| Arreglo de objetos |
| waypoints | Puntos de referencia entre lugares de la ruta.
| Arreglo de objetos |
| puntos | Rutas calculadas a través de la API de Google.
| Arreglo de objetos |
| rutas | Geocercas de tipo ruta.
| Arreglo de objetos |
| sinoGarmin | Indica si el dispositivo GPS tiene integrado un sistema con pantalla Garmin.
| Entero |
| useRoutePlaces | Indica si debe usar los puntos de la ruta original o de la ruta programada.
| Entero |
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== |
| id | Identificador único de la ruta en el sistema.
| 1382123 |
| idruta | Identificador único de la ruta que se va a utilizar para la programación de salida de ruta.
| 34534 |
| idactivo | Identificador único del activo que realizará el recorrido de la ruta seleccionada.
| 245855 |
| nombre | Nombre con el que se identificará la ruta dentro de la plataforma.
| Prueba nombre ruta |
| definición
| Definición de puntos.
| {
"distancia":80,
"lugares":\[
{
"id":"36589",
"tipo":1,
"orden":"1",
"nombre":"Departamento 1",
"dist\_pa":0,
"latLng":"18.900479,-98.435602",
"fEstimada":"",
"tolerancia":0,
"timeBetween":0,
"distLleg":0,
"orientacion":""
} \],
"waypoints":\[
\],
"puntos":\[
\],
"rutas":\[
\],
"sinoGarmin":0,
"useRoutePlaces":0
}
|
| fecha\_inicio
| Fecha en la que deberá iniciar la salida de ruta.
| 2022-02-27
|
| hora\_inicio
| Hora en la que deberá iniciar la salida de ruta.
| 15:30:00
|
| fecha\_fin
| Fecha en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).
| 2022-02-28
|
| hora\_fin
| Hora en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).
| 20:00:00
|
| dias
| Días de la semana en que se ejecutará la salida de
ruta, los valores aceptados son: Lu, Ma, Mi, Ju, Vi.
Sa, Do; los días se separan con el signo “-”.
| Lu-Mi-Vi-Sa
|
| periodo
| Periodo en que se reprogramará la ruta, los valores
aceptados son:
1 = Todos los días
2 = Todas las semanas
3 = Todos los meses
4 = Todos los años
5 = Continuamente
| 2
|
| repetir
| Indica la frecuencia de días, semanas, meses o años en que se debe repetir la ruta.
| 1
|
| veces
| Número de veces que se debe cumplir la ruta antes de finalizarla (enviar 0 en caso de no utilizarlo).
| 0
|
| termina
| Indica cuando se debe considerar la ruta como
finalizada. Los valores aceptados son:
1 = Nunca, la ruta se repite indefinidamente
2 = Después de n veces (la cantidad de repeticiones
se especifica en el parámetro anterior “veces”)
3 = Finaliza en una fecha y hora específica (la fecha
se indica en “fecha\_fin” y “hora\_fin”)
4 = Finaliza automáticamente al llegar al último
punto.
| 4
|
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== |
| idRuta | Identificador único de la ruta en el sistema.
| 138225 |
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== |
| nombre | Nombre con el que se identificará la ruta dentro de la plataforma.
| Prueba nombre ruta |
| definición
| Definición de puntos, geocercas lineales, distancia, etc.
| {
"distancia":80,
"lugares":\[
{
"id":"36589",
"tipo":1,
"orden":"1",
"nombre":"Departamento 1",
"dist\_pa":0,
"latLng":"18.900479,-98.435602",
"fEstimada":"",
"tolerancia":0,
"timeBetween":0,
"distLleg":0,
"orientacion":""
} \],
"waypoints":\[
\],
"puntos":\[
\],
"rutas":\[
\],
"sinoGarmin":0,
"useRoutePlaces":0
}
|
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| distancia | Distancia en metros para considerar que se llegó a
un lugar, éste valor aplica para los lugares que tengan distLleg = 0.
| Entero |
| lugares | Información de los lugares que conforman la ruta.
| Arreglo de objetos |
| waypoints
| Puntos de referencia entre lugares de la ruta.
| Arreglo de objetos |
| puntos
| Rutas calculadas a través de la API de Google. | Arreglo de objetos
|
| rutas
| Geocercas de tipo ruta.
| Arreglo de objetos
|
| sinoGarmin
| Indica si el dispositivo GPS tiene integrado un
sistema con pantalla Garmin.
| Entero
|
| useRoutePlaces
| Indica si debe usar los puntos de la ruta original o de la ruta programada.
| Entero |
| id
| Identificador único de la ruta en el sistema.
| Entero |
| nombre
| Nombre con el que se identifica la ruta en el sistema.
| Cadena de texto |
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== |
| id | Identificador único de la ruta en el sistema.
| 1382123 |
| nombre | Nombre con el que se identificará la ruta dentro de la plataforma.
| Prueba nombre ruta |
| definición
| Definición de puntos, geocercas lineales, distancia, etc.
| {
"distancia":80,
"lugares":\[
{
"id":"36589",
"tipo":1,
"orden":"1",
"nombre":"Departamento 1",
"dist\_pa":0,
"latLng":"18.900479,-98.435602",
"fEstimada":"",
"tolerancia":0,
"timeBetween":0,
"distLleg":0,
"orientacion":""
} \],
"waypoints":\[
\],
"puntos":\[
\],
"rutas":\[
\],
"sinoGarmin":0,
"useRoutePlaces":0
}
|
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== |
| idRuta | Identificador único de la ruta en el sistema.
| 138225 |
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== |
| nombre | Nombre para la plataforma | My Platform |
| url | Url de redireccionamiento para la plataforma | https://sitio.com/my\_platform |
| icono | Campo opcional, detalle visual para la plataforma (.svg, .png); en caso de no proporcionarse se toma uno por defecto. | https://sitio.com/my\_icon.svg |
| estado | Campo opcional, bandera para activar (1) o desactivar (0) la plataforma. Si no se proporciona por defecto es 1. | 1 |
| id | Campo opcional, sólo se manda el identificador único cuando se va actualizar | 11 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único de la plataforma.
| Entero |
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== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único de la plataforma.
| Entero |
| nombre | Nombre que va tener la plataforma
| Texto |
| estado | Bandera que indica si la plataforma es activa o no
(1 = activo, 0 = inactiva)
| Entero |
| url
| Url dónde va redireccionar cuando se de clic en el icono.
| Texto |
| icono | Descripción visual de la plataforma.
| Texto |
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== |
| id | Identificador de la plataforma. | 11 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único de la plataforma.
| Entero |
| nombre | Nombre que va tener la plataforma
| Texto |
| estado | Bandera que indica si la plataforma es activa o no
(1 = activo, 0 = inactiva)
| Entero |
| url
| Url dónde va redireccionar cuando se de clic en el icono.
| Texto |
| icono | Descripción visual de la plataforma.
| Texto |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| nombre | **(Requerido)** Nombre del repetidor. | Mi repetidor de datos |
| tipo\_transmision | **(Requerido)** Tipo de transmisión. Valores aceptados: TCP, UDP, SOAP, RESTful. | TCP |
| tipo\_envio | **(Opcional)** Tipo del envío, valores aceptados: JSON, XML, string, otro. Si no se proporciona este campo, su valor por defecto será JSON. | json |
| host | **(Requerido)** Dirección Host por establecer al WebService, este campo es obligatorio **sólo si** el tipo de transmisión seleccionado es SOAP o RESTful. Representa el valor del host necesario para realizar la comunicación de envío. | https://192.168.1.100/my-endpoint |
| ip | **(Requerido)** Dirección IP por establecer al WebService, este campo es obligatorio **sólo si** el tipo de transmisión seleccionado es TCP o UDP. Representa el valor de la IP necesaria para realizar la comunicación de envío. | 192.168.1.100 |
| port | **(Requerido)** Puerto por establecer al WebService, este campo es obligatorio **sólo si** el tipo de transmisión seleccionado es TCP o UDP. Representa el valor del puerto necesario para realizar la comunicación de envío. | 80 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idws | Identificador único del repetidor del WebService.
| Entero |
| webservice | Nombre del repetidor del WebService, no se admiten duplicados.
| Cadena de Texto |
| tipo\_transmision | Tipo de transmisión establecido al WebService
| Cadena de Texto |
| tipo\_envio | Tipo de envío establecido al WebService
| Cadena de Texto |
| host | Dirección Host establecida al WebService.
| Cadena de Texto |
| ip | Dirección IP establecida al WebService.
| Cadena de Texto |
| port | Puerto establecido al WebService.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del WebService a actualizar. | 151
|
| nombre | **(Opcional)** Nombre del WebService a actualizar. | Mi repetidor de datos |
| tipo\_transmision | **(Opcional)** Tipo de transmisión. Valores aceptados: TCP, UDP, SOAP, RESTful. En el caso de una actualización si este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo. | TCP |
| tipo\_envio | **(Opcional)** Tipo del envío, valores aceptados: JSON, XML, string, otro. Si no se proporciona este campo su valor por defecto será JSON. En el caso de una actualización si este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo. | json |
| host | **(Opcional)** Dirección Host por establecer al WebService, este campo es obligatorio **sólo si** el tipo de transmisión es SOAP o RESTful. Representa el valor del host necesario para realizar la comunicación de envío. En el caso de una actualización, si el tipo de envío es compatible y este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo. | https://192.168.1.100/my-endpoint |
| ip | **(Opcional)** Dirección IP por establecer al WebService, este campo es obligatorio **sólo si** el tipo de transmisión seleccionado es TCP o UDP. Representa el valor de la IP necesaria para realizar la comunicación de envío. En el caso de una actualización, si el tipo de envío es compatible y este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo. | 192.168.1.100 |
| port | **(Opcional)** Puerto por establecer al WebService, este campo es obligatorio **sólo si** el tipo de transmisión seleccionado es TCP o UDP. Representa el valor del puerto necesario para realizar la comunicación de envío. En el caso de una actualización, si el tipo de envío es compatible y este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo. | 80 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idws | Identificador único del repetidor del WebService.
| Entero |
| webservice | Nombre del repetidor del WebService, no se admiten duplicados.
| Cadena de Texto |
| tipo\_transmision | Tipo de transmisión establecido al WebService
| Cadena de Texto |
| tipo\_envio | Tipo de envío establecido al WebService
| Cadena de Texto |
| host | Dirección Host establecida al WebService.
| Cadena de Texto |
| ip | Dirección IP establecida al WebService.
| Cadena de Texto |
| port | Puerto establecido al WebService.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del WebService a eliminar. | 151
|
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idws | Identificador único del repetidor del WebService.
| Entero |
| message | Mensaje de estado de la operación.
| Cadena de Texto |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del WebService a actualizar | 151
|
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idws | Identificador único del repetidor del WebService.
| Entero |
| webservice | Nombre del WebService.
| Cadena de Texto |
| tipo\_transmision | Tipo de transmisión para el WebService.
| Cadena de Texto |
| tipo\_envio | Tipo de envío para el WebService.
| Cadena de Texto |
| host | Dirección Host establecida para el WebService.
| Cadena de Texto |
| ip | Dirección IP establecida para el WebService.
| Cadena de Texto |
| port | Puerto establecido para el WebService.
| Cadena de Texto |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idws | Identificador único del repetidor del WebService.
| Entero |
| webservice | Nombre del WebService.
| Cadena de Texto |
| tipo\_transmision | Tipo de transmisión para el WebService.
| Cadena de Texto |
| tipo\_envio | Tipo de envío para el WebService.
| Cadena de Texto |
| host | Dirección Host establecida para el WebService.
| Cadena de Texto |
| ip | Dirección IP establecida para el WebService.
| Cadena de Texto |
| port | Puerto establecido para el WebService.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| IdCliente | **(Opcional)** Identificador único del cliente, si se proporciona se obtiene la lista de Webservices asignados solo a ese cliente. Si no se proporciona un identificador de cliente se obtiene una lista de todas las asignaciones de todos los clientes en todos los WebServices del distribuidor. | 661 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idasignacion | Identificador único de la asignación por cliente al WebService.
| Entero |
| idws | Identificador único del repetidor del WebService.
| Entero |
| webservice | Nombre del WebService.
| Cadena de Texto |
| tipo\_transmision | Tipo de transmisión para el WebService.
| Cadena de Texto |
| tipo\_envio | Tipo de envío para el WebService.
| Cadena de Texto |
| clientenombre | Nombre del cliente.
| Cadena de Texto |
| idcliente | Identificador único del cliente.
| Entero |
| host | Dirección Host establecida para el WebService.
| Cadena de Texto |
| ip | Dirección IP establecida para el WebService.
| Cadena de Texto |
| port | Puerto establecido para el WebService.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del WebService | 151 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idasignacion | Identificador único de la asignación entre el cliente y el WebService
| Entero |
| idcliente | Identificador único del cliente
| Entero |
| estatus | Estado de la asignación entre el cliente y el WebService: 1 = Encendido, 0 = Apagado
| Entero |
| activos | Listado de activos asignados a la relación entre el cliente y WebService, dónde muestra los estatus para saber sí está habilitado o no (1 = Encendido, 0 = Apagado)
| Arreglo |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del Webservice
| 151 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idasignacion | Identificador único de la asignación entre el cliente y el WebService
| Entero |
| idcliente | Identificador único del cliente
| Entero |
| estatus | Estado de la asignación entre el cliente y el WebService: 1 = Encendido, 0 = Apagado
| Entero |
| activos | Listado de activos asignados a la relación entre el cliente y WebService, dónde muestra los estatus para saber sí está habilitado o no (1 = Encendido, 0 = Apagado)
| Arreglo |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del WebService. | 661 |
| IdCliente | **(Requerido)** Identificador único de cliente. | 67421 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idasignacion | Identificador único de la asignación de un activo a un WebService por cliente.
| Entero |
| idactivo | Identificador único del activo asignado al WebService por cliente.
| Entero |
| activo | Nombre del activo asignado al WebService por cliente.
| Cadena de Texto |
| dispositivo | Imei del dispositivo del activo asignado al WebService por cliente.
| Cadena de Texto |
| placa | Placa del dispositivo del activo asignado al WebService por cliente.
| Cadena de Texto |
| webservice | Nombre del WebService.
| Cadena de Texto |
| idws | Identificador único del repetidor del WebService.
| Cadena de Texto |
| estatus | Estado de la asignación del dispositivo en el WebService por cliente.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del WebService. | 661 |
| IdCliente | **(Requerido)** Identificador único de cliente. | 67421 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idasignacion | Estado de la asignación del cliente a el WebService.
| Entero |
| idcliente | Identificador único del cliente.
| Entero |
| idws | Identificador único del repetidor del WebService.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del WebService. | 661 |
| IdCliente | **(Requerido)** Identificador único de cliente. | 67421 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idasignacion | Estado de la asignación del cliente a el WebService.
| Entero |
| idcliente | Identificador único del cliente.
| Entero |
| idws | Identificador único del repetidor del WebService.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del WebService. | 661 |
| IdCliente | **(Requerido)** Identificador único de cliente. | 67421 |
| IdActivo | **(Requerido)** Identificador único de activo. | 1234 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idasignacion | Estado de la asignación del activo a el WebService del cliente.
| Entero |
| idcliente | Identificador único del cliente.
| Entero |
| idws | Identificador único del repetidor del WebService.
| Entero |
| idactivo | Identificador único del activo asignado al WebService.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idws | **(Requerido)** Identificador único del WebService. | 661 |
| IdCliente | **(Requerido)** Identificador único de cliente. | 67421 |
| IdActivo | **(Requerido)** Identificador único de activo. | 12345 |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| idasignacion | Estado de la asignación del activo a el WebService del cliente.
| Entero |
| idcliente | Identificador único del cliente.
| Entero |
| idws | Identificador único del repetidor del WebService.
| Entero |
| idactivo | Identificador único del activo asignado al WebService.
| Entero |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| fecha | **(Opcional)** Fecha de inicio en formato DD-MM-AAAA. | 10-10-2024 |
| activo | **(Opcional)** Nombre del activo en plataforma. | Ruta 1 |
| estado | **(Opcional)** Estado del mantenimiento. Valores posibles: Pendiente, Alertado, Realizado. | Pendiente |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| nombre\_mantenimiento | Nombre del mantenimiento configurado.
| Cadena de Texto |
| nombre\_activo | Nombre del activo en plataforma.
| Cadena de Texto |
| estado | Estado del mantenimiento. Valores posibles: Pendiente, Alertado, Realizado.
| Cadena de Texto |
| concepto | Concepto del mantenimiento.
| Cadena de Texto |
| descripcion | Descripción del mantenimiento.
| Cadena de Texto |
| tiempo\_configuracion | Tiempo en horas configuradas del mantenimiento.
| Cadena de Texto |
| tiempo\_transcurrido\_activo | Tiempo en horas transcurrido del activo.
| Cadena de Texto |
| kilometros\_recorridos\_configuracion | Kilómetros recorridos configuradas del mantenimiento.
| Cadena de Texto |
| kilometros\_recorridos\_activo | Kilómetros recorridos del activo.
| Cadena de Texto |
| hrs\_uso\_motor\_configuracion | Horas uso del motor configuradas del mantenimiento.
| Cadena de Texto |
| hrs\_uso\_motor\_activo | Horas uso del motor del activo.
| Cadena de Texto |
| fecha\_sig\_revision | Fecha estimada siguiente revision.
| Cadena de Texto |
| fecha | Fecha de inicio mantenimiento del activo.
| Cadedna de Texto |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| estado\_mantenimiento | **(Opcional) E**stado del mantenimiento. Valores posibles: Pendiente, Alertado, Realizado. | 10-10-2024 |
| activo | **(Opcional)** Nombre del activo en plataforma. | Ruta 1 |
| nombre\_mantenimiento | **(Opcional)** Nombre del mantenimiento. | Respuesto de Llantas |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| nombre\_mantenimiento | Nombre del mantenimiento configurado.
| Cadena de Texto |
| activo | Nombre del activo que efectuó el mantenimiento.
| Cadena de Texto |
| estado | Estado del mantenimiento. Valores posibles: Pendiente, Alertado, Realizado.
| Cadena de Texto |
| concepto | Concepto del mantenimiento.
| Cadena de Texto |
| tiempo\_configuracion | Tiempo en horas configuradas del mantenimiento.
| Cadena de Texto |
| tiempo\_transcurrido\_activo | Tiempo en horas transcurrido del activo.
| Cadena de Texto |
| kilometros\_recorridos\_configuracion | Kilómetros recorridos configuradas del mantenimiento.
| Cadena de Texto |
| kilometros\_recorridos\_activo | Kilómetros recorridos del activo.
| Cadena de Texto |
| hrs\_uso\_motor\_configuracion | Horas uso del motor configuradas del mantenimiento.
| Cadena de Texto |
| hrs\_uso\_motor\_activo | Horas uso del motor del activo.
| Cadena de Texto |
| fecha\_ultimo\_mantenimiento | Fecha ultimo mantenimiento del activo.
| Cadena de Texto |
| numero\_orden | Número orden del mantenimiento.
| Cadena de Texto |
| total\_orden | Total orden del mantenimiento.
| Cadena de Texto |
| detalle\_subtotal | Detalle subtotal del mantenimiento
| Cadena de Texto |
| detalle\_monto | Detalle monto del mantenimiento
| Cadena de Texto |
| monto\_factura | Monto de la factura del mantenimiento.
| Cadena de Texto |
Ver parámetros de solicitud:
| apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| fecha\_realizado | **(Opcional)** Fecha realizado en formato DD-MM-AAAA. | 10-10-2024 |
| activo | **(Opcional)** Nombre del activo en plataforma. | Ruta 1 |
| nombre\_mantenimiento | **(Opcional)** Nombre del mantenimiento. | Respuesto de Llantas |
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| nombre\_mantenimiento | Identificador único del repetidor del WebService.
| Cadena de Texto |
| taller | Taller donde se realizó el mantenimiento.
| Cadena de Texto |
| numero\_factura | Número de la factura del mantenimiento.
| Cadena de Texto |
| tipo\_repuesto | Tipo de repuesto utilizado en el mantenimiento.
| Cadena de Texto |
| valor\_factura | Valor de de la factura del mantenimiento.
| Cadena de Texto |
| cantidad | Cantidad de repuesto utilizado en el mantenimiento.
| Cadena de Texto |
| patente | Patente del activo que efectuó el mantenimiento.
| Cadena de Texto |
| activo | Nombre del activo que efectuó el mantenimiento.
| Cadena de Texto |
| proveedor | Nombre del proveedor que efectuó el mantenimiento.
| Cadena de Texto |
| fecha\_realizado | Fecha en que se realizó el mantenimiento.
| Cadena de Texto |
| **Parámetros** | **Descripción** | **Longitud** | **Ejemplo** |
| token | Token devuelto por el método **[getToken](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef)**. | 500 | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| apikey | Llave de autorización para uso de los Servicios Web. | 50 | 25sdsd234234aa93sdsdsd37c70118e72 |
| lang | Idioma en que se mostrará la información | 2 | 'en', 'es', 'pt' |
El parámetro lang **no** es obligatorio.
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/getAllWebServices' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'lang="es"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
"id": "1",
"webservice": "Assistcargo",
"descripcion": "Reenvío de datos de identificación del activo e información telemática a la plataforma Assistcargo.",
"categorias": "Logística, Rastreamento de Veículos",
"tipo_envio": "XML",
"tipo_transmision": "SOAP",
"link": "https://www.example.com/example/example/",
"logo": "https://newexample1.example.com/logo_example.jpg",
"logo_detail": "https://example.nyc3.example.com/example_Assistcargo.jpg",
"fecha_alta": "2016-05-11",
"uso": "",
"idpais": "X",
"pais": "Argentina"
]
}
```
Ver campos de respuesta:
| Campo | Descripción
| Formato |
|---|
| id | Identificador único del web service. | Entero |
| webservice | Nombre asignado al web service. | Cadena de Texto |
| descripcion | Descripcion de función del web service.
| Cadena de Texto |
| categorias
| Categoría del web service
| Cadena de Texto |
| tipo\_envio
| Formato de envío de datos
| Cadena de Texto
|
| tipo\_transmision
| Transmisión utilizada por el web service
| Cadena de Texto
|
| link
| Url asignado para el web service
| Cadena de Texto
|
| logo
| Nombre del logo | Cadena de Texto |
| logo\_detail
| Url del logo asignado al webservice
| Cadena de Texto
|
| fecha\_alta
| Fecha de integración en plataforma | Cadena de Texto
|
| uso
| | Cadena de Texto
|
| idpais
| Identificador único del país en el que está habilitado
| Entero
|
| pais
| País en el que el web service está habilitado
| Cadena de Texto
|
| Método | Cambio | Descripción | Fecha |
|---|
| [getAlerts](https://docs.redgps.com/books/webservice/page/pagina-nueva/es) | Actualización
| Obtiene las alertas asociadas a un grupo de Activos o a un equipo GPS, dentro de un rango de fechas determinado. | 12 de Agosto de 2026 |
| [getAssetGroups](https://docs.redgps.com/books/webservice/page/listado-de-grupo-de-activos-getassetgroups/es) | Nuevo endpoint
| Obtiene el listado de los grupos de activos. | 08 de Julio de 2026 |
| [getClientByIdentifier](https://docs.redgps.com/books/webservice/page/listar-informacion-del-cliente-getclientbyidentifier/es) | Nuevo endpoint
| Lista la información de un cliente registrado en **OnDelivery** mediante su identificador. | 15 de octubre de 2025 |
| [updateAsset](https://docs.redgps.com/books/webservice/page/actualizar-vehiculo-updateasset/es) | Actualización
| Se agregaron validaciones en los campos obligatorios del método. | 03 de junio de 2025 |
| [deleteDevice](https://docs.redgps.com/books/webservice/page/deletedevice) | Nuevo endpoint
| Método para la eliminación de un equipo GPS | 18 de septiembre de 2024 |
| [deleteAsset](https://docs.redgps.com/books/webservice/page/deleteasset) | Nuevo endpoint
| Método para la eliminación de un Activo | 18 de septiembre de 2024 |
| [getDevices](https://docs.redgps.com/books/webservice/page/obtener-dispositivos-getdevices) | Actualización de documentación.
| Se actualizó la documentación en el apartado de la respuesta de la solicitud, se agregaron los campos **idcliente\_propietario** y **cliente\_propietario**. | 18 de septiembre de 2024 |
| [getClientAssetsInfo](https://docs.redgps.com/books/webservice/page/getclientassetsinfo) | Actualización de documentación.
| Se actualizó la documentación en el apartado de la respuesta de la solicitud. Se agregó en la respuesta el campo de **placa**. | 19 de junio de 2024 |
| [getTicketAnswer](https://docs.redgps.com/books/webservice/page/obtener-detalle-del-ticket-getticketanswer) | Nuevo endpoint
| Obtiene el detalle del ticket. | 13 de mayo de 2024 |
| [getScheduledReportResult](https://docs.redgps.com/books/webservice/page/metodo-para-obtener-la-informacion-del-reporte-programado-getscheduledreportresult) | Nuevo endpoint
| Obtiene la información de la última ejecución del reporte programado en la plataforma OnReports. **(Versión beta)** | 25 de marzo de 2024 |
| [getProgrammedReports](https://docs.redgps.com/books/webservice/page/metodo-para-listar-los-reportes-programados-getprogrammedreports) | Nuevo endpoint
| Obtiene el listado de los reportes programados de la plataforma OnReports | 25 de marzo de 2024 |
| [gettickets](https://docs.redgps.com/books/webservice/page/listado-de-tickets) | Actualización de documentación.
| Actualización general de la documentación del método. | 08 de marzo de 2024 |
| [historyGetEvents](https://docs.redgps.com/books/webservice/page/historygetevents) | Actualización de documentación.
| Se actualizó la documentación en el apartado de respuesta de la solicitud. | 04 de enero de 2024 |
| [getVehiclesBrands](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-marcas-de-activos-getvehiclesbrands) | Nuevo endpoint
| Catálogo de marcas de activos. | 10 de octubre de 2023 |
| [getVehiclesType](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-tipo-de-vehiculos-getvehiclestype) | Nuevo endpoint
| Catálogo de tipos de activos. | 10 de octubre de 2023 |
| [createAsset](https://docs.redgps.com/books/webservice/page/crear-activo-createasset) | Campos nuevos
| Se agregaron los campos **tipo\_vehiculo** y **marca en la solicitud. | 10 de octubre de 2023 |
| [createDevice](https://docs.redgps.com/books/webservice/page/crear-un-equipo-createdevice) | Campos nuevos
| Se agregaron los campos **idzona\_horaria** e **imei en la solicitud. | 10 de octubre de 2023 |
| [getTimeZone](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-de-zonas-horarias-gettimezone) | Nuevo endpoint
| Catálogo de zonas horarias. | 10 de octubre de 2023 |
| [setUser](https://docs.redgps.com/books/webservice/page/crea-o-actualiza-un-usuario-setuser) | Campos nuevos
| Se agregaron los campos **idzona\_horaria, parar\_motor, enviar\_sms** y **cargar\_geocercas\_al\_inicio** en la solicitud. | 10 de octubre de 2023 |
| [setClient](https://docs.redgps.com/books/webservice/page/crea-o-actualiza-un-cliente-setclient) | Campo nuevo
**idzona\_horaria**
| Se agrega el campo id zona horaria en la solicitud. El campo contiene el id para crear o actualizar la zona horaria. | 10 de octubre de 2023 |
| [InsertPositioData](https://docs.redgps.com/books/webservice/page/insertar-datos-de-dispositivo-insertpositiondata) | Actualización de documentación. | Se actualizó la documentación en el apartado de parámetros de solicitud y en la tabla de parámetros reportes. | 10 de mayo de 2023 |
| [historyGet](https://docs.redgps.com/books/webservice/page/datos-historicos-equipo-historyget) | Actualización de documentación. | Se actualizó la documentación en el apartado de respuesta de ejemplo y en la tabla de campos de respuesta. | 12 de abril de 2023 |
| [getData](https://docs.redgps.com/books/webservice/page/datos-de-unidades-getdata) | Campo nuevo **UrlLocation** | Se agrega un nuevo campo en la respuesta de solicitud del método. El campo contiene la URL de localización del último reporte. | 24 de febrero de 2023 |