Compartilhar via

@azure-rest/maps-route package

  • Referência

Interfaces

BatchRequest

Esse tipo representa o corpo da solicitação para o serviço do Lote.
BatchRequestItem

Objeto de solicitação em lote
BatchResultItemOutput

Um item retornado da API do Lote. Estender com a propriedade 'response'.
BatchResultOutput

Esse objeto é retornado de uma chamada de serviço do Lote bem-sucedida. Estender com a propriedade 'batchItems'.
BatchResultSummaryOutput

Resumo dos resultados da solicitação em lote
EffectiveSettingOutput

Parâmetro efetivo ou dados 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 retornarem 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 de GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonLineStringData
GeoJsonMultiLineString

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

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

Dados contidos em um GeoJson MultiPoint.
GeoJsonMultiPolygon

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

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

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

Dados contidos em um GeoJson Point.
GeoJsonPolygon

Um tipo de geometria de 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

Post body parameters for Route directions.
RouteDirectionsBatchItemOutput

Um item retornado da chamada de serviço Do Lote de Direções de Rota.
RouteDirectionsBatchItemResponseOutput

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

Esse objeto é retornado de uma chamada de serviço do Lote de Direções de Rota bem-sucedida.
RouteDirectionsOutput

Esse objeto é retornado de uma chamada bem-sucedida do Route Directions
RouteGetRouteDirections200Response

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

As informações retornadas 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 ponto de passagem otimizada ou ativação por turno, 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. Para obter mais informações, consulte do Modelo de Consumo.
RouteGetRouteDirectionsBatch200Response

A API de é uma solicitação HTTP que envia lotes de consultas para a API Obter Instruçõ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 lote até 700 consultas e sincronize a API até 100 consultas.

Baixar resultados do lote assíncrono

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

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

Esta é a sequência típica de operações para baixar os resultados do lote:

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

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted - A solicitação do Lote foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

    HTTP 200 OK – Solicitação em lote processada com êxito. 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 em lote assíncrona, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item em batchItems contém campos statusCode e response. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de Resposta em Lote com 1 bem-sucedido e 1 resultado com falha:

