Web Service: Status (English Version)

The status send web service is for those who want to receive service information when its status changes, and don’t want to wait until it’s Completed (“Atendido”).

Configuration

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

  1. In the Parameters and Users – Configuration screen, activate the option called: Transmit Service Statuses via WS.

  2. In the Parameters and Users – Additional Configuration screen, add the statuses you want to receive in the option called:

    1. Statuses to Transmit in WS to the Provider.

      • To add multiple statuses, separate the IDs with commas, e.g., 2,3,5.

      • If you enter 99, it will send all statuses.

Available Statuses

ID
Descripción

2

On Route (En Camino)

3

In Progress (En Progreso)

4

Suspended (Detenido)

5

Completed (Atendido)

6

Paused... (Continuar Después...)

Tests

To perform a test:

  1. Go to Operation → Services.

  2. Click the black “Form” icon on a service that is in one of the selected statuses.

  3. Then click the “Enviar estatus” button.

JSON

These are the parameters the system will receive. Unlike the Service web service, this JSON includes the parameter “servicioEstatusId”, which will show the service’s status ID.

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

caratula

Key/value pairs with service metadata

servicioEstatusId

The numeric ID of the status being transmitted

Last updated