Route - Post Route Range Batch

A API do Lote de Intervalo de Rotas envia lotes de até 100 consultas como uma única chamada para a API de Intervalo de Rotas . Essa API permite o processamento eficiente de várias consultas em uma solicitação, reduzindo a necessidade de chamadas individuais.

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens em lote é limitado a 100 para essa API.

POST https://atlas.microsoft.com/route/range:batch?api-version=2025-01-01

Corpo POST para solicitação em lote

Para enviar o intervalo de rotas consultas, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz de batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo contendo 2 consultas route_range:

{
  "batchItems": [
    {
      "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.86605,
          50.9745
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    },
    {
      "optionalId": "300af787-589b-4088-accd-56828542e293",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201669,
          47.615076
        ]
      },
      "properties": {
        "timeBudgetInSec": 2000
      }
    }
  ]
}

Um intervalo de rotas objeto batchItem pode aceitar qualquer um dos com suporte para ajustar-se às estradasCorpo da solicitação

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequests consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item é de um dos seguintes tipos:

• RouteRangeResponse - Se a consulta foi concluída com êxito.

• Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.

POST {endpoint}/route/range:batch?api-version=2025-01-01

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

AadToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com o controle de acesso baseado em funções Azure , pode ser usado para controlar o acesso às APIs REST Azure Mapas. Controles de acesso baseados em função do Azure são usados para designar acesso a uma ou mais contas ou subrecursos de recursos do Azure Mapas. Qualquer usuário, grupo ou principal de serviço pode receber acesso via um papel embutido ou um papel personalizado composto por uma ou mais permissões para Azure Mapas APIs REST.\n\nPara implementar cenários, recomendamos visualizar conceitos autenticação. Em resumo, essa definição de segurança fornece uma solução para modelagem de aplicações(ões) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige o uso do cabeçalho x-ms-client-id para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento Maps.\n* \nO Authorization URL é específico para a instância Azure nuvem pública. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controle de acesso baseado em função Azure é configurado a partir do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUso do Azure Mapas Web SDK permite a configuração de uma aplicação baseada em configuração para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidade da Microsoft, veja plataforma de identidade da Microsoft visão geral.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta Azure Mapas no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que são emitidas.\n\n Para aplicações publicamente expostas, nossa recomendação é usar a abordagem confidenciais de aplicativos clientes para acessar APIs REST Azure Mapas e assim sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação List SAS no recurso Azure Mapas através do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicativo está autorizado a acessar com Azure controles de acesso baseados em funções e controle detalhado da expiração, taxa e região(s) de uso do token específico. Em outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave compartilhada.\n\n Para aplicações publicamente expostas, nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar abusos de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

A Route Range Batch request containing 1 query

POST {endpoint}/route/range:batch?api-version=2025-01-01

{
  "batchItems": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.86605,
          50.9745
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          52.7109930507,
          -0.591556667114
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    }
  ]
}

{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              5.86605,
              50.9745
            ]
          },
          "properties": {
            "type": "center"
          }
        },
        {
          "type": "Feature",
          "bbox": [
            3.62838,
            49.83259,
            7.9826,
            52.25674
          ],
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  5.73602,
                  52.03704
                ],
                [
                  5.59435,
                  52.09456
                ],
                [
                  5.42279,
                  52.16815
                ],
                [
                  5.21276,
                  52.25047
                ],
                [
                  5.15355,
                  52.21374
                ],
                [
                  4.96687,
                  52.25674
                ],
                [
                  4.739,
                  52.07834
                ],
                [
                  4.72513,
                  52.05647
                ],
                [
                  4.53237,
                  51.94553
                ],
                [
                  4.31165,
                  51.70119
                ],
                [
                  4.28917,
                  51.5837
                ],
                [
                  3.82685,
                  51.48463
                ],
                [
                  3.62838,
                  51.21096
                ],
                [
                  3.89244,
                  50.6814
                ],
                [
                  3.93493,
                  50.66791
                ],
                [
                  3.98156,
                  50.49042
                ],
                [
                  4.47995,
                  50.30944
                ],
                [
                  4.60502,
                  50.24448
                ],
                [
                  4.89999,
                  50.24467
                ],
                [
                  5.04206,
                  50.08735
                ],
                [
                  5.23042,
                  49.99214
                ],
                [
                  5.40994,
                  49.88478
                ],
                [
                  5.46178,
                  49.85797
                ],
                [
                  5.7196,
                  49.86279
                ],
                [
                  5.74151,
                  49.83259
                ],
                [
                  5.9387,
                  50.22239
                ],
                [
                  6.08535,
                  50.0011
                ],
                [
                  6.12089,
                  50.04616
                ],
                [
                  6.28373,
                  50.09472
                ],
                [
                  6.51654,
                  49.95863
                ],
                [
                  6.61034,
                  50.00485
                ],
                [
                  6.70295,
                  50.00587
                ],
                [
                  6.65865,
                  50.2947
                ],
                [
                  6.79276,
                  50.36903
                ],
                [
                  7.32163,
                  50.31614
                ],
                [
                  7.58782,
                  50.36737
                ],
                [
                  7.7626,
                  50.46919
                ],
                [
                  7.9826,
                  50.96246
                ],
                [
                  7.55924,
                  51.07086
                ],
                [
                  7.58138,
                  51.36614
                ],
                [
                  7.67861,
                  51.52015
                ],
                [
                  7.35175,
                  51.65781
                ],
                [
                  7.21664,
                  51.81916
                ],
                [
                  7.0467,
                  51.9587
                ],
                [
                  6.67267,
                  51.82713
                ],
                [
                  6.48424,
                  51.81133
                ],
                [
                  6.27316,
                  51.9368
                ],
                [
                  6.14452,
                  52.01701
                ],
                [
                  6.09312,
                  52.20847
                ],
                [
                  6.01297,
                  52.23705
                ],
                [
                  5.86605,
                  50.9745
                ],
                [
                  5.73602,
                  52.03704
                ]
              ]
            ]
          },
          "properties": {
            "type": "boundary"
          }
        }
      ]
    },
    {
      "error": {
        "code": "BadRequest",
        "message": "No routable road could be found near one or more specified points."
      }
    }
  ],
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  }
}

