Partilhar via

@azure-rest/maps-route package

  • Referência

Interfaces

BatchRequest

Esse tipo representa o corpo da solicitação para o serviço de lote.
BatchRequestItem

Objeto de solicitação de lote
BatchResultItemOutput

Um item retornado da API de lote. Estender com a propriedade 'response'.
BatchResultOutput

Este objeto é retornado de uma chamada de serviço em lote bem-sucedida. Estenda com a propriedade 'batchItems'.
BatchResultSummaryOutput

Resumo dos resultados do pedido de lote
EffectiveSettingOutput

Parâmetro ou dados efetivos usados ao chamar essa API de rota.
ErrorDetailOutput

O detalhe do erro.
ErrorResponseOutput

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)
GeoJsonFeature

Um tipo de objeto GeoJSON Feature válido. Consulte RFC 7946 para obter detalhes.
GeoJsonFeatureCollection

Um tipo de objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obter detalhes.
GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

Um tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollectionData
GeoJsonGeometryParent

Um objeto de geometria GeoJSON válido. O tipo deve ser um dos sete tipos de geometria GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonLineString

Um tipo de geometria GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonLineStringData
GeoJsonMultiLineString

Um tipo de geometria GeoJSON MultiLineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineStringData
GeoJsonMultiPoint

Um tipo de geometria GeoJSON MultiPoint válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPointData

Dados contidos por um GeoJson MultiPoint.
GeoJsonMultiPolygon

Um tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygonData
GeoJsonObjectParent

Um objeto GeoJSON válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPointData

Dados contidos por um GeoJson Point.
GeoJsonPolygon

Um tipo de geometria GeoJSON Polygon válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

Um local representado como latitude e longitude.
MapsRouteClientOptions

Os parâmetros opcionais para o cliente
RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Postar parâmetros do corpo para direções de rota.
RouteDirectionsBatchItemOutput

Um item retornado da chamada de serviço Route Directions Batch.
RouteDirectionsBatchItemResponseOutput

O resultado da consulta. RouteDirections se a consulta for concluída com êxito, ErrorResponse caso contrário.
RouteDirectionsBatchResultOutput

Este objeto é retornado de uma chamada de serviço Route Directions Batch bem-sucedida.
RouteDirectionsOutput

Este objeto é retornado de uma chamada bem-sucedida de Direções de Rota
RouteGetRouteDirections200Response

A API Get Route Directions é uma solicitação de GET HTTP que retorna uma rota entre uma origem e um destino, passando por pontos de passagem, se especificado. O percurso tem em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia da semana e hora do dia solicitados.

As informações devolvidas incluem a distância, o tempo de viagem estimado e uma representação da geometria da rota. Informações adicionais de roteamento, como ordem de waypoint otimizada ou instruções curva a curva, também estão disponíveis, dependendo das opções selecionadas.

O serviço de encaminhamento fornece um conjunto de parâmetros para uma descrição detalhada de um modelo de consumo específico do veículo. Para obter mais informações, consulte Modelo de consumo .
RouteGetRouteDirectionsBatch200Response

A API Get Route Directions Batch é uma solicitação de GET HTTP que envia lotes de consultas para a API Obter Direções de Rota usando uma única solicitação. Você pode chamar Get Route Directions Batch API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas.

Baixar resultados de lote assíncronos

Para baixar os resultados do lote assíncrono, você emitirá uma solicitação de GET para o ponto de extremidade de download em lote. Este URL de download pode ser obtido a partir do cabeçalho Location de uma solicitação de lote de POST bem-sucedida e tem a seguinte aparência:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Aqui está a sequência típica de operações para baixar os resultados do lote:

  1. O cliente envia uma solicitação de GET usando o URL de download .

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação em lote foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

    HTTP 200 OK - Solicitação em lote processada com sucesso. O corpo da resposta contém todos os resultados do lote.

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação de lote assíncrona, se o lote tiver terminado o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item no batchItems contém statusCode e response campos. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de resposta em lote com 1 bem-sucedido e 1 resultado falhado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsBatch202Headers
RouteGetRouteDirectionsBatch202Response

A API Get Route Directions Batch é uma solicitação de GET HTTP que envia lotes de consultas para a API Obter Direções de Rota usando uma única solicitação. Você pode chamar Get Route Directions Batch API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas.

Baixar resultados de lote assíncronos

Para baixar os resultados do lote assíncrono, você emitirá uma solicitação de GET para o ponto de extremidade de download em lote. Este URL de download pode ser obtido a partir do cabeçalho Location de uma solicitação de lote de POST bem-sucedida e tem a seguinte aparência:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Aqui está a sequência típica de operações para baixar os resultados do lote:

  1. O cliente envia uma solicitação de GET usando o URL de download .

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação em lote foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

    HTTP 200 OK - Solicitação em lote processada com sucesso. O corpo da resposta contém todos os resultados do lote.

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação de lote assíncrona, se o lote tiver terminado o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item no batchItems contém statusCode e response campos. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de resposta em lote com 1 bem-sucedido e 1 resultado falhado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsDefaultResponse

A API Get Route Directions é uma solicitação de GET HTTP que retorna uma rota entre uma origem e um destino, passando por pontos de passagem, se especificado. O percurso tem em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia da semana e hora do dia solicitados.

As informações devolvidas incluem a distância, o tempo de viagem estimado e uma representação da geometria da rota. Informações adicionais de roteamento, como ordem de waypoint otimizada ou instruções curva a curva, também estão disponíveis, dependendo das opções selecionadas.

O serviço de encaminhamento fornece um conjunto de parâmetros para uma descrição detalhada de um modelo de consumo específico do veículo. Para obter mais informações, consulte Modelo de consumo .
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

A API Post Route Directions é uma solicitação de POST HTTP que retorna uma rota entre uma origem e um destino, passando por pontos de passagem se eles forem especificados. O percurso terá em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia da semana e hora do dia solicitados.

As informações devolvidas incluem a distância, o tempo de viagem estimado e uma representação da geometria da rota. Informações adicionais de roteamento, como ordem de waypoint otimizada ou instruções curva a curva, também estão disponíveis, dependendo das opções selecionadas.

O serviço de roteamento fornece um conjunto de parâmetros para uma descrição detalhada de um Modelo de Consumo específico do veículo. Por favor, verifique Modelo de Consumo para obter uma explicação detalhada dos conceitos e parâmetros envolvidos.
RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

A API Post Route Directions é uma solicitação de POST HTTP que retorna uma rota entre uma origem e um destino, passando por pontos de passagem se eles forem especificados. O percurso terá em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia da semana e hora do dia solicitados.

As informações devolvidas incluem a distância, o tempo de viagem estimado e uma representação da geometria da rota. Informações adicionais de roteamento, como ordem de waypoint otimizada ou instruções curva a curva, também estão disponíveis, dependendo das opções selecionadas.

O serviço de roteamento fornece um conjunto de parâmetros para uma descrição detalhada de um Modelo de Consumo específico do veículo. Por favor, verifique Modelo de Consumo para obter uma explicação detalhada dos conceitos e parâmetros envolvidos.
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

A API Get Route Matrix é uma solicitação de GET HTTP que calcula o tempo de viagem e a distância para todos os pares possíveis em uma lista de origens e destinos. Ao contrário da API Get Route Directions, que fornece instruções detalhadas de rota, esta API se concentra na eficiência, dando-lhe o custo (tempo de viagem e distância) de roteamento de cada origem para cada destino. Para obter mais informações, consulte Práticas recomendadas para o serviço de Rota do Azure Maps.

Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Como exemplo, digamos que uma empresa de entrega de comida tenha 20 motoristas e eles precisem encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e distâncias são devolvidos. Você pode usar os custos calculados para determinar quais rotas detalhadas calcular usando a API de Direções de Rota.

O tamanho máximo de uma matriz para solicitação assíncrona é 700 e para solicitação de sincronização é de 100 (o número de origens multiplicado pelo número de destinos).

Enviar solicitação de matriz de rota síncrona

Se o seu cenário exigir solicitações síncronas e o tamanho máximo da matriz for menor ou igual a 100, convém fazer uma solicitação síncrona. O tamanho máximo de uma matriz para esta API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 10x10, 6x8, 9x8 (não precisa ser quadrado).

GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitação de matriz de rota assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de roteamento relativamente complexas. Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação estiver definido como true, o usuário obterá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).

As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Aqui está uma sequência típica de operações assíncronas:

  1. O cliente envia uma solicitação GET da Matriz de Rota para o Azure Maps

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de matriz de rota foi aceita.

    HTTP Error - Ocorreu um erro ao processar o seu pedido de Route Matrix. Isso pode ser uma solicitação incorreta 400 ou qualquer outro código de status de erro.

  3. Se a solicitação de Rota de Matriz foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. O cliente emite uma solicitação GET no URL de download obtido na Etapa 3 para baixar os resultados

Baixar resultados de sincronização

Quando você faz uma solicitação GET para a API de sincronização da matriz de rota, o serviço retorna 200 código de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá possibilidade de recuperar os resultados mais tarde.

Baixar resultados assíncronos

Quando uma solicitação emite uma resposta 202 Accepted, a solicitação está sendo processada usando nosso pipeline assíncrono. Você receberá uma URL para verificar o progresso da sua solicitação assíncrona no cabeçalho do local da resposta. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O URL fornecido pelo cabeçalho do local retornará as seguintes respostas quando uma solicitação de GET for emitida.

HTTP 202 Accepted - A solicitação de matriz foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Pedido de matriz processado com sucesso. O corpo da resposta contém todos os resultados.
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

