Поделиться через


RequestRouteDirectionsBatchSync interface

Методы

post(RouteRequestRouteDirectionsBatchSyncParameters)

API Post Route Directions Batch Sync — это HTTP-запрос POST, который отправляет пакеты запросов в API get Route Directions с помощью одного синхронного запроса. Вы можете вызывать API Route Directions Batch для асинхронного (асинхронного) или синхронного (синхронного). Асинхронный API позволяет вызывающей службе пакетировать до 700 запросов и синхронизации API до 100 запросов. Чтобы вызвать API Post Route Directions Batch в асинхронном запросе, ознакомьтесь с пакетноймаршрутов после маршрутизации.

Отправка синхронного пакетного запроса

Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API.

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

Модель пакетного ответа

Возвращаемое содержимое данных аналогично асинхронным и синхронным запросам. При скачивании результатов асинхронного пакетного запроса, если пакет завершил обработку, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит компонент summary, указывающий totalRequests, которые были частью исходного пакетного запроса и successfulRequestsто есть запросы, которые были выполнены успешно. Пакетный ответ также содержит массив batchItems, содержащий ответ для каждого запроса и каждого запроса в пакетном запросе. batchItems будет содержать результаты в том же порядке, что и исходные запросы, отправленные в пакетном запросе. Каждый элемент в batchItems содержит поля statusCode и response. Каждый response в batchItems имеет один из следующих типов:

  • RouteDirections. Если запрос выполнен успешно.

  • Error — если запрос завершился ошибкой. Ответ будет содержать code и message в этом случае.

Ниже приведен пример пакетного ответа с 1 успешный и 1 сбой результата:

{
    "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."
                }
            }
        }
    ]
}

Сведения о методе

post(RouteRequestRouteDirectionsBatchSyncParameters)

API Post Route Directions Batch Sync — это HTTP-запрос POST, который отправляет пакеты запросов в API get Route Directions с помощью одного синхронного запроса. Вы можете вызывать API Route Directions Batch для асинхронного (асинхронного) или синхронного (синхронного). Асинхронный API позволяет вызывающей службе пакетировать до 700 запросов и синхронизации API до 100 запросов. Чтобы вызвать API Post Route Directions Batch в асинхронном запросе, ознакомьтесь с пакетноймаршрутов после маршрутизации.

Отправка синхронного пакетного запроса

Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API.

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

Модель пакетного ответа

Возвращаемое содержимое данных аналогично асинхронным и синхронным запросам. При скачивании результатов асинхронного пакетного запроса, если пакет завершил обработку, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит компонент summary, указывающий totalRequests, которые были частью исходного пакетного запроса и successfulRequestsто есть запросы, которые были выполнены успешно. Пакетный ответ также содержит массив batchItems, содержащий ответ для каждого запроса и каждого запроса в пакетном запросе. batchItems будет содержать результаты в том же порядке, что и исходные запросы, отправленные в пакетном запросе. Каждый элемент в batchItems содержит поля statusCode и response. Каждый response в batchItems имеет один из следующих типов:

  • RouteDirections. Если запрос выполнен успешно.

  • Error — если запрос завершился ошибкой. Ответ будет содержать code и message в этом случае.

Ниже приведен пример пакетного ответа с 1 успешный и 1 сбой результата:

{
    "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."
                }
            }
        }
    ]
}
function post(options: RouteRequestRouteDirectionsBatchSyncParameters): StreamableMethod<RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse>

Параметры

Возвращаемое значение