create planned routes by geojson

Requisição

Parâmetros Query

route_date

string

requerido

route date to search

Padrão de combinação:

^\d{4}-\d{2}-\d{2}$

search_term

string

opcional

route name, driver name, activty and vehicle name to search

page

number

opcional

current page

Padrão:

1

per_page

number

opcional

quantity of items per page

Padrão:

10

order_by

enum<string>

opcional

order by

Valores permitidos:

planned_start_hourplanned_end_hourroute_nameplanned_productive_kmplanned_dead_start_kmplanned_dead_end_kmstop_counts

Padrão:

planned_start_hour

order_direction

enum<string>

opcional

order direction

Valores permitidos:

ascdesc

Padrão:

asc

Parâmetros Header

x-api-key

string

requerido

Esta chave é obtida através do sistema por meio do gerenciamento da OpenAPI

Padrão:

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://cgv-prd-trackings-api.contele.io/api/v1/list-planning-routes?route_date' \
--header 'x-api-key;'

Respostas

🟢200OK

application/json

ok

Body

routes

array [object {21}]

opcional

planned_route_id

string

opcional

summary_route_id

string

opcional

route_name

string

opcional

planned_start_hour

string

opcional

planned_end_hour

string

opcional

stop_counts

integer <int32>

opcional

planned_productive_km

number <float>

opcional

planned_dead_start_km

number <float>

opcional

planned_dead_end_km

number <float>

opcional

activity

string

opcional

organization_id

integer <int32>

opcional

route_day

string

opcional

realized_start_hour

string

opcional

realized_end_hour

string

opcional

realized_productive_km

number <float>

opcional

realized_dead_start_km

number <float>

opcional

realized_dead_end_km

number <float>

opcional

realized_driver_id

integer <int32>

opcional

realized_vehicle_id

integer <int32>

opcional

planned_driver_id

integer <int32>

opcional

planned_vehicle_id

integer <int32>

opcional

Exemplo

{
  "routes": [
    {
      "planned_route_id": "string",
      "summary_route_id": "string",
      "route_name": "string",
      "planned_start_hour": "string",
      "planned_end_hour": "string",
      "stop_counts": 0,
      "planned_productive_km": 0,
      "planned_dead_start_km": 0,
      "planned_dead_end_km": 0,
      "activity": "string",
      "organization_id": 0,
      "route_day": "string",
      "realized_start_hour": "string",
      "realized_end_hour": "string",
      "realized_productive_km": 0,
      "realized_dead_start_km": 0,
      "realized_dead_end_km": 0,
      "realized_driver_id": 0,
      "realized_vehicle_id": 0,
      "planned_driver_id": 0,
      "planned_vehicle_id": 0
    }
  ]
}

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor