# Crear programación de ruta - programRoute

##### <span class="api-method" data-method="POST">POST</span> https://api.service24gps.com/api/v1/programRoute

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

<details class="mb-m" id="bkmrk-body-parametersparam" open="open"><summary class="text-muted">Ver parámetros de solicitud:</summary>

<div><table class="table" style="width: 809px; height: 946px;"><tbody><tr style="height: 41px;"><th style="width: 146px; height: 41px;">Parámetros</th><th style="width: 370px; height: 41px;">Descripción</th><th style="width: 293px; height: 41px;">Ejemplo</th></tr><tr style="height: 41px;"><td style="width: 146px; height: 41px;">apikey</td><td style="width: 370px; height: 41px;">Llave de autorización para uso de los Servicios Web.</td><td style="width: 293px; height: 41px;"><span role="presentation" style="padding-right: 0.1px; color: #3366ff;">25sdsd234234aa93sdsdsd37c70118e72</span></td></tr><tr style="height: 41px;"><td style="width: 146px; height: 41px;">token</td><td style="width: 370px; height: 41px;">Token devuelto por el método getToken.</td><td style="width: 293px; height: 41px;"><span role="presentation" style="padding-right: 0.1px; color: #3366ff;">wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==</span></td></tr><tr style="height: 47px;"><td style="width: 146px; height: 47px;">id</td><td style="width: 370px; height: 47px;">Identificador único de la ruta en el sistema.

</td><td style="width: 293px; height: 47px;"><span role="presentation" style="padding-right: 0.1px;"><span style="color: #3366ff;"> 1382123</span></span></td></tr><tr><td style="width: 146px;">idruta</td><td style="width: 370px;">Identificador único de la ruta que se va a utilizar para la programación de salida de ruta.

</td><td style="width: 293px;"><span role="presentation" style="padding-right: 0.1px;"><span style="color: #3366ff;">34534</span></span></td></tr><tr><td style="width: 146px;">idactivo</td><td style="width: 370px;">Identificador único del activo que realizará el recorrido de la ruta seleccionada.

</td><td style="width: 293px;"><span style="color: #3366ff;">245855</span></td></tr><tr style="height: 69px;"><td style="width: 146px; height: 69px;">nombre</td><td style="width: 370px; height: 69px;">Nombre con el que se identificará la ruta dentro de la plataforma.

</td><td style="width: 293px; height: 69px;"><span role="presentation" style="padding-right: 0.1px;"><span style="color: #3366ff;">Prueba nombre ruta</span></span></td></tr><tr style="height: 338px;"><td style="width: 146px; height: 338px;">definición

</td><td style="width: 370px; height: 338px;">Definición de puntos.

</td><td style="width: 293px; height: 338px;"><span style="color: #3366ff;">{</span>

<span style="color: #3366ff;"> "distancia":80,</span>  
<span style="color: #3366ff;"> "lugares":</span><span style="color: #3366ff;">\[</span>

<span style="color: #3366ff;"> {</span>  
<span style="color: #3366ff;"> "id":"36589",</span>  
<span style="color: #3366ff;"> "tipo":1,</span>  
<span style="color: #3366ff;"> "orden":"1",</span>  
<span style="color: #3366ff;"> "nombre":"Departamento 1",</span>  
<span style="color: #3366ff;"> "dist\_pa":0,</span>  
<span style="color: #3366ff;"> "latLng":"18.900479,-98.435602",</span>  
<span style="color: #3366ff;"> "fEstimada":"",</span>  
<span style="color: #3366ff;"> "tolerancia":0,</span>  
<span style="color: #3366ff;"> "timeBetween":0,</span>  
<span style="color: #3366ff;"> "distLleg":0,</span>  
<span style="color: #3366ff;"> "orientacion":""</span>  
<span style="color: #3366ff;"> } \],</span>  
<span style="color: #3366ff;"> "waypoints":\[  
 \],</span>  
<span style="color: #3366ff;"> "puntos":\[  
 \],</span>  
<span style="color: #3366ff;"> "rutas":\[</span>  
<span style="color: #3366ff;"> \],</span>  
<span style="color: #3366ff;"> "sinoGarmin":0,</span>  
<span style="color: #3366ff;"> "useRoutePlaces":0</span>

<span style="color: #3366ff;">}</span>

</td></tr><tr><td style="width: 146px;">fecha\_inicio

</td><td style="width: 370px;">Fecha en la que deberá iniciar la salida de ruta.

</td><td style="width: 293px;"><span style="color: #3366ff;"> 2022-02-27</span>

</td></tr><tr><td style="width: 146px;">hora\_inicio

</td><td style="width: 370px;">Hora en la que deberá iniciar la salida de ruta.

</td><td style="width: 293px;"><span style="color: #3366ff;">15:30:00</span>

</td></tr><tr><td style="width: 146px;">fecha\_fin

</td><td style="width: 370px;">Fecha en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).

</td><td style="width: 293px;"><span style="color: #3366ff;">2022-02-28</span>

</td></tr><tr><td style="width: 146px;">hora\_fin

</td><td style="width: 370px;">Hora en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).

</td><td style="width: 293px;"><span style="color: #3366ff;">20:00:00</span>

</td></tr><tr><td style="width: 146px;">dias

</td><td style="width: 370px;">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 “-”.

</td><td style="width: 293px;"><span style="color: #3366ff;">Lu-Mi-Vi-Sa</span>

</td></tr><tr><td style="width: 146px;">periodo

</td><td style="width: 370px;">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

</td><td style="width: 293px;"><span style="color: #3366ff;">2</span>

</td></tr><tr><td style="width: 146px;">repetir

</td><td style="width: 370px;">Indica la frecuencia de días, semanas, meses o años en que se debe repetir la ruta.

</td><td style="width: 293px;"><span style="color: #3366ff;">1</span>

</td></tr><tr><td style="width: 146px;">veces

</td><td style="width: 370px;">Número de veces que se debe cumplir la ruta antes de finalizarla (enviar 0 en caso de no utilizarlo).

</td><td style="width: 293px;"><span style="color: #3366ff;">0</span>

</td></tr><tr><td style="width: 146px;">termina

</td><td style="width: 370px;">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.

</td><td style="width: 293px;"><span style="color: #3366ff;">4</span>

</td></tr></tbody></table>

</div></details><span style="color: #ff0000;">**Nota:** <span style="color: #ff0000;">La **definición** debe tener el mismo formato que el utilizado en el método </span> **createRoute**<span style="color: #ff0000;">.</span></span>

##### Solicitud de ejemplo:

```shell
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:

```JSON
{
    "status": 200,
    "data": ""
}
```