A API Get Route Matrix é uma solicitação de GET HTTP que calcula o tempo de viagem e a distância para todos os pares possíveis em uma lista de origens e destinos. Ao contrário da API Get Route Directions, que fornece instruções detalhadas de rota, esta API se concentra na eficiência, dando-lhe o custo (tempo de viagem e distância) de roteamento de cada origem para cada destino. Para obter mais informações, consulte Práticas recomendadas para o serviço de Rota do Azure Maps.

Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Como exemplo, digamos que uma empresa de entrega de comida tenha 20 motoristas e eles precisem encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e distâncias são devolvidos. Você pode usar os custos calculados para determinar quais rotas detalhadas calcular usando a API de Direções de Rota.

O tamanho máximo de uma matriz para solicitação assíncrona é 700 e para solicitação de sincronização é de 100 (o número de origens multiplicado pelo número de destinos).

Enviar solicitação de matriz de rota síncrona

Se o seu cenário exigir solicitações síncronas e o tamanho máximo da matriz for menor ou igual a 100, convém fazer uma solicitação síncrona. O tamanho máximo de uma matriz para esta API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 10x10, 6x8, 9x8 (não precisa ser quadrado).

GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitação de matriz de rota assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de roteamento relativamente complexas. Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação estiver definido como true, o usuário obterá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).

As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Aqui está uma sequência típica de operações assíncronas:

  1. O cliente envia uma solicitação GET da Matriz de Rota para o Azure Maps

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de matriz de rota foi aceita.

    HTTP Error - Ocorreu um erro ao processar o seu pedido de Route Matrix. Isso pode ser uma solicitação incorreta 400 ou qualquer outro código de status de erro.

  3. Se a solicitação de Rota de Matriz foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. O cliente emite uma solicitação GET no URL de download obtido na Etapa 3 para baixar os resultados

Baixar resultados de sincronização

Quando você faz uma solicitação GET para a API de sincronização da matriz de rota, o serviço retorna 200 código de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá possibilidade de recuperar os resultados mais tarde.

Baixar resultados assíncronos

Quando uma solicitação emite uma resposta 202 Accepted, a solicitação está sendo processada usando nosso pipeline assíncrono. Você receberá uma URL para verificar o progresso da sua solicitação assíncrona no cabeçalho do local da resposta. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O URL fornecido pelo cabeçalho do local retornará as seguintes respostas quando uma solicitação de GET for emitida.

HTTP 202 Accepted - A solicitação de matriz foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Pedido de matriz processado com sucesso. O corpo da resposta contém todos os resultados.
RouteGetRouteRange200Response

A API Get Route Range (Isochrone) é uma solicitação de GET HTTP que calculará um conjunto de locais que podem ser alcançados a partir do ponto de origem com base no orçamento de combustível, energia, tempo ou distância especificado. Um limite de polígono (ou Isochrone) é retornado em uma orientação anti-horário, bem como o centro de polígono preciso que foi o resultado do ponto de origem.

O polígono retornado pode ser usado para processamento adicional, como Search Inside Geometry para procurar POIs dentro da isocrona fornecida.
RouteGetRouteRangeDefaultResponse

A API Get Route Range (Isochrone) é uma solicitação de GET HTTP que calculará um conjunto de locais que podem ser alcançados a partir do ponto de origem com base no orçamento de combustível, energia, tempo ou distância especificado. Um limite de polígono (ou Isochrone) é retornado em uma orientação anti-horário, bem como o centro de polígono preciso que foi o resultado do ponto de origem.

O polígono retornado pode ser usado para processamento adicional, como Search Inside Geometry para procurar POIs dentro da isocrona fornecida.
RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

Contém elementos relacionados com orientações. Este campo está presente apenas quando a orientação foi solicitada e está disponível.
RouteInstructionGroupOutput

Agrupa uma sequência de elementos de instrução que estão relacionados entre si. O intervalo de sequência é restrito com firstInstructionIndex e lastInstructionIndex. Quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou tagged), o instructionGroup tem uma mensagem de resumo retornada quando disponível.
RouteInstructionOutput

Um conjunto de atributos que descrevem uma manobra, por exemplo, «Vire à direita», «Mantenha-se à esquerda», «Apanhe o ferry», «Apanhe a autoestrada», «Chegar».
RouteLegOutput

Descrição de uma parte de um percurso, composta por uma lista de pontos. Cada waypoint adicional fornecido na solicitação resultará em um trecho adicional na rota devolvida.
RouteMatrixOutput

Objeto de resultado da matriz
RouteMatrixQuery

Um objeto com uma matriz de coordenadas.
RouteMatrixResultOutput

Este objeto é retornado de uma chamada Route Matrix bem-sucedida. Por exemplo, se forem fornecidas 2 origens e 3 destinos, haverá 2 matrizes com 3 elementos em cada. O conteúdo de cada elemento depende das opções fornecidas na consulta.
RouteMatrixResultResponseOutput

