@azure-rest/maps-route package
Interfaces
| BatchRequest |
Este tipo representa el cuerpo de la solicitud para el servicio Batch. |
| BatchRequestItem |
Objeto de solicitud de Batch |
| BatchResultItemOutput |
Un elemento devuelto por Batch API. Extienda con la propiedad 'response'. |
| BatchResultOutput |
Este objeto se devuelve de una llamada de servicio de Batch correcta. Extienda con la propiedad "batchItems". |
| BatchResultSummaryOutput |
Resumen de los resultados de la solicitud por lotes |
| EffectiveSettingOutput |
Parámetro o datos efectivos que se usan al llamar a esta ROUTE API. |
| ErrorDetailOutput |
Detalle del error. |
| ErrorResponseOutput |
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData). |
| GeoJsonFeature |
Tipo de objeto |
| GeoJsonFeatureCollection |
Tipo de objeto |
| GeoJsonFeatureCollectionData | |
| GeoJsonFeatureData | |
| GeoJsonGeometryCollection |
Tipo de objeto |
| GeoJsonGeometryCollectionData | |
| GeoJsonGeometryParent |
Un objeto geometry válido |
| GeoJsonLineString |
Un tipo de geometría |
| GeoJsonLineStringData | |
| GeoJsonMultiLineString |
Un tipo de geometría |
| GeoJsonMultiLineStringData | |
| GeoJsonMultiPoint |
Un tipo de geometría |
| GeoJsonMultiPointData |
Datos contenidos en un |
| GeoJsonMultiPolygon |
Tipo de objeto |
| GeoJsonMultiPolygonData | |
| GeoJsonObjectParent |
Objeto |
| GeoJsonPoint |
Un tipo de geometría |
| GeoJsonPointData |
Datos contenidos en un |
| GeoJsonPolygon |
Un tipo de geometría |
| GeoJsonPolygonData | |
| GetRouteDirections | |
| GetRouteRange | |
| LatLongPairOutput |
Ubicación representada como latitud y longitud. |
| MapsRouteClientOptions |
Parámetros opcionales para el cliente |
| RequestRouteDirectionsBatch | |
| RequestRouteDirectionsBatchSync | |
| RequestRouteMatrix | |
| RequestRouteMatrixSync | |
| RouteDirectionParameters |
Publique los parámetros del cuerpo para las direcciones de ruta. |
| RouteDirectionsBatchItemOutput |
Un elemento devuelto desde la llamada al servicio Route Directions Batch. |
| RouteDirectionsBatchItemResponseOutput |
Resultado de la consulta. RouteDirections si la consulta se completó correctamente, ErrorResponse de lo contrario. |
| RouteDirectionsBatchResultOutput |
Este objeto se devuelve de una llamada de servicio de Route Directions Batch correcta. |
| RouteDirectionsOutput |
Este objeto se devuelve de una llamada a Route Directions correcta. |
| RouteGetRouteDirections200Response |
La API de La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas. El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada de un modelo de consumo específico del vehículo. Para obtener más información, vea Modelo de consumo. |
| RouteGetRouteDirectionsBatch200Response |
La API de Descargar resultados de lotes asincrónicosPara descargar los resultados del lote asincrónico, emitirá una solicitud de Esta es la secuencia típica de operaciones para descargar los resultados del lote:
Modelo de respuesta por lotesEl contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de
Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado: |
| RouteGetRouteDirectionsBatch202Headers | |
| RouteGetRouteDirectionsBatch202Response |
La API de Descargar resultados de lotes asincrónicosPara descargar los resultados del lote asincrónico, emitirá una solicitud de Esta es la secuencia típica de operaciones para descargar los resultados del lote:
Modelo de respuesta por lotesEl contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de
Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado: |
| RouteGetRouteDirectionsDefaultResponse |
La API de La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas. El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada de un modelo de consumo específico del vehículo. Para obtener más información, vea Modelo de consumo. |
| RouteGetRouteDirectionsQueryParam | |
| RouteGetRouteDirectionsQueryParamProperties | |
| RouteGetRouteDirectionsWithAdditionalParameters200Response |
La API de La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas. El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada de un modelo de consumo específico del vehículo. Consulte modelo de consumo para obtener una explicación detallada de los conceptos y parámetros implicados. |
| RouteGetRouteDirectionsWithAdditionalParametersBodyParam | |
| RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse |
La API de La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas. El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada de un modelo de consumo específico del vehículo. Consulte modelo de consumo para obtener una explicación detallada de los conceptos y parámetros implicados. |
| RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam | |
| RouteGetRouteDirectionsWithAdditionalParametersQueryParam | |
| RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties | |
| RouteGetRouteMatrix200Response |
La API de Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API. Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API. El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos). Enviar solicitud de matriz de ruta sincrónicaSi el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado). Enviar solicitud de matriz de ruta asincrónicaLa API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado). Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. Esta es una secuencia típica de operaciones asincrónicas:
Descargar resultados de sincronizaciónCuando se realiza una solicitud GET para Route Matrix Sync API, el servicio devuelve 200 código de respuesta para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante. Descargar resultados asincrónicosCuando una solicitud emite una respuesta La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de
|
| RouteGetRouteMatrix202Headers | |
| RouteGetRouteMatrix202Response |
La API de Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API. Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API. El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos). Enviar solicitud de matriz de ruta sincrónicaSi el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado). Enviar solicitud de matriz de ruta asincrónicaLa API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado). Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. Esta es una secuencia típica de operaciones asincrónicas:
Descargar resultados de sincronizaciónCuando se realiza una solicitud GET para Route Matrix Sync API, el servicio devuelve 200 código de respuesta para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante. Descargar resultados asincrónicosCuando una solicitud emite una respuesta La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de
|
| RouteGetRouteRange200Response |
La API de El polígono devuelto se puede usar para su posterior procesamiento, como Buscar dentro de geometry para buscar pois dentro de la isocrona proporcionada. |
| RouteGetRouteRangeDefaultResponse |
La API de El polígono devuelto se puede usar para su posterior procesamiento, como Buscar dentro de geometry para buscar pois dentro de la isocrona proporcionada. |
| RouteGetRouteRangeQueryParam | |
| RouteGetRouteRangeQueryParamProperties | |
| RouteGuidanceOutput |
Contiene elementos relacionados con instrucciones. Este campo solo está presente cuando se solicitó la guía y está disponible. |
| RouteInstructionGroupOutput |
Agrupa una secuencia de elementos de instrucción que se relacionan entre sí. El intervalo de secuencia está restringido con firstInstructionIndex y lastInstructionIndex. Cuando se solicitan mensajes de texto legibles para instrucciones (instructionType=text o etiquetados), el elemento instructionGroup tiene un mensaje de resumen devuelto cuando está disponible. |
| RouteInstructionOutput |
Un conjunto de atributos que describen una maniobra, por ejemplo, "Girar a la derecha", "Mantener la izquierda", "Tomar el ferry", "Tomar la autopista", "Llegar". |
| RouteLegOutput |
Descripción de una parte de una ruta, formada por una lista de puntos. Cada punto de acceso adicional proporcionado en la solicitud dará como resultado una etapa adicional en la ruta devuelta. |
| RouteMatrixOutput |
Objeto de resultado de matriz |
| RouteMatrixQuery |
Objeto con una matriz de coordenadas. |
| RouteMatrixResultOutput |
Este objeto se devuelve de una llamada a Route Matrix correcta. Por ejemplo, si se proporcionan 2 orígenes y 3 destinos, habrá 2 matrices con 3 elementos en cada uno. El contenido de cada elemento depende de las opciones proporcionadas en la consulta. |
| RouteMatrixResultResponseOutput |
Objeto response de la celda actual de la matriz de entrada. |
| RouteMatrixSummaryOutput |
Summary (objeto) |
| RouteOptimizedWaypointOutput |
Objeto de punto de forma optimizado. |
| RouteOutput | |
| RouteRangeOutput |
Rango accesible |
| RouteRangeResultOutput |
Este objeto se devuelve de una llamada a Route Reachable Range correcta. |
| RouteReportOutput |
Informa de la configuración efectiva que se usa en la llamada actual. |
| RouteRequestRouteDirectionsBatch200Response |
La API de Enviar solicitud por lotes asincrónicaLa API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de ruta relativamente complejas.
Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. Tenga en cuenta que la solicitud por lotes asincrónica es una operación de larga duración. Esta es una secuencia típica de operaciones:
Cuerpo POST para solicitud por lotesPara enviar las direcciones de ruta consultas, usará una solicitud de Una direcciones de ruta consulta en un lote es simplemente una dirección URL parcial sin el protocolo, la dirección URL base, la ruta de acceso, la versión de api y la clave de suscripción. Puede aceptar cualquiera de las direcciones de ruta de admitidasparámetros de URI. Los valores de cadena de la direcciones de ruta consulta deben tener un escape correcto (por ejemplo, " el carácter debe ser de escape con \ ) y también debe estar correctamente codificado con dirección URL. La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API hasta 100 consultas de y el lote debe contener al menos 1 consulta de. Descargar resultados de lotes asincrónicosPara descargar los resultados del lote asincrónico, emitirá una solicitud de Esta es la secuencia típica de operaciones para descargar los resultados del lote:
Modelo de respuesta por lotesEl contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de
Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado: |
| RouteRequestRouteDirectionsBatch202Headers | |
| RouteRequestRouteDirectionsBatch202Response |
La API de Enviar solicitud por lotes asincrónicaLa API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de ruta relativamente complejas.
Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. Tenga en cuenta que la solicitud por lotes asincrónica es una operación de larga duración. Esta es una secuencia típica de operaciones:
Cuerpo POST para solicitud por lotesPara enviar las direcciones de ruta consultas, usará una solicitud de Una direcciones de ruta consulta en un lote es simplemente una dirección URL parcial sin el protocolo, la dirección URL base, la ruta de acceso, la versión de api y la clave de suscripción. Puede aceptar cualquiera de las direcciones de ruta de admitidasparámetros de URI. Los valores de cadena de la direcciones de ruta consulta deben tener un escape correcto (por ejemplo, " el carácter debe ser de escape con \ ) y también debe estar correctamente codificado con dirección URL. La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API hasta 100 consultas de y el lote debe contener al menos 1 consulta de. Descargar resultados de lotes asincrónicosPara descargar los resultados del lote asincrónico, emitirá una solicitud de Esta es la secuencia típica de operaciones para descargar los resultados del lote:
Modelo de respuesta por lotesEl contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de
Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado: |
| RouteRequestRouteDirectionsBatchBodyParam | |
| RouteRequestRouteDirectionsBatchMediaTypesParam | |
| RouteRequestRouteDirectionsBatchSync200Response |
La API de Enviar solicitud por lotes sincrónicaSe recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API. Modelo de respuesta por lotesEl contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de
Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado: |
| RouteRequestRouteDirectionsBatchSync408Response |
La API de Enviar solicitud por lotes sincrónicaSe recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API. Modelo de respuesta por lotesEl contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de
Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado: |
| RouteRequestRouteDirectionsBatchSyncBodyParam | |
| RouteRequestRouteDirectionsBatchSyncDefaultResponse |
La API de Enviar solicitud por lotes sincrónicaSe recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API. Modelo de respuesta por lotesEl contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de
Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado: |
| RouteRequestRouteDirectionsBatchSyncMediaTypesParam | |
| RouteRequestRouteMatrix200Response |
La API de Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API. El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos). Nota: Todos los orígenes y destinos deben estar incluidos en un rectángulo alineado con el eje 400 km x 400 km. De lo contrario, algunas celdas de matriz se resolverán como OUT_OF_REGION. Enviar solicitud de matriz de ruta sincrónicaSi el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado). Enviar solicitud de matriz de ruta asincrónicaLa API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado). Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. Esta es una secuencia típica de operaciones asincrónicas:
Descargar resultados de sincronizaciónCuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante. Descargar resultados asincrónicosCuando una solicitud emite una respuesta La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de
|
| RouteRequestRouteMatrix202Headers | |
| RouteRequestRouteMatrix202Response |
La API de Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API. El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos). Nota: Todos los orígenes y destinos deben estar incluidos en un rectángulo alineado con el eje 400 km x 400 km. De lo contrario, algunas celdas de matriz se resolverán como OUT_OF_REGION. Enviar solicitud de matriz de ruta sincrónicaSi el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado). Enviar solicitud de matriz de ruta asincrónicaLa API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado). Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. Esta es una secuencia típica de operaciones asincrónicas:
Descargar resultados de sincronizaciónCuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante. Descargar resultados asincrónicosCuando una solicitud emite una respuesta La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de
|
| RouteRequestRouteMatrixBodyParam | |
| RouteRequestRouteMatrixMediaTypesParam | |
| RouteRequestRouteMatrixQueryParam | |
| RouteRequestRouteMatrixQueryParamProperties | |
| RouteRequestRouteMatrixSync200Response |
La API de Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API. El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos). Enviar solicitud de matriz de ruta sincrónicaSi el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado). Enviar solicitud de matriz de ruta asincrónicaLa API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado). Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. Esta es una secuencia típica de operaciones asincrónicas:
Descargar resultados de sincronizaciónCuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante. Descargar resultados asincrónicosCuando una solicitud emite una respuesta La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de
|
| RouteRequestRouteMatrixSync408Response |
La API de Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API. El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos). Enviar solicitud de matriz de ruta sincrónicaSi el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado). Enviar solicitud de matriz de ruta asincrónicaLa API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado). Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. Esta es una secuencia típica de operaciones asincrónicas:
Descargar resultados de sincronizaciónCuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante. Descargar resultados asincrónicosCuando una solicitud emite una respuesta La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de
|
| RouteRequestRouteMatrixSyncBodyParam | |
| RouteRequestRouteMatrixSyncDefaultResponse |
La API de Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API. El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos). Enviar solicitud de matriz de ruta sincrónicaSi el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado). Enviar solicitud de matriz de ruta asincrónicaLa API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado). Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración. Esta es una secuencia típica de operaciones asincrónicas:
Descargar resultados de sincronizaciónCuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante. Descargar resultados asincrónicosCuando una solicitud emite una respuesta La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de
|
| RouteRequestRouteMatrixSyncMediaTypesParam | |
| RouteRequestRouteMatrixSyncQueryParam | |
| RouteRequestRouteMatrixSyncQueryParamProperties | |
| RouteSectionOutput |
Las secciones de ruta contienen información adicional sobre las partes de una ruta. Cada sección contiene al menos los elementos |
| RouteSectionTecCauseOutput |
Causa del evento de tráfico. Puede contener elementos mainCauseCode y subCauseCode. Se puede usar para definir la iconografía y las descripciones. |
| RouteSectionTecOutput |
Detalles del evento de tráfico, usando definiciones en el estándar TPEG2-TEC de |
| RouteSummaryOutput |
Summary (objeto) |
| Routes | |
| SimplePollerLike |
Un sondeo sencillo que se puede usar para sondear una operación de larga duración. |
Alias de tipos
| GeoJsonGeometry |
Un objeto geometry válido |
| GeoJsonObject |
Objeto |
| MapsRouteClient | |
| RouteGetRouteDirectionsBatchParameters | |
| RouteGetRouteDirectionsParameters | |
| RouteGetRouteDirectionsWithAdditionalParametersParameters | |
| RouteGetRouteMatrixParameters | |
| RouteGetRouteRangeParameters | |
| RouteRequestRouteDirectionsBatchParameters | |
| RouteRequestRouteDirectionsBatchSyncParameters | |
| RouteRequestRouteMatrixParameters | |
| RouteRequestRouteMatrixSyncParameters | |
Funciones
| build |
|
| create |
Cree un cuerpo de solicitud por lotes de un montón de solicitudes de dirección de ruta. |
| default(Azure |
Crea una instancia de MapsRouteClient a partir de una clave de suscripción. Ejemplo |
| default(Token |
Crea una instancia de MapsRoute a partir de una instancia de Azure Identity Ejemplo |
| default(Azure |
Crea una instancia de MapsRoute a partir de una instancia de Azure Identity Ejemplo |
| get |
Función auxiliar que compila un objeto Poller para ayudar a sondear una operación de larga duración. |
| is |
|
| is |
|
| is |
|
| is |
|
| is |
|
| to |
Transforme una matriz de [Latitude, Longtitute] en una cadena con el siguiente formato: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..." |
Detalles de la función
buildMultiCollection(string[], string)
function buildMultiCollection(items: string[], parameterName: string): stringParámetros
- items
-
string[]
- parameterName
-
string
Devoluciones
string
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])
Cree un cuerpo de solicitud por lotes de un montón de solicitudes de dirección de ruta.
function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequestParámetros
- queryParamProperties
Objeto de los parámetros de consulta para una solicitud de dirección de ruta
Devoluciones
Solicitud por lotes compuesta.
default(AzureKeyCredential, ClientOptions)
Crea una instancia de MapsRouteClient a partir de una clave de suscripción.
Ejemplo
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): MapsRouteClientParámetros
- credential
- AzureKeyCredential
Una instancia de AzureKeyCredential que se usa para autenticar solicitudes en el servicio
- options
- ClientOptions
Opciones usadas para configurar el cliente de ruta
Devoluciones
default(TokenCredential, string, ClientOptions)
Crea una instancia de MapsRoute a partir de una instancia de Azure Identity TokenCredential.
Ejemplo
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): MapsRouteClientParámetros
- credential
- TokenCredential
Una instancia de TokenCredential que se usa para autenticar las solicitudes en el servicio
- mapsAccountClientId
-
string
Identificador de cliente de Azure Maps de un recurso de mapa específico
- options
- ClientOptions
Opciones usadas para configurar el cliente de ruta
Devoluciones
default(AzureSASCredential, ClientOptions)
Crea una instancia de MapsRoute a partir de una instancia de Azure Identity AzureSASCredential.
Ejemplo
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): MapsRouteClientParámetros
- credential
- AzureSASCredential
Una instancia de AzureSASCredential que se usa para autenticar solicitudes en el servicio
- options
- ClientOptions
Opciones usadas para configurar el cliente de ruta
Devoluciones
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Función auxiliar que compila un objeto Poller para ayudar a sondear una operación de larga duración.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>Parámetros
- client
- Client
Cliente que se va a usar para enviar la solicitud para obtener páginas adicionales.
- initialResponse
-
TResult
Respuesta inicial.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opciones para establecer un estado de reanudación o un intervalo de sondeo personalizado.
Devoluciones
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Objeto de sondeo para sondear las actualizaciones de estado de la operación y, finalmente, obtener la respuesta final.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): responseParámetros
Devoluciones
response
toColonDelimitedLatLonString(LatLon[])
Transforme una matriz de [Latitude, Longtitute] en una cadena con el siguiente formato: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."
function toColonDelimitedLatLonString(coordinates: LatLon[]): stringParámetros
- coordinates
-
LatLon[]
Matriz de par Latitud/Longtitute que se va a transformar.
Devoluciones
string
Cadena transformada.
Azure SDK for JavaScript