Plataforma - OnRouting

Crear programación de ruta - programRoute

POST https://api.service24gps.com/api/v1/programRoute

Permite crear la definición o serie de puntos que conforman una ruta.

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

Nota: La definición debe tener el mismo formato que el utilizado en el método createRoute.

Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/programRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'id="1382123"' \
--form 'idruta="34534"' \
--form 'idactivo="245855"' \
--form 'nombre="Prueba nombre ruta"' \
--form 'definicion="{"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}"' \
--form 'fecha_inicio="2022-02-27"' \
--form 'hora_inicio="15:30:00"' \
--form 'fecha_fin=""' \
--form 'hora_fin=""' \
--form 'dias="Lu-Mi-Vi-Sa"' \
--form 'periodo="2"' \
--form 'repetir="1"' \
--form 'veces="0"' \
--form 'termina="4"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": ""
}

Listar rutas programadas - getScheduledRoutes

POST https://api.service24gps.com/api/v1/getScheduledRoutes

Obtiene todas las rutas programadas que se encuentren en proceso o iniciadas.

Ver parámetros de solicitud:
Parámetros Descripción Ejemplo
apikey Llave de autorización para uso de los Servicios Web. 25sdsd234234aa93sdsdsd37c70118e72
token Token devuelto por el método getToken. wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getScheduledRoutes' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
   "status":200,
   "data":[
      {
         "id":"35124391",
         "nombre":"Ruta test programada",
         "fecha_inicio":"2022-02-25",
         "hora_inicio":"17:00:00",
         "fecha_fin":"0000-00-00",
         "hora_fin":"00:00:00",
         "idruta":"35124391",
         "fecha_completado":"0000-00-00",
         "hora_completado":"00:00:00",
         "activo":"prueba",
         "placa":"prueba",
         "comentario":"",
         "sino_creacion_manual":"1",
         "icono":"./Iconos/Vehiculos/CarIcon.png",
         "equipo":"prueba",
         "idactivo":"148762",
         "estado":"Pendiente",
         "definicion":{
            "distancia":80,
            "lugares":[
               {
                  "id":"36589",
                  "tipo":1,
                  "orden":"1",
                  "nombre":"Departamento",
                  "dist_pa":0,
                  "latLng":"18.900479,-98.435602",
                  "fEstimada":"",
                  "tolerancia":0,
                  "timeBetween":0,
                  "distLleg":0,
                  "orientacion":""
               },
               {
                  "id":"36609",
                  "tipo":1,
                  "orden":"2",
                  "nombre":"Departamento 2",
                  "dist_pa":31528,
                  "latLng":"19.027292,-98.208708",
                  "fEstimada":"",
                  "tolerancia":0,
                  "timeBetween":0,
                  "distLleg":0,
                  "orientacion":""
               },
               {
                  "id":"38686",
                  "tipo":1,
                  "orden":"5",
                  "nombre":"Departamento 3",
                  "dist_pa":20511,
                  "latLng":"19.153059,-98.243021",
                  "fEstimada":"",
                  "tolerancia":0,
                  "timeBetween":0,
                  "distLleg":0,
                  "orientacion":""
               }
            ],
            "waypoints":[
               
            ],
            "puntos":[
               
            ],
            "rutas":[
               
            ],
            "sinoGarmin":0,
            "useRoutePlaces":0
         }
      }
   ]
}
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

Actualizar ruta programada - updateScheduledRoute

POST https://api.service24gps.com/api/v1/updateScheduledRoute

Permite actualizar la programación de una ruta.

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

Nota: La definición debe tener el mismo formato que el utilizado en el método createRoute.

Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateScheduledRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'id="1382123"' \
--form 'idruta="34534"' \
--form 'idactivo="245855"' \
--form 'nombre="Prueba nombre ruta"' \
--form 'definicion="{"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}"' \
--form 'fecha_inicio="2022-02-27"' \
--form 'hora_inicio="15:30:00"' \
--form 'fecha_fin=""' \
--form 'hora_fin=""' \
--form 'dias="Lu-Mi-Vi-Sa"' \
--form 'periodo="2"' \
--form 'repetir="1"' \
--form 'veces="0"' \
--form 'termina="4"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": ""
}

Eliminar ruta programada - deleteScheduledRoute

POST https://api.service24gps.com/api/v1/deleteScheduledRoute

Este método permite eliminar una ruta especifica.

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
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteScheduledRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idRuta="138225"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": ""
}

Nota: Si en la respuesta de la solicitud aparece "status": 30700 es un error al obtener los datos.

Respuesta de ejemplo:
{
    "status": 30700,
    "data": ""
}

Crear ruta - createRoute

POST https://api.service24gps.com/api/v1/createRoute

Permite crear la definición o serie de puntos que conforman una ruta.

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

}

Nota: En caso de que no se requiera la información de waypoints, puntos o rutas; enviar como un objeto o arreglo vacío según corresponda.

Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'id="1382123"' \
--form 'nombre="Prueba nombre ruta"' \
--form 'definicion="{"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}"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": ""
}

Listar rutas - getRoutes

POST https://api.service24gps.com/api/v1/getRoutes

Obtiene todas las rutas activas 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==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getRoutes' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
    "status": 200,
    "data": [
         {
              "distancia": 80,
              "lugares": [
                  {
                      "id": "365891",
                      "tipo": 1,
                      "orden": "1",
                      "nombre": "Departamento",
                      "dist_pa": 0,
                      "latLng": "18.900479,-98.435602",
                      "fEstimada": "",
                      "tolerancia": 0,
                      "timeBetween": 0,
                      "distLleg": 0,
                      "orientacion": ""
                  },
                  {
                      "id": "395782",
                      "tipo": 1,
                      "orden": "3",
                      "nombre": "Punta del Cielo",
                      "dist_pa": 198,
                      "latLng": "19.027047,-98.207274",
                      "fEstimada": "",
                      "tolerancia": 0,
                      "timeBetween": 0,
                      "distLleg": 0,
                      "orientacion": ""
                  },
                  {
                      "id": "386863",
                      "tipo": 1,
                      "orden": "5",
                      "nombre": "Casa",
                      "dist_pa": 20511,
                      "latLng": "19.153059,-98.243021",
                      "fEstimada": "",
                      "tolerancia": 0,
                      "timeBetween": 0,
                      "distLleg": 0,
                      "orientacion": ""
                  }
              ],
              "waypoints": [],
              "puntos": [],
              "rutas": [],
              "sinoGarmin": 0,
              "useRoutePlaces": 0,
              "id": "2298289",
              "nombre": "PruebaRuta"
          }
    ]
}
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

Actualizar ruta - updateRoute

POST https://api.service24gps.com/api/v1/updateRoute

Permite actualizar la definición o puntos que conforman una ruta.

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

}

Nota: La definición debe tener el mismo formato que el utilizado en el método createRoute.

Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'id="1382123"' \
--form 'nombre="Prueba nombre ruta"' \
--form 'definicion="{"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}"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": ""
}

Eliminar ruta - deleteRoute

POST https://api.service24gps.com/api/v1/deleteRoute

Este método permite eliminar una ruta especifica.

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
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idRuta="138225"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": ""
}

Nota: Si en la respuesta de la solicitud aparece "status": 30700 es un error al obtener los datos.

Respuesta de ejemplo:
{
    "status": 30700,
    "data": ""
}