API de lista de rutas (listar rutas guardadas)

Utilice la API de lista de rutas de TrackRoad para recuperar rutas guardadas previamente mediante filtros como rango de fechas, propietario y nombre de ruta. Para integraciones SOAP, el método equivalente es GetRouteList.

API de lista de rutas de TrackRoad que muestra rutas guardadas filtradas por rango de fechas, propietario y nombre de ruta
Liste y filtre rutas guardadas previamente para informes, paneles y consultas del historial de rutas.

¿Necesita el contrato completo?

Swagger incluye los modelos y campos del endpoint para REST, mientras que el WSDL expone el contrato SOAP para GetRouteList y métodos relacionados.

Ver Swagger UI Ver WSDL SOAP Resumen de referencia de API

Tabla de contenidos

  1. Qué hace la API de lista de rutas
  2. Endpoints y URLs base
  3. Autenticación
  4. Esquema de solicitud
  5. Esquema de respuesta
  6. Ejemplos
  7. Errores comunes
  8. Buenas prácticas
  9. Preguntas frecuentes
  10. Endpoints relacionados

Qué hace la API de lista de rutas#

La API de lista de rutas devuelve una lista de rutas guardadas de su cuenta. Se usa habitualmente para vistas de historial de rutas, paneles y pantallas de búsqueda donde los usuarios necesitan encontrar rutas generadas anteriormente.

Los filtros habituales incluyen rango de fecha de creación, propietario y nombre de ruta. Esto ayuda a que las búsquedas de rutas sean rápidas, precisas y más fáciles de gestionar en flotas más grandes.

Si necesita los detalles completos de una ruta, incluidas paradas, indicaciones y tiempos, use la API Route .

Endpoints y URLs base#

La documentación siguiente de Routes List se centra en el patrón de integración SOAP mostrado por GetRouteList. Siga la documentación de su cuenta y Swagger cuando los detalles específicos de la implementación sean diferentes.

SOAP

Elemento Valor
Endpoint https://trackservice.trackroad.com/TrackService.asmx
WSDL https://trackservice.trackroad.com/TrackService.asmx?WSDL
Método GetRouteList
SOAPAction http://TrackService.TrackRoad.com/GetRouteList

Autenticación#

Para SOAP, envíe su TrackServiceKey en SessionIDHeader como SessionID. No se requieren Login ni Logout cuando se usa TrackServiceKey.

Mantenga las claves de API del lado del servidor y evite exponer valores de autenticación en código de navegador o cliente móvil.

Esquema de solicitud#

La solicitud describe los filtros usados para encontrar rutas guardadas. En SOAP, estos valores se envían como parámetros de GetRouteList.

Campos de filtro de la lista de rutas

Campo Tipo Obligatorio Descripción
FromDate string (date-time) No Filtra rutas creadas o actualizadas en o después de esta marca de tiempo en formato ISO 8601.
ToDate string (date-time) No Filtra rutas creadas o actualizadas en o antes de esta marca de tiempo en formato ISO 8601.
Owner string No Filtra por propietario o nombre de usuario, si esto es compatible con la configuración de su cuenta.
RouteName string No Filtra por nombre de ruta mediante coincidencia exacta o parcial, según la implementación.

Si su implementación expone filtros adicionales como estado, paginación o número máximo de resultados, documente también esos campos aquí.

Esquema de respuesta#

Una respuesta correcta devuelve una lista de rutas que coinciden con sus filtros y cualquier información de estado o error devuelta por el servicio.

Resultado de Routes

Propiedad Tipo Descripción
Routes RouteSummary[] Lista de registros de resumen de rutas que coinciden.
Errors Error[] Errores o advertencias opcionales devueltos por el servicio.
Status int (enum) Código de estado, normalmente 0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Resumen de ruta

Propiedad Tipo Descripción
RouteID string / int Identificador de ruta utilizado posteriormente para obtener los detalles completos de la ruta.
RouteName string Nombre de ruta legible para humanos.
Distance double Distancia total de la ruta.
Time int Tiempo total de la ruta, normalmente en segundos salvo que esté configurado de otra forma.
Owner string Identificador del propietario o creador, cuando esté disponible.
DateCreated string (date-time) Marca de tiempo que muestra cuándo se creó la ruta.

