Plataforma - OnBus

Listar rutas programadas OnBus - getProgrammedRoutesOnBus

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

Obtiene el listado de todas las rutas programadas que se encuentran pendientes, en proceso, iniciadas o canceladas, ya sea en el día en curso u opcionalmente en un rango de fechas específico (máximo 5 días).

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
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getProgrammedRoutesOnBus' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'fecha_inicio="2021-05-05"' \
--form 'fecha_final="2021-05-05"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": {
        "Ruta salida lugar2021-05-0500:00:00": {
            "id": "2076939",
            "nombre": "Ruta salida lugar",
            "fecha_inicio": "2021-05-05",
            "hora_inicio": "00:00:00",
            "fecha_fin": "2021-05-05",
            "hora_fin": "00:41:00",
            "idruta": "2076939",
            "fecha_completado": "0000-00-00",
            "hora_completado": "00:00:00",
            "activo": "Activo Simulado 4",
            "placa": "TXT-321",
            "comentario": "",
            "sino_creacion_manual": "0",
            "icono": "./Iconos/Vehiculos/CarIcon.png",
            "equipo": null,
            "idactivo": "13955",
            "grupo": "",
            "estado": "Pendiente",
            "definicion": {
                "distancia": 80,
                "conductor1": [
                    {
                        "id": "1960",
                        "nombre": "NELSON MAURICION BRAM",
                        "codigo": ""
                    }
                ],
                "conductor2": [
                    {
                        "id": "",
                        "nombre": "",
                        "codigo": ""
                    }
                ],
                "creado": "2021-05-17 00:00:00",
                "lugares": [
                    {
                        "id": "465845",
                        "tipo": 1,
                        "orden": "1",
                        "nombre": "el negro mandingo",
                        "dist_pa": 0,
                        "latLng": "19.059873,-98.237004",
                        "fEstimada": 0,
                        "tolerancia": "0",
                        "timeBetween": 15,
                        "distLleg": 0,
                        "orientacion": "",
                        "completado": "0",
                        "ViajeHora": "0",
                        "ViajeMin": "15",
                        "TiempoParado": "0",
                        "RadioPunto": "0",
                        "HoraConfigHorario": "Invalid date",
                        "llegadaEstimada": "2021-05-05 00:00:00",
                        "salidaEstimada": "2021-05-05 00:00:00",
                        "horaSale": "00:00",
                        "horallega": "00:00",
                        "horallegaEstimada": "00:00:00",
                        "horaSaleEstimada": "00:00:00"
                    }
                ],
                "EsHoraFija": 0
            }
        }
    }
}
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

Placa / patente correspondiente al activo

 Texto
comentario

Comentario creado por el sistema sobre el estado de la ruta.

 Texto
sino_creacion_manual

Indica si la ruta se creó manualmente o a partir de una programación automática.

 Entero
icono

Icono asignado al activo para identificarlo en el sistema

 Texto
equipo

Identificador único del equipo GPS asignado al activo

 Entero
idactivo

Identificador único del activo que está realizando la ruta

 Entero
grupo

Nombre del grupo al que pertenece el vehículo.

 Texto
estado

Indica el status en el que se encuentra la ruta (Iniciada, Pendiente, En proceso, Cancelada)

 Texto
definicion

Definición de los lugares que conforman la ruta

 Texto JSON*

Nota: El formato del texto JSON utilizado para la definición de la ruta es el mismo al del método programRouteOnBus.

Programar ruta OnBus - programRouteOnBus

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

Programa la salida de una ruta para el sistema OnBus.

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
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/programRouteOnBus' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idruta="2533"' \
--form 'idactivo="13953"' \
--form 'nombre="OnBus APII"' \
--form 'definicion="{\"distancia\":\"80\",\"frecuenciaSalida\":\"10\",\"lugares\":[{\"id\":\"11789\",\"tipo\":\"2\",\"orden\":\"1\",\"nombre\":\"TERMINAL BOGOTA\",\"dist_pa\":\"0\",\"latLng\":\"4.653657365711841,-74.1157141327858\",\"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\"}"' \
--form 'fecha_inicio="2021-05-05"' \
--form 'hora_inicio="17:00:00"' \
--form 'fecha_fin="2021-05-05"' \
--form 'hora_fin="19:50:00"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": {
        "id": "2080129"
    }
}

