Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • name- Texto único com o nome do veículo. Usado para ser referenciado em Operations e para identificação do veículo que irá executar a rota.

  • vehicleType- Texto com o tipo de veículo declarado em vehicleTypes.

  • legislationProfile- Texto com o perfil de legislação, declarado em legislationProfiles.

  • availablePeriods- Descreve características da jornada de trabalho disponível do motorista do veículo. É possível definir mais de uma janela horária. Há parâmetros obrigatórios e opcionais. Os obrigatórios são:

    • start- Horário de início que se iniciará a jornada de trabalho. Formato timestamp: 1511901826456.

    • end- Horário de fim que se encerrará a jornada de trabalho. Formato timestamp: 1511904661038.

Exemplo com parâmetros obrigatórios

...

Code Block
languagejson
"vehicles": [
    {
        "name": "VUC_1",
        "vehicleType": "VUC",
        "legislationProfile": "DEFAULT",
        "availablePeriods": [
            {
                "timeWindow": {
                    "start": 1513753200000,
                    "end": 1513796400000
                }
            },
            {
                "timeWindow": {
                    "start": 1513843200000,
                    "end": 1513879200000
                }
            }
        ]
    }
],

...

  • availablePeriods- Descreve características da jornada de trabalho disponível do motorista do veículo. Os parâmetros opcionais são:

    • departureSite- Texto com o local de partida do veículo no início da rota. Se não declarado a Planning API decidirá o depot de início.

    • arrivalSite- Texto com o local de retorno do veículo no final da rota. Se não declarado a Planning API decidirá qual o último site da última operação para finalizar a rota.

    • maxRoutesNumber- Número inteiro com a quantidade de rotas máximas para o período disponível. Por exemplo, se "maxRoutesNumber": 1, o veículo executará todas as operações na mesma rota.

  • legislationProfile- Texto com o perfil de legislação, declarado em legislationProfiles.

  • logisticZones- Array com os nomes das zonas logísticas em que o veículo poderá realizar as operações. Devem ser únicos e devem ter o mesmo nome declarado em Logistic Zones.

  • trip- Indica que além da ordenação dos pontos logísticos, a rota também deve ser retornada.
    Todos os parâmetros aceitos pela API Trip são aceitos aqui. Para saber mais consultar: 2.1. Request Parameters

Exemplo com parâmetros opcionais

...

Code Block
languagejson
"vehicles": [
    {
        "name": "154",
        "vehicleType": "Moto",
        "legislationProfile": "DEFAULT",
        "availablePeriods": [
            {
                "timeWindow": {
                    "start": 1611057600000,
                    "end": 1611082800000
                },
                "departureSite": "maam2",
                "arrivalSite": "maam2",
                "maxRoutesNumber": 1
            }
        ]
        "logisticZones": [
            "CE - ZONA LESTE",
            "CE - ZONA SUL"
        ],
        "trip": {
            "calculationMode": "THE_FASTEST",
            "crossedBorders": {
                "level": "CITY"
            },
            "toll": {
                "vehicleType": "MOTORCYCLE"
            }
        }
    },
    {
        "name": "150",
        "vehicleType": "Carro",
        "legislationProfile": "DEFAULT",
        "availablePeriods": [
            {
                "timeWindow": {
                    "start": 1611057600000,
                    "end": 1611082800000
                },
                "departureSite": "fkebvlkbvgrvg",
                "arrivalSite": "ufwevidevgre",
                "maxRoutesNumber": 1
            }
        ],
        "logisticZones": [
            "CE - ZONA NORTE",
            "CE - ZONA OESTE"
        ],
        "trip": {
            "calculationMode": "THE_FASTEST",
            "crossedBorders": {
                "level": "CITY"
            },
]
            "toll": {
                "vehicleType": "CAR"
            }
        }
    }
]