Definições

AdrTunnelRestrictionCodeEnum

O código de restrição do túnel ADR. A ADR é um acordo europeu relativo ao transporte internacional de mercadorias perigosas por estrada. O código de restrição do túnel ADR é usado para determinar se um veículo tem permissão para passar por um túnel com restrições no transporte de mercadorias perigosas.

CommonErrorDetail

O detalhe do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.

GeoJsonObjectType

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

InputRouteRangeProperties

Especifica os parâmetros a serem usados para o cálculo do polígono isocrono.

MapsErrorDetail

O detalhe do erro.

MapsErrorResponse

Resposta comum de erro para APIs do Azure Mapas devolver detalhes de erro em operações falhadas.

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

RouteRangeAvoidEnum

Especifica as restrições que o cálculo de rota deve respeitar ao determinar os locais acessíveis. Evite dar suporte a vários valores em uma solicitação. \n\nExemplo: "evitar": ["Acesso limitadoHighways", "PedágioVias"]

RouteRangeBatchRequestBody

A lista de consultas/solicitações de intervalo de rotas a serem processadas. A lista pode conter no máximo 100 consultas e deve conter pelo menos 1 consulta.

RouteRangeBatchRequestItem

Objeto De Consulta em Lote

RouteRangeBatchResponse

Esse objeto é retornado de uma chamada de serviço do Lote de Intervalo de Rotas bem-sucedida.

RouteRangeBatchResponseItem

detalhes do erro

RouteRangeBatchResponseSummary

Resumo da solicitação em lote

RouteRangeFeatureProperties

Propriedades de Intervalos de Rotas.

RouteRangeFeaturesItem

Objeto de recurso GeoJSON que contém o objeto Geometry e propriedades adicionais da rota.

RouteRangeOptimizeRouteEnum

Especifica o parâmetro a ser usado para otimizar a rota. Se não for definido, o padrão será "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais.

Exemplo: "optimizeRoute":"shortest"

RouteRangePointGeometry

Especifica o objeto GeoJSON Point Geometry. Consulte RFC 7946 para obter detalhes.

RouteRangePolygonGeometry

Especifica o objeto GeoJSON Polygon Geometry. Consulte RFC 7946 para obter detalhes.

RouteRangeTravelModeEnum

Especifica o perfil de viagem a ser considerado ao calcular o polígono de intervalo. Se não for especificado, o valor padrão será "condução".

Exemplo: "travelMode":"driving"

RouteRangeTypeEnum

Os tipos de recurso para os objetos de recurso retornados na resposta.

RouteRangeVehicleSpec

Especifica os atributos do veículo, como altura do veículo, peso, velocidade máxima, tipo de carga etc. a serem considerados ao calcular os locais acessíveis. Isso ajuda a evitar baixas liberações de ponte, restrições de estrada, curvas à direita difíceis para fornecer a rota otimizada do caminhão com base nas especificações do veículo. Os atributos do veículo são especificados na propriedade vehicleSpec.

VehicleLoadTypeEnum

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas.