Web Service: Kilometers (English Version)

The Kilometers web service is for those who want to receive the kilometers for the ideal route for every service.

Configuration

To configure and activate this web service, follow these steps:

  1. In the Parameters and Users – Configuration screen, activate the option called: Activar el envio de Ruta Optima mediante WS.

  2. In the Parameters and Users - Additional Configuration screen, capture the webhook in this field: URL WebService Ruta Optima

Tests

To perform a test:

  1. Go to Operation → Services.

  2. Find a Service that has a datetime in the column EN CAMINO and then click the black “Form” icon.

  1. Then click the “Enviar kilometraje” button.

Successful Result

A pop up will appear with the result. A successful result will show the following text:

JSON

These are the parameters the system will receive.

Here’s the sample JSON payload:

Parameter Definitions

Parameters
Definition

servicio.user

Webservice username

servicio.password

Webservice password

servicio.servicioId

ID of the service whose status changed

fechaEnCamino

DateTime of the "On Route" start

nombreOperador

Users Name

distanciaRecorridaMts

Distance in meters of the ideal route (provided by Google)

distanciaRecorridoSeg

Estimated time to travel that distance (provided by Google)

nombrePdi

Name of the Point of Interest

servicioFolioCliente

Service report number. This is a custom number that could be filled out by the admin user.

pdiLatitud

Latitude of the Point of Interest

pdiLongitud

Longitude of the Point of Interest

operadorLatitud

User's latitude when they clicked "On Route"

operadorLongitude

User's longitude when they clicked "On Route"

proveedorNombre

Name of the account

Last updated