SOAP devuelve el mismo concepto de lista de rutas dentro de un sobre SOAP, con el resultado encapsulado en los elementos de respuesta de GetRouteList.

Ejemplos#

Coloque en esta sección la solicitud SOAP de ejemplo, la respuesta de ejemplo y ejemplos de código en varios lenguajes. El código de ejemplo en sí no necesita localizarse.

SOAP: request examples (multiple languages)#

SOAP requires SessionIDHeader (SessionID = TrackServiceKey) and the SOAPAction header http://TrackService.TrackRoad.com/GetRouteList.

<!-- POST https://trackservice.trackroad.com/TrackService.asmx -->
<!-- Content-Type: text/xml; charset=utf-8 -->
<!-- SOAPAction: "http://TrackService.TrackRoad.com/GetRouteList" -->

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>

  <soap:Body>
    <GetRouteList xmlns="http://TrackService.TrackRoad.com/">
      <FromDate>2026-01-01T00:00:00Z</FromDate>
      <ToDate>2026-01-31T23:59:59Z</ToDate>
      <Owner>dispatcher@company.com</Owner>
      <RouteName>January</RouteName>
    </GetRouteList>
  </soap:Body>
</soap:Envelope>

SOAP: response example (shape)#

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetRouteListResponse xmlns="http://TrackService.TrackRoad.com/">
      <GetRouteListResult>
        <Routes>
          <RouteSummary>
            <RouteID>12345</RouteID>
            <RouteName>January - North Zone</RouteName>
            <Distance>82.4</Distance>
            <Time>14250</Time>
            <Owner>dispatcher@company.com</Owner>
            <DateCreated>2026-01-12T16:21:00Z</DateCreated>
          </RouteSummary>
        </Routes>
        <Status>1</Status>
        <Errors />
      </GetRouteListResult>
    </GetRouteListResponse>
  </soap:Body>
</soap:Envelope>

Errores comunes#

  • Error de autenticación: falta o es inválido SessionIDHeader. El valor de SessionID debe ser su TrackServiceKey.
  • Formato de fecha no válido: proporcione fechas en formato ISO 8601, por ejemplo 2026-01-31T23:59:59Z.
  • No hay rutas coincidentes: el rango de filtros, el propietario o el nombre de ruta pueden ser demasiado restrictivos.
  • Problema de servicio o permisos: la clave puede ser válida, pero estar bloqueada, vencida o limitada para el ámbito de cuenta solicitado.

Buenas prácticas#

  • Use filtros de fecha para mantener respuestas rápidas y predecibles, especialmente en vistas de historial de rutas.
  • Almacene en caché las listas de rutas para paneles que se cargan con frecuencia y actualícelas bajo demanda cuando los usuarios vuelvan a buscar.
  • Cargue los detalles de la ruta solo cuando sea necesario en lugar de recuperar datos completos de la ruta para cada fila de resultados.
  • Documente los campos específicos de la cuenta cuando su implementación admita filtros adicionales o propiedades de respuesta personalizadas.

Preguntas frecuentes#

¿Qué hace la API de lista de rutas?
La API de lista de rutas devuelve una lista de rutas guardadas previamente, normalmente filtradas por rango de fechas, propietario o nombre de ruta.
¿Cuál es el equivalente SOAP de la API de lista de rutas?
El nombre del método SOAP es GetRouteList.
¿Cómo me autentico?
Para SOAP, envíe su TrackServiceKey en SessionIDHeader como SessionID. No se requieren Login ni Logout cuando se usa TrackServiceKey.
¿Cuándo debo usar la API de lista de rutas en lugar de la API Route?
Use la API de lista de rutas para buscar y listar rutas guardadas. Use la API Route cuando necesite detalles completos de la ruta, como paradas, indicaciones y tiempos.

¿Quiere detalles de la ruta?

Utilice Routes List para encontrar valores RouteID guardados y luego abra la documentación de la API Route para cargar listas completas de paradas, distancias de ruta y detalles de tiempo.

Ir a la API Route Ver Swagger UI