Actualizar ruta programada OnBus - updateRouteOnBus

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

Actualiza la información de salida de una ruta para el sistema OnBus.

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.
2080129

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"
}
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateRouteOnBus' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="f77c31ce81907cc5f0ecffeda60fb4f6"' \
--form 'token="SJx5eXC7PtRJwHcSY8O8DYbTUZGQCSkTRD9VvriKevvpsCpxC49cJQ=="' \
--form 'id="2080129"' \
--form 'nombre="Prueba update OnBusAPII 1"' \
--form 'definicion="{\"distancia\":\"80\",\"frecuenciaSalida\":\"10\",\"lugares\":[{\"id\":\"11789\",\"tipo\":\"2\",\"orden\":\"1\",\"nombre\":\"TERMINAL BOGOTA\",\"dist_pa\":\"0\",\"latLng\":\"4.653657365711841,-74.1157141327858\",\"fEstimada\":\"\",\"timeBetween\":\"0\",\"distLleg\":\"500\",\"orientacion\":\"\",\"salidaEstimada\":\"2018-05-17 18:01:18\"}],\"conductor1\":[{\"id\":2300,\"codigo\":\"KS8374\",\"nombre\":\"Karla Segovia\"}],\"conductor2\":[{\"id\":2297,\"codigo\":\"CM5732\",\"nombre\":\"Luis Morales\"}],\"creado\":\"2021-05-17 18:01:18\"}"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": {
        "id": "2080129"
    }
}

Eliminar ruta programda OnBus - deleteProgrammedRouteOnBus

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

Elimina una ruta programada.

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

Listar rutas OnBus - getRoutesOnBus

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

Obtiene la lista de todas las rutas OnBus que pertenecen al 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/getRoutesOnBus' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
    "status": 200,
    "data": [
        {
            "distancia": 80,
            "lugares": [
                {
                    "id": "234208",
                    "tipo": 1,
                    "orden": "4",
                    "nombre": "numero 4",
                    "dist_pa": 36,
                    "latLng": "19.030818,-98.21381",
                    "fEstimada": "",
                    "tolerancia": "0",
                    "timeBetween": 5,
                    "distLleg": 15,
                    "orientacion": "",
                    "completado": "0",
                    "ViajeHora": "0",
                    "ViajeMin": "5",
                    "TiempoParado": "0",
                    "RadioPunto": "15",
                    "HoraConfigHorario": "Invalid date"
                },
                {
                    "id": "234209",
                    "tipo": 1,
                    "orden": "5",
                    "nombre": "numero 5",
                    "dist_pa": 109,
                    "latLng": "19.03168,-98.213316",
                    "fEstimada": "",
                    "tolerancia": "0",
                    "timeBetween": 5,
                    "distLleg": 15,
                    "orientacion": "",
                    "completado": "0",
                    "ViajeHora": "0",
                    "ViajeMin": "5",
                    "TiempoParado": "0",
                    "RadioPunto": "15",
                    "HoraConfigHorario": "Invalid date"
                },
                {
                    "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-03-2022",
            "id": "1602",
            "nombre": "Ruta de Prueba."
        }
    ]
}
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

Crear ruta OnBus - createRouteOnBus

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

Permite crear la definición o serie de puntos que conforman una ruta; la cual estará disponible para ser utilizada con OnBus.

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."

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

Actualizar ruta OnBus - updateRouteOnBus

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

Permite realizar la modificación de la informació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.

 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."

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

Eliminar ruta OnBus - deleteRouteOnBus

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

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/deleteRouteOnBus' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idRuta="138225"'
Respuesta de ejemplo:
{
    "status": 200,
    "data": ""
}