Objeto de resposta da célula atual na matriz de entrada.
RouteMatrixSummaryOutput

Objeto de resumo
RouteOptimizedWaypointOutput

Objeto de ponto de caminho otimizado.
RouteOutput
RouteRangeOutput

Alcance acessível
RouteRangeResultOutput

Este objeto é retornado de uma chamada de Intervalo Acessível de Rota bem-sucedida
RouteReportOutput

Relata as configurações efetivas usadas na chamada atual.
RouteRequestRouteDirectionsBatch200Response

A API é uma solicitação de HTTP que envia lotes de consultas para a API Obter Direções de Rota usando uma única solicitação assíncrona. Você pode chamar Route Directions Batch API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas. Para chamar a API Post Route Directions Batch em uma solicitação síncrona, consulte Post Route Directions Batch Sync.

Enviar solicitação de lote assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de rota relativamente complexas

  • Ele permite a recuperação de resultados em uma chamada separada (vários downloads são possíveis).
  • A API assíncrona é otimizada para confiabilidade e não se espera que atinja um tempo limite.
  • O número de itens de lote é limitado a 700 para esta API.

Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

Observe que a solicitação de lote assíncrona é uma operação de longa duração. Aqui está uma sequência típica de operações:

  1. O Cliente envia um Lote de Direções de Rota POST pedido para o Azure Maps.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de lote foi aceita.

    Error HTTP - Ocorreu um erro ao processar o seu pedido em lote. Pode ser um 400 Bad Request ou qualquer outro código de status Error.

  2. Se a solicitação em lote foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação em lote. Esse URI de status tem a seguinte aparência:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. O cliente emite uma solicitação de GET no URL de download do obtido na Etapa 3 para baixar os resultados do lote.

Corpo POST para solicitação de lote

