Itinerários

Nesta documentação, você encontrará todas as informações necessárias para criar, editar e listar itinerários por meio de nossa API.

Autenticação

Antes de começar a utilizar os endpoints relacionados a itinerários, certifique-se de incluir as credenciais de autenticação adequadas no cabeçalho de suas solicitações. Sem autenticação válida, você não terá permissão para acessar ou modificar os itinerários. Para ter acesso a documentação dessa etapa clique aqui

Cadastro

Por meio de uma requisição POST, cria um novo itinerário com base nos parâmetros fornecidos.

https://api.webrota.com.br/itinerary/

Exemplo de payload

{
    "data": {
        "description": "Viagem Fretada do WR TOUR - Grupo de Turismo WebRota",
        "external_id": "COD_ANTT",
        "vehicle_id": 123,
        "driver_id": 123,
        "date_time_start_estimated": "2023-06-01T19:03:00.000Z",
        "date_time_end_estimated": "2023-06-20T19:03:00.000Z",
        "start_local": "Uberlândia/MG",
        "end_local": "São Paulo/SP"
    }
}

Editando um itinerário

Atualiza as informações de um itinerário existente com base em seu ID. Utiliza-se o verbo HTTP PUT.

https://api.webrota.com.br/itinerary/ID

Exemplo de payload

{
    "data": {
        "description": "Nome do itinerário",
        "external_id": "COD_ANTT",
        "vehicle_id": 2675,
        "driver_id": 7423,
        "date_time_start": "2023-06-01T19:03:00.000Z",
        "date_time_end": "2023-06-20T19:03:00.000Z"
    }
}

Listando os itinerários cadastrados

Retorna todos os itinerários cadastrados, por meio de GET.

GET

https://api.webrota.com.br/itinerary/ID

Retorna os detalhes de um itinerário específico com base em seu ID, por meio de GET.

GET

https://api.webrota.com.br/itinerary/

Nome	Tipo	Obrigatório	Padrão	Descrição
vehicle_id	Inteiro	Não		Código do veículo
driver_id	Inteiro	Não		Código do motorista
date_time_start	Data e hora	Sim		Data e hora prevista do início do itinerário
date_time_end	Data e hora	Sim		Data e hora prevista do fim do itinerário
includes	Texto	Não	vehicle driver position_start position_end	Este parâmetro retorna os dados adicionais referentes às entidades complementares aos itinerários

Exemplo de resposta

{
    "customer": null,
    "id": 123,
    "position_start": {
        "date_created": "2023-07-31T19:09:58+00:00",
        "latitude": -23.54268250,
        "longitude": -46.19397800,
        "date_time": "2023-07-31T19:09:57+00:00"
    },
    "position_end": {
        "date_created": "2023-07-31T19:10:03+00:00",
        "latitude": -23.54268260,
        "longitude": -46.19397750,
        "date_time": "2023-07-31T19:10:00+00:00"
    },
    "description": "Nome do itinerario",
    "external_id": "COD_ANTT",
    "date_created": "2023-06-20T20:25:45+00:00",
    "itineraries": [],
    "driver_id": 123,
    "date_excluded": null,
    "date_time_end": "2023-06-20T19:03:00+00:00",
    "driver": null,
    "date_modified": "2023-06-20T20:28:03.940343+00:00",
    "vehicle_id": 123,
    "date_time_start": "2023-06-01T19:03:00+00:00",
    "vehicle": null
}