Versions Compared

Key

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

...

  • startDate: Número inteiro com a data e horário de referência no formato timestamp.

  • calculationMode: Indica o modo de cálculo para a rota. Suporta os tipos:

    • THE_FASTEST: considera o caminho mais rápido.

    • THE_SHORTEST: considera o caminho com menor kilometragem.

  • destinations: Descrição dos pontos de destino com:

    • siteId: Identificador do ponto de parada.

    • latitude: coordenada da latitude em graus decimais.

    • longitude: coordenada da longitude em graus decimais.

  • origins: Descrição dos pontos de origem com:

    • siteId: Identificador do ponto de parada.

    • latitude: coordenada da latitude em graus decimais.

    • longitude: coordenada da longitude em graus decimais.

  • tripProfile:Identificador do perfil para realizar a rota. Ver mais em profileName. Somente será considerado os parâmetros do profile caso não estejam explicitamente declarados na request. Exemplo: se a request tiver áreas de restrição, não será considerado o do Trip Profile.

...

  • avoidanceTypes: Indica que a rota deverá determinados tipos de elementos do sistema viário. Valores permitidos são: [TUNNELS, BRIDGES, FERRIES, TOLL_ROADS, TOLL_GATES].

  • callback: Contém os dados do callback que é uma URL de webhook para receber os eventos do cálculo do problema. Útil para evitar o consumo de créditos com a API de feedback para checar os eventos, visto que o callback irá enviar o status do processamento. Ver mais em callback (Planning API). Os argumentos possíveis são:

    • url- URL com o endereço que irá receber o callback.

    • user- texto com o nome do usuário caso o endpoint precisar de autenticação.

    • password- texto com a senha caso o endpoint precisar de autenticação.

  • restrictionZones: Array com o texto do nome da área de restrição previamente cadastradas na Restriction Zone API.

...