{
    "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 de é uma solicitação HTTP que envia lotes de consultas para a API Obter Instruçõ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 lote até 700 consultas e sincronize a API até 100 consultas.

Baixar resultados do lote assíncrono

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

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

Esta é a sequência típica de operações para baixar os resultados do lote:

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

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted - A solicitação do Lote foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

    HTTP 200 OK – Solicitação em lote processada com êxito. 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 em lote assíncrona, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item em batchItems contém campos statusCode e response. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de Resposta em Lote com 1 bem-sucedido e 1 resultado com falha:

{
    "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 HTTP GET que retorna uma rota entre uma origem e um destino, passando por pontos de passagem, se especificado. A rota leva em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia solicitado da semana e hora do dia.

As informações retornadas 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 ponto de passagem otimizada ou ativação por turno, 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. Para obter mais informações, consulte do Modelo de Consumo.
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

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

As informações retornadas 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 ponto de passagem otimizada ou ativação por turno, 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. Verifique do 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 HTTP POST que retorna uma rota entre uma origem e um destino, passando pelos pontos de passagem se forem especificados. A rota levará em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia solicitado da semana e hora do dia.

As informações retornadas 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 ponto de passagem otimizada ou ativação por turno, 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. Verifique do 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 HTTP GET 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 Obter Instruções de Rota, que fornecem instruções detalhadas de rota, essa API se concentra na eficiência, dando a você 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 rota do Azure Mapas.

Para cada origem determinada, o serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como 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. Por exemplo, digamos que uma empresa de entrega de alimentos tenha 20 motoristas e eles precisam encontrar o motorista mais próximo para pegar a entrega do restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e as distâncias são retornados. Você pode usar os custos computados 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 a solicitação de sincronização, é 100 (o número de origens multiplicado pelo número de destinos).

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

Se o 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 essa API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões de matriz 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 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 de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação for definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

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

As respostas assíncronas são armazenadas por 24 horas. A URL de redirecionamento retorna uma resposta 404 se usada 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 Rotas para o Azure Mapas

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted – A solicitação de Matriz de Rota foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação de Matriz de Rotas. Pode ser uma solicitação 400 incorreta ou qualquer outro código de status de erro.

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

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

Baixar resultados da sincronização

Quando você faz uma solicitação GET para a API de Sincronização de Matriz de Rota, o serviço retorna 200 códigos de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente.

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 solicitação assíncrona no cabeçalho de localização da resposta. Esse URI de status é semelhante ao seguinte:

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

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

HTTP 202 Accepted - A solicitação matrix foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

HTTP 200 OK – Solicitação de matriz processada com êxito. O corpo da resposta contém todos os resultados.
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

A API Get Route Matrix é uma solicitação HTTP GET 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 Obter Instruções de Rota, que fornecem instruções detalhadas de rota, essa API se concentra na eficiência, dando a você 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 rota do Azure Mapas.

Para cada origem determinada, o serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como 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. Por exemplo, digamos que uma empresa de entrega de alimentos tenha 20 motoristas e eles precisam encontrar o motorista mais próximo para pegar a entrega do restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e as distâncias são retornados. Você pode usar os custos computados 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 a solicitação de sincronização, é 100 (o número de origens multiplicado pelo número de destinos).

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

Se o 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 essa API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões de matriz 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 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 de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação for definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

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

As respostas assíncronas são armazenadas por 24 horas. A URL de redirecionamento retorna uma resposta 404 se usada 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 Rotas para o Azure Mapas

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted – A solicitação de Matriz de Rota foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação de Matriz de Rotas. Pode ser uma solicitação 400 incorreta ou qualquer outro código de status de erro.

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

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

Baixar resultados da sincronização

Quando você faz uma solicitação GET para a API de Sincronização de Matriz de Rota, o serviço retorna 200 códigos de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente.

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 solicitação assíncrona no cabeçalho de localização da resposta. Esse URI de status é semelhante ao seguinte:

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

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

HTTP 202 Accepted - A solicitação matrix foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

HTTP 200 OK – Solicitação de matriz processada com êxito. O corpo da resposta contém todos os resultados.
RouteGetRouteRange200Response

A API Get Route Range (Isochrone) é uma solicitação http GET que calculará um conjunto de locais que podem ser atingidos 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 no sentido anti-horário, bem como no centro de polígono preciso que foi o resultado do ponto de origem.

O polígono retornado pode ser usado para processamento adicional, como pesquisar dentro da geometria para pesquisar pois dentro do isócrono fornecido.
RouteGetRouteRangeDefaultResponse

A API Get Route Range (Isochrone) é uma solicitação http GET que calculará um conjunto de locais que podem ser atingidos 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 no sentido anti-horário, bem como no centro de polígono preciso que foi o resultado do ponto de origem.

O polígono retornado pode ser usado para processamento adicional, como pesquisar dentro da geometria para pesquisar pois dentro do isócrono fornecido.
RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

Contém elementos relacionados à orientação. Esse campo só está presente quando as diretrizes foram solicitadas e estão disponíveis.
RouteInstructionGroupOutput

Agrupa uma sequência de elementos de instrução relacionados uns aos outros. 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 grupo de instruções tem uma mensagem de resumo retornada quando disponível.
RouteInstructionOutput

Um conjunto de atributos que descrevem uma manobra, por exemplo, "Virar à direita", "Manter a esquerda", "Pegar a balsa", "Pegar a auto-estrada", "Chegar".
RouteLegOutput

Uma descrição de uma parte de uma rota, composta por uma lista de pontos. Cada ponto de passagem adicional fornecido na solicitação resultará em uma etapa adicional na rota retornada.
RouteMatrixOutput

Objeto de resultado da matriz
RouteMatrixQuery

Um objeto com uma matriz de coordenadas.
RouteMatrixResultOutput

Esse objeto é retornado de uma chamada bem-sucedida da Matriz de Rotas. Por exemplo, se 2 origens e 3 destinos forem fornecidos, 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 resumo
RouteOptimizedWaypointOutput

Objeto de ponto de passagem otimizado.
RouteOutput
RouteRangeOutput

Intervalo acessível
RouteRangeResultOutput

Esse 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 Post Route Directions Batch é uma solicitação HTTP POST que envia lotes de consultas para a API Obter Instruçõ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 lote até 700 consultas e sincronize a API até 100 consultas. Para chamar a API de Post Route Directions Batch em uma solicitação síncrona, consulte de Sincronização de Lotes de Direções pós-rota.

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 é esperada para ser executada em um tempo limite.
  • O número de itens em lote é limitado a 700 para essa API.

Quando você faz uma solicitação usando 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 de resposta. Essa URL deve ser verificada 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. A URL de redirecionamento retorna uma resposta 404 se usada após o período de expiração.

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

  1. O cliente envia uma solicitação de POST do Lote de Rotas para o Azure Mapas.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted - A solicitação do Lote foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação do Lote. Isso 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 é semelhante ao seguinte:

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 na URL de download obtida na Etapa 3 para baixar os resultados do lote.

Corpo POST para solicitação em lote

Para enviar as rotas consultas, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz de batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo contendo 3 rotas 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 rotas consulta em um lote é apenas um 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 um dos rotas com suporteparâmetros de URI. Os valores de cadeia de caracteres no rotas consulta devem ser escapados corretamente (por exemplo, " o caractere deve ser escapado com \ ) e também deve ser codificado corretamente em URL.

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

Baixar resultados do lote assíncrono

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

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

Esta é a sequência típica de operações para baixar os resultados do lote:

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

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted - A solicitação do Lote foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

    HTTP 200 OK – Solicitação em lote processada com êxito. 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 em lote assíncrona, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item em batchItems contém campos statusCode e response. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de Resposta em Lote com 1 bem-sucedido e 1 resultado com falha:

{
    "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 Post Route Directions Batch é uma solicitação HTTP POST que envia lotes de consultas para a API Obter Instruçõ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 lote até 700 consultas e sincronize a API até 100 consultas. Para chamar a API de Post Route Directions Batch em uma solicitação síncrona, consulte de Sincronização de Lotes de Direções pós-rota.

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 é esperada para ser executada em um tempo limite.
  • O número de itens em lote é limitado a 700 para essa API.

Quando você faz uma solicitação usando 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 de resposta. Essa URL deve ser verificada 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. A URL de redirecionamento retorna uma resposta 404 se usada após o período de expiração.

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

  1. O cliente envia uma solicitação de POST do Lote de Rotas para o Azure Mapas.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted - A solicitação do Lote foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação do Lote. Isso 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 é semelhante ao seguinte:

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 na URL de download obtida na Etapa 3 para baixar os resultados do lote.

Corpo POST para solicitação em lote

Para enviar as rotas consultas, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz de batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo contendo 3 rotas 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 rotas consulta em um lote é apenas um 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 um dos rotas com suporteparâmetros de URI. Os valores de cadeia de caracteres no rotas consulta devem ser escapados corretamente (por exemplo, " o caractere deve ser escapado com \ ) e também deve ser codificado corretamente em URL.

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

Baixar resultados do lote assíncrono

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

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

Esta é a sequência típica de operações para baixar os resultados do lote:

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

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted - A solicitação do Lote foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

    HTTP 200 OK – Solicitação em lote processada com êxito. 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 em lote assíncrona, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item em batchItems contém campos statusCode e response. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de Resposta em Lote com 1 bem-sucedido e 1 resultado com falha:

{
    "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 de é uma solicitação HTTP que envia lotes de consultas para a API Obter Instruçõ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 lote 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 Post Route Directions Batch.

Enviar solicitação de lote síncrona

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

POST https://atlas.microsoft.com/route/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 em lote assíncrona, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item em batchItems contém campos statusCode e response. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de Resposta em Lote com 1 bem-sucedido e 1 resultado com falha:

{
    "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 de é uma solicitação HTTP que envia lotes de consultas para a API Obter Instruçõ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 lote 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 Post Route Directions Batch.

Enviar solicitação de lote síncrona

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

POST https://atlas.microsoft.com/route/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 em lote assíncrona, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item em batchItems contém campos statusCode e response. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de Resposta em Lote com 1 bem-sucedido e 1 resultado com falha:

{
    "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 de é uma solicitação HTTP que envia lotes de consultas para a API Obter Instruçõ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 lote 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 Post Route Directions Batch.

Enviar solicitação de lote síncrona

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

POST https://atlas.microsoft.com/route/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 em lote assíncrona, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item em batchItems contém campos statusCode e response. Cada response em batchItems é de um dos seguintes tipos:

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

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

Aqui está um exemplo de Resposta em Lote com 1 bem-sucedido e 1 resultado com falha:

{
    "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 HTTP POST que permite o cálculo de uma matriz de resumos de rotas 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 de Sincronização de Matriz pós-rota. Para cada origem determinada, o serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como 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. Por exemplo, digamos que uma empresa de entrega de alimentos tenha 20 motoristas e eles precisam encontrar o motorista mais próximo para pegar a entrega do restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e as distâncias são retornados. Você pode usar os custos computados 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 a solicitação de sincronização, é 100 (o número de origens multiplicado pelo número de destinos).

Observação

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

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

Se o 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 essa API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões de matriz 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 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 de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação for definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

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

As respostas assíncronas são armazenadas por 24 horas. A URL de redirecionamento retorna uma resposta 404 se usada 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 de Matriz de Rotas para o Azure Mapas

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted – A solicitação de Matriz de Rota foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação de Matriz de Rotas. Pode ser uma solicitação 400 incorreta ou qualquer outro código de status de erro.

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

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

Baixar resultados da sincronização

Quando você faz uma solicitação POST para a API de Sincronização de Matriz de Rota, o serviço retorna 200 códigos de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente.

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 solicitação assíncrona no cabeçalho de localização da resposta. Esse URI de status é semelhante ao seguinte:

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

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

HTTP 202 Accepted - A solicitação matrix foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

HTTP 200 OK – Solicitação de matriz processada com êxito. O corpo da resposta contém todos os resultados.
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

A API Post Route Matrix é uma solicitação HTTP POST que permite o cálculo de uma matriz de resumos de rotas 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 de Sincronização de Matriz pós-rota. Para cada origem determinada, o serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como 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. Por exemplo, digamos que uma empresa de entrega de alimentos tenha 20 motoristas e eles precisam encontrar o motorista mais próximo para pegar a entrega do restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e as distâncias são retornados. Você pode usar os custos computados 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 a solicitação de sincronização, é 100 (o número de origens multiplicado pelo número de destinos).

Observação

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

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

Se o 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 essa API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões de matriz 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 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 de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação for definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

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

As respostas assíncronas são armazenadas por 24 horas. A URL de redirecionamento retorna uma resposta 404 se usada 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 de Matriz de Rotas para o Azure Mapas

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted – A solicitação de Matriz de Rota foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação de Matriz de Rotas. Pode ser uma solicitação 400 incorreta ou qualquer outro código de status de erro.

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

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

Baixar resultados da sincronização

Quando você faz uma solicitação POST para a API de Sincronização de Matriz de Rota, o serviço retorna 200 códigos de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente.

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 solicitação assíncrona no cabeçalho de localização da resposta. Esse URI de status é semelhante ao seguinte:

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

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

HTTP 202 Accepted - A solicitação matrix foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

HTTP 200 OK – Solicitação de matriz processada com êxito. 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 rotas 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 de Matriz pós-rota. Para cada origem determinada, o serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como 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. Por exemplo, digamos que uma empresa de entrega de alimentos tenha 20 motoristas e eles precisam encontrar o motorista mais próximo para pegar a entrega do restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e as distâncias são retornados. Você pode usar os custos computados 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 a solicitação de sincronização, é 100 (o número de origens multiplicado pelo número de destinos).

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

Se o 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 essa API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões de matriz 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 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 de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação for definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

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

As respostas assíncronas são armazenadas por 24 horas. A URL de redirecionamento retorna uma resposta 404 se usada 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 de Matriz de Rotas para o Azure Mapas

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted – A solicitação de Matriz de Rota foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação de Matriz de Rotas. Pode ser uma solicitação 400 incorreta ou qualquer outro código de status de erro.

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

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

Baixar resultados da sincronização

Quando você faz uma solicitação POST para a API de Sincronização de Matriz de Rota, o serviço retorna 200 códigos de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente.

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 solicitação assíncrona no cabeçalho de localização da resposta. Esse URI de status é semelhante ao seguinte:

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

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

HTTP 202 Accepted - A solicitação matrix foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

HTTP 200 OK – Solicitação de matriz processada com êxito. 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 rotas 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 de Matriz pós-rota. Para cada origem determinada, o serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como 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. Por exemplo, digamos que uma empresa de entrega de alimentos tenha 20 motoristas e eles precisam encontrar o motorista mais próximo para pegar a entrega do restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e as distâncias são retornados. Você pode usar os custos computados 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 a solicitação de sincronização, é 100 (o número de origens multiplicado pelo número de destinos).

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

Se o 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 essa API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões de matriz 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 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 de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação for definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

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

As respostas assíncronas são armazenadas por 24 horas. A URL de redirecionamento retorna uma resposta 404 se usada 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 de Matriz de Rotas para o Azure Mapas

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted – A solicitação de Matriz de Rota foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação de Matriz de Rotas. Pode ser uma solicitação 400 incorreta ou qualquer outro código de status de erro.

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

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

Baixar resultados da sincronização

Quando você faz uma solicitação POST para a API de Sincronização de Matriz de Rota, o serviço retorna 200 códigos de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente.

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 solicitação assíncrona no cabeçalho de localização da resposta. Esse URI de status é semelhante ao seguinte:

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

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

HTTP 202 Accepted - A solicitação matrix foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

HTTP 200 OK – Solicitação de matriz processada com êxito. 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 rotas 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 de Matriz pós-rota. Para cada origem determinada, o serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como 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. Por exemplo, digamos que uma empresa de entrega de alimentos tenha 20 motoristas e eles precisam encontrar o motorista mais próximo para pegar a entrega do restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e as distâncias são retornados. Você pode usar os custos computados 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 a solicitação de sincronização, é 100 (o número de origens multiplicado pelo número de destinos).

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

Se o 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 essa API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões de matriz 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 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 de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação for definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

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

As respostas assíncronas são armazenadas por 24 horas. A URL de redirecionamento retorna uma resposta 404 se usada 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 de Matriz de Rotas para o Azure Mapas

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted – A solicitação de Matriz de Rota foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação de Matriz de Rotas. Pode ser uma solicitação 400 incorreta ou qualquer outro código de status de erro.

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

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

Baixar resultados da sincronização

Quando você faz uma solicitação POST para a API de Sincronização de Matriz de Rota, o serviço retorna 200 códigos de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente.

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 solicitação assíncrona no cabeçalho de localização da resposta. Esse URI de status é semelhante ao seguinte:

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

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

HTTP 202 Accepted - A solicitação matrix foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

HTTP 200 OK – Solicitação de matriz processada com êxito. 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áfego. Pode conter elementos mainCauseCode e subCauseCode. Pode ser usado para definir a iconografia e as descrições.
RouteSectionTecOutput

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

Objeto resumo
Routes
SimplePollerLike

Um sondador simples que pode ser usado para sondar uma operação de longa execuçã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 de 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 do 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 do MapsRoute 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 do MapsRoute 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 execução longa.
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 da função

buildMultiCollection(string[], string) 

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

Parâmetros

items

string[]

parameterName

string

Retornos

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

Retornos

BatchRequest

A solicitação em lote composta.

default(AzureKeyCredential, ClientOptions)

Cria uma instância do 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 do AzureKeyCredential usada para autenticar solicitações para o serviço

options
ClientOptions

Opções usadas para configurar o Cliente de Rota

Retornos

MapsRouteClient

default(TokenCredential, string, ClientOptions)

Cria uma instância do MapsRoute 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 Mapas de um recurso de mapa específico

options
ClientOptions

Opções usadas para configurar o Cliente de Rota

Retornos

MapsRouteClient

default(AzureSASCredential, ClientOptions)

Cria uma instância do MapsRoute 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 do AzureSASCredential usada para autenticar solicitações no serviço

options
ClientOptions

Opções usadas para configurar o Cliente de Rota

Retornos

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 execução longa.

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

Parâmetros

client
Client

Cliente a ser usado para enviar a solicitação para obter páginas adicionais.

initialResponse

TResult

A resposta inicial.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

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

Retornos

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

  • Um objeto poller para sondar atualizações de estado de 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

Retornos

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parâmetros

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

Retornos

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parâmetros

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Retornos

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parâmetros

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

Retornos

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

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

Parâmetros

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

Retornos

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 a ser transformado.

Retornos

string

A cadeia de caracteres transformada.