Para enviar as direções de rota consultas, você usará uma solicitação de POST onde o corpo da solicitação conterá a matriz batchItems em json formato e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo contendo 3 direções de rota consultas:

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Uma direções de rota consulta em um lote é apenas uma de URL parcial, sem o protocolo, a URL base, o caminho, a versão da api e a chave de assinatura. Ele pode aceitar qualquer uma das direções de rota de suportadasparâmetros de URI. Os valores de cadeia de caracteres nas direções de rota consulta devem ser escapados corretamente (por exemplo, " caractere deve ser escapado com \ ) e também devem ser codificados corretamente por URL.

A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas, e o lote deve conter pelo menos 1 consulta.

Baixar resultados de lote assíncronos

Para baixar os resultados do lote assíncrono, você emitirá uma solicitação de GET para o ponto de extremidade de download em lote. Este URL de download pode ser obtido a partir do cabeçalho Location de uma solicitação de lote de POST bem-sucedida e tem a seguinte aparência:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Aqui está a sequência típica de operações para baixar os resultados do lote:

  1. O cliente envia uma solicitação de GET usando o URL de download .

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação em lote foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

    HTTP 200 OK - Solicitação em lote processada com sucesso. O corpo da resposta contém todos os resultados do lote.

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação de lote assíncrona, se o lote tiver terminado o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item no batchItems contém statusCode e response campos. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de resposta em lote com 1 bem-sucedido e 1 resultado falhado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatch202Headers
RouteRequestRouteDirectionsBatch202Response

A API é uma solicitação de HTTP que envia lotes de consultas para a API Obter Direções de Rota usando uma única solicitação assíncrona. Você pode chamar Route Directions Batch API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas. Para chamar a API Post Route Directions Batch em uma solicitação síncrona, consulte Post Route Directions Batch Sync.

Enviar solicitação de lote assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de rota relativamente complexas

  • Ele permite a recuperação de resultados em uma chamada separada (vários downloads são possíveis).
  • A API assíncrona é otimizada para confiabilidade e não se espera que atinja um tempo limite.
  • O número de itens de lote é limitado a 700 para esta API.

Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

Observe que a solicitação de lote assíncrona é uma operação de longa duração. Aqui está uma sequência típica de operações:

  1. O Cliente envia um Lote de Direções de Rota POST pedido para o Azure Maps.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de lote foi aceita.

    Error HTTP - Ocorreu um erro ao processar o seu pedido em lote. Pode ser um 400 Bad Request ou qualquer outro código de status Error.

  2. Se a solicitação em lote foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação em lote. Esse URI de status tem a seguinte aparência:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. O cliente emite uma solicitação de GET no URL de download do obtido na Etapa 3 para baixar os resultados do lote.

Corpo POST para solicitação de lote

Para enviar as direções de rota consultas, você usará uma solicitação de POST onde o corpo da solicitação conterá a matriz batchItems em json formato e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo contendo 3 direções de rota consultas:

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Uma direções de rota consulta em um lote é apenas uma de URL parcial, sem o protocolo, a URL base, o caminho, a versão da api e a chave de assinatura. Ele pode aceitar qualquer uma das direções de rota de suportadasparâmetros de URI. Os valores de cadeia de caracteres nas direções de rota consulta devem ser escapados corretamente (por exemplo, " caractere deve ser escapado com \ ) e também devem ser codificados corretamente por URL.

A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas, e o lote deve conter pelo menos 1 consulta.

Baixar resultados de lote assíncronos

Para baixar os resultados do lote assíncrono, você emitirá uma solicitação de GET para o ponto de extremidade de download em lote. Este URL de download pode ser obtido a partir do cabeçalho Location de uma solicitação de lote de POST bem-sucedida e tem a seguinte aparência:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Aqui está a sequência típica de operações para baixar os resultados do lote:

  1. O cliente envia uma solicitação de GET usando o URL de download .

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação em lote foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

    HTTP 200 OK - Solicitação em lote processada com sucesso. O corpo da resposta contém todos os resultados do lote.

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação de lote assíncrona, se o lote tiver terminado o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item no batchItems contém statusCode e response campos. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de resposta em lote com 1 bem-sucedido e 1 resultado falhado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchBodyParam
RouteRequestRouteDirectionsBatchMediaTypesParam
RouteRequestRouteDirectionsBatchSync200Response

A API é uma solicitação de HTTP que envia lotes de consultas para a API Obter Direções de Rota usando uma única solicitação síncrona. Você pode chamar Route Directions Batch API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas. Para chamar a API Post Route Directions Batch em uma solicitação assíncrona, consulte em lote de direções pós-rota.

Enviar solicitação de lote síncrona

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

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação de lote assíncrona, se o lote tiver terminado o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item no batchItems contém statusCode e response campos. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de resposta em lote com 1 bem-sucedido e 1 resultado falhado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSync408Response

A API é uma solicitação de HTTP que envia lotes de consultas para a API Obter Direções de Rota usando uma única solicitação síncrona. Você pode chamar Route Directions Batch API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas. Para chamar a API Post Route Directions Batch em uma solicitação assíncrona, consulte em lote de direções pós-rota.

Enviar solicitação de lote síncrona

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

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação de lote assíncrona, se o lote tiver terminado o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item no batchItems contém statusCode e response campos. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de resposta em lote com 1 bem-sucedido e 1 resultado falhado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncBodyParam
RouteRequestRouteDirectionsBatchSyncDefaultResponse

A API é uma solicitação de HTTP que envia lotes de consultas para a API Obter Direções de Rota usando uma única solicitação síncrona. Você pode chamar Route Directions Batch API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas. Para chamar a API Post Route Directions Batch em uma solicitação assíncrona, consulte em lote de direções pós-rota.

Enviar solicitação de lote síncrona

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

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação de lote assíncrona, se o lote tiver terminado o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item no batchItems contém statusCode e response campos. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de resposta em lote com 1 bem-sucedido e 1 resultado falhado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncMediaTypesParam
RouteRequestRouteMatrix200Response

A API Post Route Matrix é uma solicitação de POST HTTP que permite o cálculo de uma matriz de resumos de rota para um conjunto de rotas definidas por locais de origem e destino usando uma solicitação assíncrona (assíncrona). Para fazer uma solicitação síncrona (sincronização), consulte Post Route Matrix Sync. Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Como exemplo, digamos que uma empresa de entrega de comida tenha 20 motoristas e eles precisem encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e distâncias são devolvidos. Você pode usar os custos calculados para determinar quais rotas detalhadas calcular usando a API de Direções de Rota.

O tamanho máximo de uma matriz para solicitação assíncrona é 700 e para solicitação de sincronização é de 100 (o número de origens multiplicado pelo número de destinos).

Nota

Todas as origens e destinos devem estar contidos numa caixa delimitadora de 400 km x 400 km alinhada por eixos. Caso contrário, algumas células da matriz serão resolvidas como OUT_OF_REGION.

Enviar solicitação de matriz de rota síncrona

Se o seu cenário exigir solicitações síncronas e o tamanho máximo da matriz for menor ou igual a 100, convém fazer uma solicitação síncrona. O tamanho máximo de uma matriz para esta API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 10x10, 6x8, 9x8 (não precisa ser quadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitação de matriz de rota assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de roteamento relativamente complexas. Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação estiver definido como true, o usuário obterá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).

As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Aqui está uma sequência típica de operações assíncronas:

  1. O cliente envia uma solicitação POST da Matriz de Rota para o Azure Maps

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de matriz de rota foi aceita.

    HTTP Error - Ocorreu um erro ao processar o seu pedido de Route Matrix. Isso pode ser uma solicitação incorreta 400 ou qualquer outro código de status de erro.

  3. Se a solicitação de Rota de Matriz foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. O cliente emite uma solicitação GET no URL de download obtido na Etapa 3 para baixar os resultados

Baixar resultados de sincronização

Quando você faz uma solicitação POST para a API de sincronização da matriz de rota, o serviço retorna 200 código de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá possibilidade de recuperar os resultados mais tarde.

Baixar resultados assíncronos

Quando uma solicitação emite uma resposta 202 Accepted, a solicitação está sendo processada usando nosso pipeline assíncrono. Você receberá uma URL para verificar o progresso da sua solicitação assíncrona no cabeçalho do local da resposta. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O URL fornecido pelo cabeçalho do local retornará as seguintes respostas quando uma solicitação de GET for emitida.

HTTP 202 Accepted - A solicitação de matriz foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Pedido de matriz processado com sucesso. O corpo da resposta contém todos os resultados.
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

A API Post Route Matrix é uma solicitação de POST HTTP que permite o cálculo de uma matriz de resumos de rota para um conjunto de rotas definidas por locais de origem e destino usando uma solicitação assíncrona (assíncrona). Para fazer uma solicitação síncrona (sincronização), consulte Post Route Matrix Sync. Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Como exemplo, digamos que uma empresa de entrega de comida tenha 20 motoristas e eles precisem encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e distâncias são devolvidos. Você pode usar os custos calculados para determinar quais rotas detalhadas calcular usando a API de Direções de Rota.

O tamanho máximo de uma matriz para solicitação assíncrona é 700 e para solicitação de sincronização é de 100 (o número de origens multiplicado pelo número de destinos).

Nota

Todas as origens e destinos devem estar contidos numa caixa delimitadora de 400 km x 400 km alinhada por eixos. Caso contrário, algumas células da matriz serão resolvidas como OUT_OF_REGION.

Enviar solicitação de matriz de rota síncrona

Se o seu cenário exigir solicitações síncronas e o tamanho máximo da matriz for menor ou igual a 100, convém fazer uma solicitação síncrona. O tamanho máximo de uma matriz para esta API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 10x10, 6x8, 9x8 (não precisa ser quadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitação de matriz de rota assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de roteamento relativamente complexas. Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação estiver definido como true, o usuário obterá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).

As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Aqui está uma sequência típica de operações assíncronas:

  1. O cliente envia uma solicitação POST da Matriz de Rota para o Azure Maps

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de matriz de rota foi aceita.

    HTTP Error - Ocorreu um erro ao processar o seu pedido de Route Matrix. Isso pode ser uma solicitação incorreta 400 ou qualquer outro código de status de erro.

  3. Se a solicitação de Rota de Matriz foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. O cliente emite uma solicitação GET no URL de download obtido na Etapa 3 para baixar os resultados

Baixar resultados de sincronização

Quando você faz uma solicitação POST para a API de sincronização da matriz de rota, o serviço retorna 200 código de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá possibilidade de recuperar os resultados mais tarde.

Baixar resultados assíncronos

Quando uma solicitação emite uma resposta 202 Accepted, a solicitação está sendo processada usando nosso pipeline assíncrono. Você receberá uma URL para verificar o progresso da sua solicitação assíncrona no cabeçalho do local da resposta. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O URL fornecido pelo cabeçalho do local retornará as seguintes respostas quando uma solicitação de GET for emitida.

HTTP 202 Accepted - A solicitação de matriz foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Pedido de matriz processado com sucesso. O corpo da resposta contém todos os resultados.
RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

A API Post Route Matrix Sync é uma solicitação HTTP POST que permite o cálculo de uma matriz de resumos de rota para um conjunto de rotas definidas por locais de origem e destino usando uma única solicitação síncrona (sincronização). Para fazer uma solicitação assíncrona (assíncrona), consulte Matriz de rota pós. Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Como exemplo, digamos que uma empresa de entrega de comida tenha 20 motoristas e eles precisem encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e distâncias são devolvidos. Você pode usar os custos calculados para determinar quais rotas detalhadas calcular usando a API de Direções de Rota.

O tamanho máximo de uma matriz para solicitação assíncrona é 700 e para solicitação de sincronização é de 100 (o número de origens multiplicado pelo número de destinos).

Enviar solicitação de matriz de rota síncrona

Se o seu cenário exigir solicitações síncronas e o tamanho máximo da matriz for menor ou igual a 100, convém fazer uma solicitação síncrona. O tamanho máximo de uma matriz para esta API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 10x10, 6x8, 9x8 (não precisa ser quadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitação de matriz de rota assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de roteamento relativamente complexas. Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação estiver definido como true, o usuário obterá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).

As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Aqui está uma sequência típica de operações assíncronas:

  1. O cliente envia uma solicitação POST da Matriz de Rota para o Azure Maps

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de matriz de rota foi aceita.

    HTTP Error - Ocorreu um erro ao processar o seu pedido de Route Matrix. Isso pode ser uma solicitação incorreta 400 ou qualquer outro código de status de erro.

  3. Se a solicitação de Rota de Matriz foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. O cliente emite uma solicitação GET no URL de download obtido na Etapa 3 para baixar os resultados

Baixar resultados de sincronização

Quando você faz uma solicitação POST para a API de sincronização da matriz de rota, o serviço retorna 200 código de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá possibilidade de recuperar os resultados mais tarde.

Baixar resultados assíncronos

Quando uma solicitação emite uma resposta 202 Accepted, a solicitação está sendo processada usando nosso pipeline assíncrono. Você receberá uma URL para verificar o progresso da sua solicitação assíncrona no cabeçalho do local da resposta. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O URL fornecido pelo cabeçalho do local retornará as seguintes respostas quando uma solicitação de GET for emitida.

HTTP 202 Accepted - A solicitação de matriz foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Pedido de matriz processado com sucesso. O corpo da resposta contém todos os resultados.
RouteRequestRouteMatrixSync408Response

A API Post Route Matrix Sync é uma solicitação HTTP POST que permite o cálculo de uma matriz de resumos de rota para um conjunto de rotas definidas por locais de origem e destino usando uma única solicitação síncrona (sincronização). Para fazer uma solicitação assíncrona (assíncrona), consulte Matriz de rota pós. Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Como exemplo, digamos que uma empresa de entrega de comida tenha 20 motoristas e eles precisem encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e distâncias são devolvidos. Você pode usar os custos calculados para determinar quais rotas detalhadas calcular usando a API de Direções de Rota.

O tamanho máximo de uma matriz para solicitação assíncrona é 700 e para solicitação de sincronização é de 100 (o número de origens multiplicado pelo número de destinos).

Enviar solicitação de matriz de rota síncrona

Se o seu cenário exigir solicitações síncronas e o tamanho máximo da matriz for menor ou igual a 100, convém fazer uma solicitação síncrona. O tamanho máximo de uma matriz para esta API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 10x10, 6x8, 9x8 (não precisa ser quadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitação de matriz de rota assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de roteamento relativamente complexas. Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação estiver definido como true, o usuário obterá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).

As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Aqui está uma sequência típica de operações assíncronas:

  1. O cliente envia uma solicitação POST da Matriz de Rota para o Azure Maps

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de matriz de rota foi aceita.

    HTTP Error - Ocorreu um erro ao processar o seu pedido de Route Matrix. Isso pode ser uma solicitação incorreta 400 ou qualquer outro código de status de erro.

  3. Se a solicitação de Rota de Matriz foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. O cliente emite uma solicitação GET no URL de download obtido na Etapa 3 para baixar os resultados

Baixar resultados de sincronização

Quando você faz uma solicitação POST para a API de sincronização da matriz de rota, o serviço retorna 200 código de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá possibilidade de recuperar os resultados mais tarde.

Baixar resultados assíncronos

Quando uma solicitação emite uma resposta 202 Accepted, a solicitação está sendo processada usando nosso pipeline assíncrono. Você receberá uma URL para verificar o progresso da sua solicitação assíncrona no cabeçalho do local da resposta. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O URL fornecido pelo cabeçalho do local retornará as seguintes respostas quando uma solicitação de GET for emitida.

HTTP 202 Accepted - A solicitação de matriz foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Pedido de matriz processado com sucesso. O corpo da resposta contém todos os resultados.
RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

A API Post Route Matrix Sync é uma solicitação HTTP POST que permite o cálculo de uma matriz de resumos de rota para um conjunto de rotas definidas por locais de origem e destino usando uma única solicitação síncrona (sincronização). Para fazer uma solicitação assíncrona (assíncrona), consulte Matriz de rota pós. Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Como exemplo, digamos que uma empresa de entrega de comida tenha 20 motoristas e eles precisem encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e distâncias são devolvidos. Você pode usar os custos calculados para determinar quais rotas detalhadas calcular usando a API de Direções de Rota.

O tamanho máximo de uma matriz para solicitação assíncrona é 700 e para solicitação de sincronização é de 100 (o número de origens multiplicado pelo número de destinos).

Enviar solicitação de matriz de rota síncrona

Se o seu cenário exigir solicitações síncronas e o tamanho máximo da matriz for menor ou igual a 100, convém fazer uma solicitação síncrona. O tamanho máximo de uma matriz para esta API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 10x10, 6x8, 9x8 (não precisa ser quadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitação de matriz de rota assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de roteamento relativamente complexas. Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação estiver definido como true, o usuário obterá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).

As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Aqui está uma sequência típica de operações assíncronas:

  1. O cliente envia uma solicitação POST da Matriz de Rota para o Azure Maps

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de matriz de rota foi aceita.

    HTTP Error - Ocorreu um erro ao processar o seu pedido de Route Matrix. Isso pode ser uma solicitação incorreta 400 ou qualquer outro código de status de erro.

  3. Se a solicitação de Rota de Matriz foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. O cliente emite uma solicitação GET no URL de download obtido na Etapa 3 para baixar os resultados

Baixar resultados de sincronização

Quando você faz uma solicitação POST para a API de sincronização da matriz de rota, o serviço retorna 200 código de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá possibilidade de recuperar os resultados mais tarde.

Baixar resultados assíncronos

Quando uma solicitação emite uma resposta 202 Accepted, a solicitação está sendo processada usando nosso pipeline assíncrono. Você receberá uma URL para verificar o progresso da sua solicitação assíncrona no cabeçalho do local da resposta. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O URL fornecido pelo cabeçalho do local retornará as seguintes respostas quando uma solicitação de GET for emitida.

HTTP 202 Accepted - A solicitação de matriz foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Pedido de matriz processado com sucesso. O corpo da resposta contém todos os resultados.
RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

As seções de rota contêm informações adicionais sobre partes de uma rota. Cada seção contém pelo menos os elementos startPointIndex, endPointIndexe sectionType.
RouteSectionTecCauseOutput

A causa do evento de trânsito. Pode conter elementos mainCauseCode e subCauseCode. Pode ser usado para definir iconografia e descrições.
RouteSectionTecOutput

Detalhes do evento de tráfego, usando definições no TPEG2-TEC padrão. Pode conter elementos effectCode e causas.
RouteSummaryOutput

Objeto de resumo
Routes
SimplePollerLike

Um poller simples que pode ser usado para sondar uma operação de longa duração.

Aliases de Tipo

GeoJsonGeometry

Um objeto de geometria GeoJSON válido. O tipo deve ser um dos sete tipos de geometria GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonObject

Um objeto GeoJSON válido. Consulte RFC 7946 para obter detalhes.
MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Funções

buildMultiCollection(string[], string)
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Crie um corpo de solicitação em lote de um monte de solicitações de direção de rota.
default(AzureKeyCredential, ClientOptions)

Cria uma instância de MapsRouteClient a partir de uma chave de assinatura.

Exemplo

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
default(TokenCredential, string, ClientOptions)

Cria uma instância de MapsRoute a partir de um TokenCredentialde Identidade do Azure.

Exemplo

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Cria uma instância de MapsRoute a partir de um AzureSASCredentialde Identidade do Azure.

Exemplo

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de longa duração.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

Transforme uma matriz de [Latitude, Longtitute] em uma cadeia de caracteres no seguinte formato: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Detalhes de Função

buildMultiCollection(string[], string) 

function buildMultiCollection(items: string[], parameterName: string): string

Parâmetros

items

string[]

parameterName

string

Devoluções

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Crie um corpo de solicitação em lote de um monte de solicitações de direção de rota.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Parâmetros

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Um objeto dos parâmetros de consulta para uma solicitação de direção de rota

Devoluções

BatchRequest

O pedido de lote composto.

default(AzureKeyCredential, ClientOptions)

Cria uma instância de MapsRouteClient a partir de uma chave de assinatura.

Exemplo

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient

Parâmetros

credential
AzureKeyCredential

Uma instância AzureKeyCredential usada para autenticar solicitações para o serviço

options
ClientOptions

Opções usadas para configurar o Cliente de Rota

Devoluções

MapsRouteClient

default(TokenCredential, string, ClientOptions)

Cria uma instância de MapsRoute a partir de um TokenCredentialde Identidade do Azure.

Exemplo

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient

Parâmetros

credential
TokenCredential

Uma instância TokenCredential usada para autenticar solicitações para o serviço

mapsAccountClientId

string

A ID do cliente do Azure Maps de um recurso de mapa específico

options
ClientOptions

Opções usadas para configurar o Cliente de Rota

Devoluções

MapsRouteClient

default(AzureSASCredential, ClientOptions)

Cria uma instância de MapsRoute a partir de um AzureSASCredentialde Identidade do Azure.

Exemplo

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);

function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient

Parâmetros

credential
AzureSASCredential

Uma instância AzureSASCredential usada para autenticar solicitações para o serviço

options
ClientOptions

Opções usadas para configurar o Cliente de Rota

Devoluções

MapsRouteClient

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de longa duração.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parâmetros

client
Client

Cliente a utilizar para enviar o pedido para obter páginas adicionais.

initialResponse

TResult

A resposta inicial.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Opções para definir um estado de retomada ou intervalo de sondagem personalizado.

Devoluções

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • Um poller se opõe a pesquisar atualizações de estado da operação e, eventualmente, obter a resposta final.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response

Parâmetros

response

RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse

Devoluções

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parâmetros

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

Devoluções

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parâmetros

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Devoluções

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parâmetros

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

Devoluções

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response

Parâmetros

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

Devoluções

response

toColonDelimitedLatLonString(LatLon[])

Transforme uma matriz de [Latitude, Longtitute] em uma cadeia de caracteres no seguinte formato: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Parâmetros

coordinates

LatLon[]

Uma matriz de par Latitude/Longtitute para transformar.

Devoluções

string

A cadeia de caracteres transformada.