Contele Fleet
  1. planned-route
Contele Fleet
  • Introdução a API
  • Rotas
    • Introdução a API Trackings
    • Endpoints
      • others
        • healthcheck
        • get sheet data
      • reports
        • get routes reports by group
        • get routes reports by Imei
        • get reports km
        • get driver by day
        • get driver routes in a period
        • get driver routes compiled in a period
        • get driver report
        • get trackings in a period
        • get productivity report
      • bounds
        • bound vehicle with imei
        • bound driver with imei
        • list driver bound per period
      • driver
        • get driver by a given date
      • migration
        • create bound vehicle with imei
        • create bound driver default with imei
      • last-tracking
        • get last tracking by plate number
        • get last tracking by imei
        • get tracking by vehicle id
      • planned-route
        • create planned routes by geojson
          POST
        • create planned routes by geojson
          GET
        • edit routes
          PUT
        • edit planned routes
          PUT
        • delete routes
          DELETE
        • get detailed planned route
          GET
      • new-planned-route
        • create planned route
        • get planned route to update
        • update planned route
      • vehicles
        • get vehicles list
      • trackings
        • create bound vehicle with imei
      • tracker
        • change tracker of vehicle
  • Abastecimentos
    • Endpoints
      • healthcheck
        • health-check
      • fuels
        • create fuels
        • get all info to dashboard
        • list fuels on period
        • delete fuel by id
        • update fuel by id
  • Multas
    • Endpoints
      • others
        • healthcheck
      • fines
        • list fines
        • create fine
        • update fine
        • delete fine
        • get fine
      • infractions
        • list infractions
      • cost
        • cost per month
        • fines per driver
      • dashboard
        • get fines dashboard
  • Manutenção
    • others
      • healthcheck
    • Maintenance
      • list maintenances
      • get maintenance
      • create maintenance
      • update maintenance
      • update maintenance date from calendar
      • update maintenance date from calendar
      • delete maintenance
    • Planning Plan
      • list plans
      • get plan by id
      • list vehicles in plan
      • list items in plan
      • create new plan
      • update plan
      • delete plan
    • Maintenance Dashboard
      • get all info to dashboard
  • Mapa
    • Ultimos Pontos (Last Points)
      • Get last points
      • get specific tracker from cache
      • get specific module info from db
    • lastbreakroutepoint
      • Get last break route points
      • get trackings by period
  • Checklist
    • metrics
      • get dashboard summary from forms
    • attachments
      • insert_form_template_attachment
      • list_form_template_attachment
      • insert_attachment
      • select_attachment
    • custom-filters
      • list_custom_filter
      • create_custom_filter
      • remove_custom_filter
    • form-template
      • create form template
      • create form template
      • copy form templates
      • update form template status
      • update form template status
      • update form template status
      • update form template settings
    • forms
      • create new form
      • update form status
      • update form status
      • list forms
      • list forms without token
    • checklists
      • list checklists
    • answers
      • list answers
      • create new answer
  1. planned-route

create planned routes by geojson

GET
https://cgv-prd-trackings-api.contele.io/api/v1/list-planning-routes
planned-route
Última modificação:2024-11-19 20:38:26

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:
{{api_key}}

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
Modificado em 2024-11-19 20:38:26
Página anterior
create planned routes by geojson
Próxima página
edit routes
Built with