Partilhar via

RouteRequestRouteMatrixSync200Response interface

  • Referência
Pacote:
@azure-rest/maps-route

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Baixar resultados de sincronização

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

Baixar resultados assíncronos

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

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

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

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

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

Extends
HttpResponse

Propriedades

body
status

Propriedades Herdadas

headers

Os cabeçalhos de resposta HTTP.
request

A solicitação que gerou essa resposta.

Detalhes de Propriedade

body 

body: RouteMatrixResultOutput

Valor de Propriedade

RouteMatrixResultOutput

status 

status: "200"

Valor de Propriedade

"200"

Detalhes da Propriedade Herdada

headers

Os cabeçalhos de resposta HTTP.

headers: RawHttpHeaders

Valor de Propriedade

RawHttpHeaders

herdado de HttpResponse.headers

request

A solicitação que gerou essa resposta.

request: PipelineRequest

Valor de Propriedade

PipelineRequest

herdado de HttpResponse.request