مشاركة عبر

@azure-rest/maps-route package

  • ‏‏المرجع

الواجهات

BatchRequest

يمثل هذا النوع نص الطلب لخدمة Batch.
BatchRequestItem

كائن طلب الدفعة
BatchResultItemOutput

عنصر تم إرجاعه من Batch API. توسيع باستخدام خاصية "الاستجابة".
BatchResultOutput

يتم إرجاع هذا الكائن من استدعاء خدمة Batch ناجح. توسيع باستخدام خاصية "batchItems".
BatchResultSummaryOutput

ملخص نتائج طلب الدفعة
EffectiveSettingOutput

المعلمة الفعالة أو البيانات المستخدمة عند استدعاء واجهة برمجة تطبيقات المسار هذه.
ErrorDetailOutput

تفاصيل الخطأ.
ErrorResponseOutput

استجابة الخطأ الشائعة لجميع واجهات برمجة تطبيقات Azure Resource Manager لإرجاع تفاصيل الخطأ للعمليات الفاشلة. (يتبع هذا أيضا تنسيق استجابة خطأ OData.).
GeoJsonFeature

نوع كائن GeoJSON Feature صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonFeatureCollection

نوع كائن GeoJSON FeatureCollection صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

نوع كائن GeoJSON GeometryCollection صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonGeometryCollectionData
GeoJsonGeometryParent

عنصر هندسي GeoJSON صالح. يجب أن يكون النوع أحد أنواع هندسة GeoJSON السبعة الصالحة - Point و MultiPoint و LineString و MultiLineString و Polygon و MultiPolygon و GeometryCollection. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonLineString

نوع هندسي GeoJSON LineString صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonLineStringData
GeoJsonMultiLineString

نوع هندسي GeoJSON MultiLineString صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonMultiLineStringData
GeoJsonMultiPoint

نوع هندسي GeoJSON MultiPoint صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonMultiPointData

البيانات التي يحتوي عليها GeoJson MultiPoint.
GeoJsonMultiPolygon

نوع كائن GeoJSON MultiPolygon صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonMultiPolygonData
GeoJsonObjectParent

كائن GeoJSON صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonPoint

نوع هندسي GeoJSON Point صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonPointData

البيانات التي يحتوي عليها GeoJson Point.
GeoJsonPolygon

نوع هندسي GeoJSON Polygon صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

موقع يمثل خط عرض وخط طول.
MapsRouteClientOptions

المعلمات الاختيارية للعميل
RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

انشر معلمات النص الأساسي لتوجيهات المسار.
RouteDirectionsBatchItemOutput

عنصر تم إرجاعه من مكالمة خدمة Route Directions Batch.
RouteDirectionsBatchItemResponseOutput

نتيجة الاستعلام. RouteDirections إذا اكتمل الاستعلام بنجاح، ErrorResponse بخلاف ذلك.
RouteDirectionsBatchResultOutput

يتم إرجاع هذا الكائن من استدعاء خدمة Batch لتوجيهات التوجيهات الناجحة.
RouteDirectionsOutput

يتم إرجاع هذا الكائن من استدعاء توجيه المسار الناجح
RouteGetRouteDirections200Response

واجهة برمجة تطبيقات Get Route Directions هي طلب GET HTTP الذي يرجع مسارا بين أصل ووجهة، ويمر عبر نقاط الطريق إذا تم تحديده. يأخذ المسار في الاعتبار عوامل مثل حركة المرور الحالية وسرعات الطريق النموذجية في اليوم المطلوب من الأسبوع والوقت من اليوم.

تتضمن المعلومات التي يتم إرجاعها المسافة ووقت السفر المقدر وتمثيلا لهندسة المسار. تتوفر أيضا معلومات توجيه إضافية مثل ترتيب نقطة الطريق المحسنة أو إرشادات التحويل حسب الدور، اعتمادا على الخيارات المحددة.

توفر خدمة التوجيه مجموعة من المعلمات لوصف مفصل لنموذج استهلاك خاص بالمركبات. لمزيد من المعلومات، راجعنموذج استهلاك .
RouteGetRouteDirectionsBatch200Response

Get Route Directions Batch API هو طلب GET HTTP يرسل دفعات من الاستعلامات إلى الحصول على توجيهات التوجيهات API باستخدام طلب واحد. يمكنك استدعاء Get Route Directions Batch API لتشغيل إما بشكل غير متزامن (غير متزامن) أو بشكل متزامن (مزامنة). تسمح واجهة برمجة التطبيقات غير المتزامنة للمتصل بتجميع ما يصل إلى 700 استعلامات ومزامنة واجهة برمجة التطبيقات حتى 100 استعلامات.

تنزيل نتائج الدفعات غير المتزامنة

لتنزيل نتائج الدفعة غير المتزامنة، ستصدر طلبا GET إلى نقطة نهاية تنزيل الدفعة. يمكن الحصول على URL لتنزيل هذا من عنوان لطلب دفعة ناجح ويبدو كما يلي:

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

فيما يلي التسلسل النموذجي للعمليات لتنزيل نتائج الدفعة:

  1. يرسل العميل طلب GET باستخدام عنوان URL لتنزيل .

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب الدفعة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

    HTTP 200 OK - تمت معالجة طلب الدفعة بنجاح. يحتوي نص الاستجابة على جميع نتائج الدفعة.

نموذج استجابة الدفعة

محتوى البيانات الذي تم إرجاعه مشابه لطلبات المزامنة وغير المتزامنة. عند تنزيل نتائج طلب دفعة غير متزامنة، إذا انتهت معالجة الدفعة، يحتوي نص الاستجابة على استجابة الدفعة. تحتوي استجابة الدفعة هذه على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequestsأي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. يحتوي كل عنصر في batchItems على حقول statusCoderesponse. كل response في batchItems من أحد الأنواع التالية:

  • RouteDirections - إذا اكتمل الاستعلام بنجاح.

  • Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

فيما يلي نموذج استجابة دفعية مع 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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsBatch202Headers
RouteGetRouteDirectionsBatch202Response

Get Route Directions Batch API هو طلب GET HTTP يرسل دفعات من الاستعلامات إلى الحصول على توجيهات التوجيهات API باستخدام طلب واحد. يمكنك استدعاء Get Route Directions Batch API لتشغيل إما بشكل غير متزامن (غير متزامن) أو بشكل متزامن (مزامنة). تسمح واجهة برمجة التطبيقات غير المتزامنة للمتصل بتجميع ما يصل إلى 700 استعلامات ومزامنة واجهة برمجة التطبيقات حتى 100 استعلامات.

تنزيل نتائج الدفعات غير المتزامنة

لتنزيل نتائج الدفعة غير المتزامنة، ستصدر طلبا GET إلى نقطة نهاية تنزيل الدفعة. يمكن الحصول على URL لتنزيل هذا من عنوان لطلب دفعة ناجح ويبدو كما يلي:

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

فيما يلي التسلسل النموذجي للعمليات لتنزيل نتائج الدفعة:

  1. يرسل العميل طلب GET باستخدام عنوان URL لتنزيل .

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب الدفعة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

    HTTP 200 OK - تمت معالجة طلب الدفعة بنجاح. يحتوي نص الاستجابة على جميع نتائج الدفعة.

نموذج استجابة الدفعة

محتوى البيانات الذي تم إرجاعه مشابه لطلبات المزامنة وغير المتزامنة. عند تنزيل نتائج طلب دفعة غير متزامنة، إذا انتهت معالجة الدفعة، يحتوي نص الاستجابة على استجابة الدفعة. تحتوي استجابة الدفعة هذه على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequestsأي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. يحتوي كل عنصر في batchItems على حقول statusCoderesponse. كل response في batchItems من أحد الأنواع التالية:

  • RouteDirections - إذا اكتمل الاستعلام بنجاح.

  • Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

فيما يلي نموذج استجابة دفعية مع 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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsDefaultResponse

واجهة برمجة تطبيقات Get Route Directions هي طلب GET HTTP الذي يرجع مسارا بين أصل ووجهة، ويمر عبر نقاط الطريق إذا تم تحديده. يأخذ المسار في الاعتبار عوامل مثل حركة المرور الحالية وسرعات الطريق النموذجية في اليوم المطلوب من الأسبوع والوقت من اليوم.

تتضمن المعلومات التي يتم إرجاعها المسافة ووقت السفر المقدر وتمثيلا لهندسة المسار. تتوفر أيضا معلومات توجيه إضافية مثل ترتيب نقطة الطريق المحسنة أو إرشادات التحويل حسب الدور، اعتمادا على الخيارات المحددة.

توفر خدمة التوجيه مجموعة من المعلمات لوصف مفصل لنموذج استهلاك خاص بالمركبات. لمزيد من المعلومات، راجعنموذج استهلاك .
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

Post Route Directions API هو طلب POST HTTP يرجع مسارا بين أصل ووجهة، ويمر عبر نقاط الطريق إذا تم تحديدها. وسيأخذ المسار في الاعتبار عوامل مثل حركة المرور الحالية وسرعات الطريق النموذجية في اليوم المطلوب من الأسبوع والوقت من اليوم.

تتضمن المعلومات التي يتم إرجاعها المسافة ووقت السفر المقدر وتمثيلا لهندسة المسار. تتوفر أيضا معلومات توجيه إضافية مثل ترتيب نقطة الطريق المحسنة أو إرشادات التحويل حسب الدور، اعتمادا على الخيارات المحددة.

توفر خدمة التوجيه مجموعة من المعلمات لوصف مفصل لنموذج استهلاك خاص بالمركبات. يرجى التحقق نموذج الاستهلاك للحصول على شرح مفصل للمفاهيم والمعلمات المعنية.
RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Post Route Directions API هو طلب POST HTTP يرجع مسارا بين أصل ووجهة، ويمر عبر نقاط الطريق إذا تم تحديدها. وسيأخذ المسار في الاعتبار عوامل مثل حركة المرور الحالية وسرعات الطريق النموذجية في اليوم المطلوب من الأسبوع والوقت من اليوم.

تتضمن المعلومات التي يتم إرجاعها المسافة ووقت السفر المقدر وتمثيلا لهندسة المسار. تتوفر أيضا معلومات توجيه إضافية مثل ترتيب نقطة الطريق المحسنة أو إرشادات التحويل حسب الدور، اعتمادا على الخيارات المحددة.

توفر خدمة التوجيه مجموعة من المعلمات لوصف مفصل لنموذج استهلاك خاص بالمركبات. يرجى التحقق نموذج الاستهلاك للحصول على شرح مفصل للمفاهيم والمعلمات المعنية.
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

Get Route Matrix API هو طلب GET HTTP يحسب وقت السفر والمسافة لجميع الأزواج الممكنة في قائمة الأصول والوجهات. على عكس Get Route Directions API، والتي توفر إرشادات تفصيلية للمسار، تركز واجهة برمجة التطبيقات هذه على الكفاءة من خلال منحك تكلفة (وقت السفر والمسافة) للتوجيه من كل أصل إلى كل وجهة. لمزيد من المعلومات، راجع أفضل الممارسات لخدمة مسار خرائط Azure.

لكل أصل معين، تحسب الخدمة تكلفة التوجيه من هذا الأصل إلى كل وجهة معينة. يمكن اعتبار مجموعة الأصول ومجموعة الوجهات كرؤوس أعمدة وصف لجدول وتحتوي كل خلية في الجدول على تكاليف التوجيه من الأصل إلى الوجهة لتلك الخلية. على سبيل المثال، لنفترض أن شركة توصيل الأغذية لديها 20 سائقا ويحتاجون إلى العثور على أقرب سائق لالتقاط التسليم من المطعم. لحل حالة الاستخدام هذه، يمكنهم استدعاء واجهة برمجة تطبيقات مسار المصفوفة.

لكل مسار، يتم إرجاع أوقات السفر والمسافات. يمكنك استخدام التكاليف المحسوبة لتحديد المسارات التفصيلية التي يجب حسابها باستخدام واجهة برمجة تطبيقات توجيه التوجيهات.

الحد الأقصى لحجم مصفوفة الطلب غير المتزامن هو 700 ولطلب المزامنة 100 (عدد الأصول مضروبا في عدد الوجهات).

إرسال طلب مصفوفة توجيه متزامن

إذا كان السيناريو الخاص بك يتطلب طلبات متزامنة وكان الحد الأقصى لحجم المصفوفة أقل من أو يساوي 100، فقد تحتاج إلى تقديم طلب متزامن. الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 100 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 10x10، 6x8، 9x8 (لا تحتاج إلى أن تكون مربعة).

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

إرسال طلب مصفوفة مسار غير متزامن

واجهة برمجة التطبيقات غير المتزامنة مناسبة لمعالجة كميات كبيرة من طلبات التوجيه المعقدة نسبيا. عند تقديم طلب باستخدام طلب غير متزامن، تقوم الخدمة بشكل افتراضي بإرجاع رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. إذا تم تعيين المعلمة waitForResults في الطلب إلى true، فسيحصل المستخدم على استجابة 200 إذا تم الانتهاء من الطلب أقل من 120 ثانية.

الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 700 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 50x10، 10x10، 28x25. 10x70 (لا يلزم أن يكون مربعا).

يتم تخزين الاستجابات غير المتزامنة لمدة 24 ساعة. يقوم عنوان URL لإعادة التوجيه بإرجاع استجابة 404 إذا تم استخدامها بعد فترة انتهاء الصلاحية.

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

فيما يلي تسلسل نموذجي للعمليات غير المتزامنة:

  1. يرسل العميل طلب Route Matrix GET إلى خرائط Azure

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب مصفوفة التوجيه.

    HTTP Error - حدث خطأ أثناء معالجة طلب مصفوفة التوجيه. قد يكون هذا إما طلب غير صحيح 400 أو أي رمز حالة خطأ آخر.

  3. إذا تم قبول طلب مسار المصفوفة بنجاح، يحتوي عنوان الموقع في الاستجابة على عنوان URL لتنزيل نتائج الطلب. يبدو عنوان URI للحالة هذا كما يلي:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. يصدر العميل طلب GET على عنوان URL للتنزيل الذي تم الحصول عليه في الخطوة 3 لتنزيل النتائج

تنزيل نتائج المزامنة

عند إجراء طلب GET لواجهة برمجة تطبيقات مزامنة مصفوفة التوجيه، تقوم الخدمة بإرجاع رمز استجابة 200 لطلب ناجح وصفيف استجابة. سيحتوي نص الاستجابة على البيانات ولن تكون هناك إمكانية لاسترداد النتائج لاحقا.

تنزيل نتائج غير متزامنة

عندما يصدر طلب استجابة 202 Accepted، تتم معالجة الطلب باستخدام البنية الأساسية لبرنامج ربط العمليات التجارية غير المتزامنة. سيتم منحك عنوان URL للتحقق من تقدم طلبك غير المتزامن في عنوان الموقع للاستجابة. يبدو عنوان URI للحالة هذا كما يلي:

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

سيعيد عنوان URL الذي يوفره عنوان الموقع الاستجابات التالية عند إصدار طلب GET.

HTTP 202 Accepted - تم قبول طلب المصفوفة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

HTTP 200 OK - تمت معالجة طلب المصفوفة بنجاح. يحتوي نص الاستجابة على جميع النتائج.
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

Get Route Matrix API هو طلب GET HTTP يحسب وقت السفر والمسافة لجميع الأزواج الممكنة في قائمة الأصول والوجهات. على عكس Get Route Directions API، والتي توفر إرشادات تفصيلية للمسار، تركز واجهة برمجة التطبيقات هذه على الكفاءة من خلال منحك تكلفة (وقت السفر والمسافة) للتوجيه من كل أصل إلى كل وجهة. لمزيد من المعلومات، راجع أفضل الممارسات لخدمة مسار خرائط Azure.

لكل أصل معين، تحسب الخدمة تكلفة التوجيه من هذا الأصل إلى كل وجهة معينة. يمكن اعتبار مجموعة الأصول ومجموعة الوجهات كرؤوس أعمدة وصف لجدول وتحتوي كل خلية في الجدول على تكاليف التوجيه من الأصل إلى الوجهة لتلك الخلية. على سبيل المثال، لنفترض أن شركة توصيل الأغذية لديها 20 سائقا ويحتاجون إلى العثور على أقرب سائق لالتقاط التسليم من المطعم. لحل حالة الاستخدام هذه، يمكنهم استدعاء واجهة برمجة تطبيقات مسار المصفوفة.

لكل مسار، يتم إرجاع أوقات السفر والمسافات. يمكنك استخدام التكاليف المحسوبة لتحديد المسارات التفصيلية التي يجب حسابها باستخدام واجهة برمجة تطبيقات توجيه التوجيهات.

الحد الأقصى لحجم مصفوفة الطلب غير المتزامن هو 700 ولطلب المزامنة 100 (عدد الأصول مضروبا في عدد الوجهات).

إرسال طلب مصفوفة توجيه متزامن

إذا كان السيناريو الخاص بك يتطلب طلبات متزامنة وكان الحد الأقصى لحجم المصفوفة أقل من أو يساوي 100، فقد تحتاج إلى تقديم طلب متزامن. الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 100 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 10x10، 6x8، 9x8 (لا تحتاج إلى أن تكون مربعة).

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

إرسال طلب مصفوفة مسار غير متزامن

واجهة برمجة التطبيقات غير المتزامنة مناسبة لمعالجة كميات كبيرة من طلبات التوجيه المعقدة نسبيا. عند تقديم طلب باستخدام طلب غير متزامن، تقوم الخدمة بشكل افتراضي بإرجاع رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. إذا تم تعيين المعلمة waitForResults في الطلب إلى true، فسيحصل المستخدم على استجابة 200 إذا تم الانتهاء من الطلب أقل من 120 ثانية.

الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 700 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 50x10، 10x10، 28x25. 10x70 (لا يلزم أن يكون مربعا).

يتم تخزين الاستجابات غير المتزامنة لمدة 24 ساعة. يقوم عنوان URL لإعادة التوجيه بإرجاع استجابة 404 إذا تم استخدامها بعد فترة انتهاء الصلاحية.

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

فيما يلي تسلسل نموذجي للعمليات غير المتزامنة:

  1. يرسل العميل طلب Route Matrix GET إلى خرائط Azure

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب مصفوفة التوجيه.

    HTTP Error - حدث خطأ أثناء معالجة طلب مصفوفة التوجيه. قد يكون هذا إما طلب غير صحيح 400 أو أي رمز حالة خطأ آخر.

  3. إذا تم قبول طلب مسار المصفوفة بنجاح، يحتوي عنوان الموقع في الاستجابة على عنوان URL لتنزيل نتائج الطلب. يبدو عنوان URI للحالة هذا كما يلي:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. يصدر العميل طلب GET على عنوان URL للتنزيل الذي تم الحصول عليه في الخطوة 3 لتنزيل النتائج

تنزيل نتائج المزامنة

عند إجراء طلب GET لواجهة برمجة تطبيقات مزامنة مصفوفة التوجيه، تقوم الخدمة بإرجاع رمز استجابة 200 لطلب ناجح وصفيف استجابة. سيحتوي نص الاستجابة على البيانات ولن تكون هناك إمكانية لاسترداد النتائج لاحقا.

تنزيل نتائج غير متزامنة

عندما يصدر طلب استجابة 202 Accepted، تتم معالجة الطلب باستخدام البنية الأساسية لبرنامج ربط العمليات التجارية غير المتزامنة. سيتم منحك عنوان URL للتحقق من تقدم طلبك غير المتزامن في عنوان الموقع للاستجابة. يبدو عنوان URI للحالة هذا كما يلي:

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

سيعيد عنوان URL الذي يوفره عنوان الموقع الاستجابات التالية عند إصدار طلب GET.

HTTP 202 Accepted - تم قبول طلب المصفوفة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

HTTP 200 OK - تمت معالجة طلب المصفوفة بنجاح. يحتوي نص الاستجابة على جميع النتائج.
RouteGetRouteRange200Response

واجهة برمجة تطبيقات Get Route Range (Isochrone) هي طلب GET HTTP الذي سيحسب مجموعة من المواقع التي يمكن الوصول إليها من نقطة الأصل استنادا إلى ميزانية الوقود أو الطاقة أو الوقت أو المسافة المحددة. يتم إرجاع حد مضلع (أو Isochrone) في اتجاه عكس اتجاه عقارب الساعة بالإضافة إلى مركز المضلع الدقيق الذي كان نتيجة نقطة الأصل.

يمكن استخدام المضلع الذي تم إرجاعه لمزيد من المعالجة مثل Search Inside Geometry للبحث عن POIs ضمن isochrone المتوفر.
RouteGetRouteRangeDefaultResponse

واجهة برمجة تطبيقات Get Route Range (Isochrone) هي طلب GET HTTP الذي سيحسب مجموعة من المواقع التي يمكن الوصول إليها من نقطة الأصل استنادا إلى ميزانية الوقود أو الطاقة أو الوقت أو المسافة المحددة. يتم إرجاع حد مضلع (أو Isochrone) في اتجاه عكس اتجاه عقارب الساعة بالإضافة إلى مركز المضلع الدقيق الذي كان نتيجة نقطة الأصل.

يمكن استخدام المضلع الذي تم إرجاعه لمزيد من المعالجة مثل Search Inside Geometry للبحث عن POIs ضمن isochrone المتوفر.
RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

يحتوي على عناصر ذات صلة بالإرشادات. لا يتوفر هذا الحقل إلا عند طلب الإرشادات ويكون متوفرا.
RouteInstructionGroupOutput

تجميع سلسلة من عناصر التعليمات المرتبطة ببعضها البعض. نطاق التسلسل مقيد ب firstInstructionIndex و lastInstructionIndex. عندما يتم طلب الرسائل النصية القابلة للقراءة من قبل الإنسان للحصول على إرشادات (instructionType=text أو tagged)، فإن مجموعة الإرشادات تحتوي على رسالة موجزة يتم إرجاعها عند توفرها.
RouteInstructionOutput

مجموعة من السمات التي تصف مناورة، مثل "اتجه لليمين"، و"احتفظ باليسار"، و"خذ العبارة"، و"خذ الطريق السريع"، و"الوصول".
RouteLegOutput

وصف لجزء من مسار، يتكون من قائمة نقاط. ستؤدي كل نقطة طريق إضافية تم توفيرها في الطلب إلى وجود ساق إضافية في المسار الذي تم إرجاعه.
RouteMatrixOutput

كائن نتيجة المصفوفة
RouteMatrixQuery

كائن مع مصفوفة من الإحداثيات.
RouteMatrixResultOutput

يتم إرجاع هذا الكائن من استدعاء مصفوفة التوجيه الناجحة. على سبيل المثال، إذا تم توفير أصلين و3 وجهات، فهناك صفيفان مع 3 عناصر في كل منهما. يعتمد محتوى كل عنصر على الخيارات المتوفرة في الاستعلام.
RouteMatrixResultResponseOutput

كائن الاستجابة للخلية الحالية في مصفوفة الإدخال.
RouteMatrixSummaryOutput

كائن الملخص
RouteOptimizedWaypointOutput

كائن نقطة طريقة محسن.
RouteOutput
RouteRangeOutput

نطاق يمكن الوصول إليه
RouteRangeResultOutput

يتم إرجاع هذا الكائن من استدعاء ناجح لنطاق التوجيه الذي يمكن الوصول إليه
RouteReportOutput

يبلغ عن الإعدادات الفعالة المستخدمة في المكالمة الحالية.
RouteRequestRouteDirectionsBatch200Response

Post Route Directions Batch API هو طلب POST HTTP يرسل دفعات من الاستعلامات إلى الحصول على توجيهات التوجيهات API باستخدام طلب واحد غير متزامن. يمكنك استدعاء Route Directions Batch API لتشغيل إما بشكل غير متزامن (غير متزامن) أو بشكل متزامن (مزامنة). تسمح واجهة برمجة التطبيقات غير المتزامنة للمتصل بتجميع ما يصل إلى 700 استعلامات ومزامنة واجهة برمجة التطبيقات حتى 100 استعلامات. لاستدعاء واجهة برمجة تطبيقات Post Route Directions Batch في طلب متزامن، راجع مزامنة دفعة اتجاهات التوجيهات اللاحقة.

إرسال طلب دفعي غير متزامن

واجهة برمجة التطبيقات غير المتزامنة مناسبة لمعالجة كميات كبيرة من طلبات المسار المعقدة نسبيا

  • يسمح باسترداد النتائج في مكالمة منفصلة (يمكن إجراء تنزيلات متعددة).
  • تم تحسين واجهة برمجة التطبيقات غير المتزامنة للموثوقية ولا يتوقع أن يتم تشغيلها في مهلة.
  • يقتصر عدد عناصر الدفعات على 700 لواجهة برمجة التطبيقات هذه.

عند تقديم طلب باستخدام طلب غير متزامن، تقوم الخدمة بشكل افتراضي بإرجاع رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. يتم تخزين الاستجابات غير المتزامنة لمدة 24 ساعة. يقوم عنوان URL لإعادة التوجيه بإرجاع استجابة 404 إذا تم استخدامها بعد فترة انتهاء الصلاحية.

يرجى ملاحظة أن طلب الدفعة غير المتزامن هو عملية طويلة الأمد. فيما يلي تسلسل نموذجي للعمليات:

  1. يرسل العميل طلب توجيه التوجيهات POST الدفعة إلى خرائط Azure.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب الدفعة.

    HTTP Error - حدث خطأ أثناء معالجة طلب Batch. قد يكون هذا إما 400 Bad Request أو أي رمز حالة Error آخر.

  2. إذا تم قبول طلب الدفعة بنجاح، يحتوي عنوان Location في الاستجابة على عنوان URL لتنزيل نتائج طلب الدفعة. يبدو عنوان URI للحالة هذا كما يلي:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. يصدر العميل طلب على الحصول على عنوان URL لتنزيل في الخطوة 3 لتنزيل نتائج الدفعة.

نص POST لطلب الدفعة

لإرسال توجيهات توجيه الاستعلامات، ستستخدم طلب POST حيث سيحتوي نص الطلب على صفيف batchItems بتنسيق json وسيتم تعيين عنوان Content-Type إلى application/json. فيما يلي نموذج نص طلب يحتوي على 3 توجيهات مسار الاستعلامات:

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

توجيهات المسار الاستعلام في دفعة ما هو مجرد عنوان URL جزئي دون البروتوكول وعنوان URL الأساسي والمسار وإصدار واجهة برمجة التطبيقات ومفتاح الاشتراك. يمكنه قبول أي من توجيهات مسار المدعومةمعلمات URI. يجب إلغاء قيم السلسلة في توجيهات المسار الاستعلام بشكل صحيح (على سبيل المثال، يجب إلغاء الحرف باستخدام \ ) ويجب أيضا ترميز عنوان URL بشكل صحيح.

تسمح واجهة برمجة التطبيقات غير المتزامنة للمتصل بتجميع ما يصل إلى 700 استعلام ومزامنة API حتى 100 استعلام، ويجب أن تحتوي الدفعة على استعلام 1 على الأقل.

تنزيل نتائج الدفعات غير المتزامنة

لتنزيل نتائج الدفعة غير المتزامنة، ستصدر طلبا GET إلى نقطة نهاية تنزيل الدفعة. يمكن الحصول على URL لتنزيل هذا من عنوان لطلب دفعة ناجح ويبدو كما يلي:

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

فيما يلي التسلسل النموذجي للعمليات لتنزيل نتائج الدفعة:

  1. يرسل العميل طلب GET باستخدام عنوان URL لتنزيل .

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب الدفعة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

    HTTP 200 OK - تمت معالجة طلب الدفعة بنجاح. يحتوي نص الاستجابة على جميع نتائج الدفعة.

نموذج استجابة الدفعة

محتوى البيانات الذي تم إرجاعه مشابه لطلبات المزامنة وغير المتزامنة. عند تنزيل نتائج طلب دفعة غير متزامنة، إذا انتهت معالجة الدفعة، يحتوي نص الاستجابة على استجابة الدفعة. تحتوي استجابة الدفعة هذه على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequestsأي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. يحتوي كل عنصر في batchItems على حقول statusCoderesponse. كل response في batchItems من أحد الأنواع التالية:

  • RouteDirections - إذا اكتمل الاستعلام بنجاح.

  • Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

فيما يلي نموذج استجابة دفعية مع 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatch202Headers
RouteRequestRouteDirectionsBatch202Response

Post Route Directions Batch API هو طلب POST HTTP يرسل دفعات من الاستعلامات إلى الحصول على توجيهات التوجيهات API باستخدام طلب واحد غير متزامن. يمكنك استدعاء Route Directions Batch API لتشغيل إما بشكل غير متزامن (غير متزامن) أو بشكل متزامن (مزامنة). تسمح واجهة برمجة التطبيقات غير المتزامنة للمتصل بتجميع ما يصل إلى 700 استعلامات ومزامنة واجهة برمجة التطبيقات حتى 100 استعلامات. لاستدعاء واجهة برمجة تطبيقات Post Route Directions Batch في طلب متزامن، راجع مزامنة دفعة اتجاهات التوجيهات اللاحقة.

إرسال طلب دفعي غير متزامن

واجهة برمجة التطبيقات غير المتزامنة مناسبة لمعالجة كميات كبيرة من طلبات المسار المعقدة نسبيا

  • يسمح باسترداد النتائج في مكالمة منفصلة (يمكن إجراء تنزيلات متعددة).
  • تم تحسين واجهة برمجة التطبيقات غير المتزامنة للموثوقية ولا يتوقع أن يتم تشغيلها في مهلة.
  • يقتصر عدد عناصر الدفعات على 700 لواجهة برمجة التطبيقات هذه.

عند تقديم طلب باستخدام طلب غير متزامن، تقوم الخدمة بشكل افتراضي بإرجاع رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. يتم تخزين الاستجابات غير المتزامنة لمدة 24 ساعة. يقوم عنوان URL لإعادة التوجيه بإرجاع استجابة 404 إذا تم استخدامها بعد فترة انتهاء الصلاحية.

يرجى ملاحظة أن طلب الدفعة غير المتزامن هو عملية طويلة الأمد. فيما يلي تسلسل نموذجي للعمليات:

  1. يرسل العميل طلب توجيه التوجيهات POST الدفعة إلى خرائط Azure.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب الدفعة.

    HTTP Error - حدث خطأ أثناء معالجة طلب Batch. قد يكون هذا إما 400 Bad Request أو أي رمز حالة Error آخر.

  2. إذا تم قبول طلب الدفعة بنجاح، يحتوي عنوان Location في الاستجابة على عنوان URL لتنزيل نتائج طلب الدفعة. يبدو عنوان URI للحالة هذا كما يلي:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. يصدر العميل طلب على الحصول على عنوان URL لتنزيل في الخطوة 3 لتنزيل نتائج الدفعة.

نص POST لطلب الدفعة

لإرسال توجيهات توجيه الاستعلامات، ستستخدم طلب POST حيث سيحتوي نص الطلب على صفيف batchItems بتنسيق json وسيتم تعيين عنوان Content-Type إلى application/json. فيما يلي نموذج نص طلب يحتوي على 3 توجيهات مسار الاستعلامات:

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

توجيهات المسار الاستعلام في دفعة ما هو مجرد عنوان URL جزئي دون البروتوكول وعنوان URL الأساسي والمسار وإصدار واجهة برمجة التطبيقات ومفتاح الاشتراك. يمكنه قبول أي من توجيهات مسار المدعومةمعلمات URI. يجب إلغاء قيم السلسلة في توجيهات المسار الاستعلام بشكل صحيح (على سبيل المثال، يجب إلغاء الحرف باستخدام \ ) ويجب أيضا ترميز عنوان URL بشكل صحيح.

تسمح واجهة برمجة التطبيقات غير المتزامنة للمتصل بتجميع ما يصل إلى 700 استعلام ومزامنة API حتى 100 استعلام، ويجب أن تحتوي الدفعة على استعلام 1 على الأقل.

تنزيل نتائج الدفعات غير المتزامنة

لتنزيل نتائج الدفعة غير المتزامنة، ستصدر طلبا GET إلى نقطة نهاية تنزيل الدفعة. يمكن الحصول على URL لتنزيل هذا من عنوان لطلب دفعة ناجح ويبدو كما يلي:

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

فيما يلي التسلسل النموذجي للعمليات لتنزيل نتائج الدفعة:

  1. يرسل العميل طلب GET باستخدام عنوان URL لتنزيل .

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب الدفعة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

    HTTP 200 OK - تمت معالجة طلب الدفعة بنجاح. يحتوي نص الاستجابة على جميع نتائج الدفعة.

نموذج استجابة الدفعة

محتوى البيانات الذي تم إرجاعه مشابه لطلبات المزامنة وغير المتزامنة. عند تنزيل نتائج طلب دفعة غير متزامنة، إذا انتهت معالجة الدفعة، يحتوي نص الاستجابة على استجابة الدفعة. تحتوي استجابة الدفعة هذه على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequestsأي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. يحتوي كل عنصر في batchItems على حقول statusCoderesponse. كل response في batchItems من أحد الأنواع التالية:

  • RouteDirections - إذا اكتمل الاستعلام بنجاح.

  • Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

فيما يلي نموذج استجابة دفعية مع 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchBodyParam
RouteRequestRouteDirectionsBatchMediaTypesParam
RouteRequestRouteDirectionsBatchSync200Response

Post Route Directions Batch Sync API هو طلب POST HTTP يرسل دفعات من الاستعلامات إلى Get Route Directions API باستخدام طلب متزامن واحد. يمكنك استدعاء Route Directions Batch API لتشغيل إما بشكل غير متزامن (غير متزامن) أو بشكل متزامن (مزامنة). تسمح واجهة برمجة التطبيقات غير المتزامنة للمتصل بتجميع ما يصل إلى 700 استعلامات ومزامنة واجهة برمجة التطبيقات حتى 100 استعلامات. لاستدعاء واجهة برمجة تطبيقات Post Route Directions Batch في طلب غير متزامن، راجع دفعة اتجاهات التوجيهات اللاحقة.

إرسال طلب دفعي متزامن

يوصى باستخدام واجهة برمجة التطبيقات المتزامنة لطلبات الدفعات الخفيفة. عندما تتلقى الخدمة طلبا، سوف تستجيب بمجرد حساب عناصر الدفعة ولن تكون هناك إمكانية لاسترداد النتائج لاحقا. سترجع واجهة برمجة التطبيقات المتزامنة خطأ مهلة (استجابة 408) إذا استغرق الطلب أكثر من 60 ثانية. يقتصر عدد عناصر الدفعات على 100 لواجهة برمجة التطبيقات هذه.

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

نموذج استجابة الدفعة

محتوى البيانات الذي تم إرجاعه مشابه لطلبات المزامنة وغير المتزامنة. عند تنزيل نتائج طلب دفعة غير متزامنة، إذا انتهت معالجة الدفعة، يحتوي نص الاستجابة على استجابة الدفعة. تحتوي استجابة الدفعة هذه على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequestsأي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. يحتوي كل عنصر في batchItems على حقول statusCoderesponse. كل response في batchItems من أحد الأنواع التالية:

  • RouteDirections - إذا اكتمل الاستعلام بنجاح.

  • Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

فيما يلي نموذج استجابة دفعية مع 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSync408Response

Post Route Directions Batch Sync API هو طلب POST HTTP يرسل دفعات من الاستعلامات إلى Get Route Directions API باستخدام طلب متزامن واحد. يمكنك استدعاء Route Directions Batch API لتشغيل إما بشكل غير متزامن (غير متزامن) أو بشكل متزامن (مزامنة). تسمح واجهة برمجة التطبيقات غير المتزامنة للمتصل بتجميع ما يصل إلى 700 استعلامات ومزامنة واجهة برمجة التطبيقات حتى 100 استعلامات. لاستدعاء واجهة برمجة تطبيقات Post Route Directions Batch في طلب غير متزامن، راجع دفعة اتجاهات التوجيهات اللاحقة.

إرسال طلب دفعي متزامن

يوصى باستخدام واجهة برمجة التطبيقات المتزامنة لطلبات الدفعات الخفيفة. عندما تتلقى الخدمة طلبا، سوف تستجيب بمجرد حساب عناصر الدفعة ولن تكون هناك إمكانية لاسترداد النتائج لاحقا. سترجع واجهة برمجة التطبيقات المتزامنة خطأ مهلة (استجابة 408) إذا استغرق الطلب أكثر من 60 ثانية. يقتصر عدد عناصر الدفعات على 100 لواجهة برمجة التطبيقات هذه.

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

نموذج استجابة الدفعة

محتوى البيانات الذي تم إرجاعه مشابه لطلبات المزامنة وغير المتزامنة. عند تنزيل نتائج طلب دفعة غير متزامنة، إذا انتهت معالجة الدفعة، يحتوي نص الاستجابة على استجابة الدفعة. تحتوي استجابة الدفعة هذه على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequestsأي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. يحتوي كل عنصر في batchItems على حقول statusCoderesponse. كل response في batchItems من أحد الأنواع التالية:

  • RouteDirections - إذا اكتمل الاستعلام بنجاح.

  • Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

فيما يلي نموذج استجابة دفعية مع 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncBodyParam
RouteRequestRouteDirectionsBatchSyncDefaultResponse

Post Route Directions Batch Sync API هو طلب POST HTTP يرسل دفعات من الاستعلامات إلى Get Route Directions API باستخدام طلب متزامن واحد. يمكنك استدعاء Route Directions Batch API لتشغيل إما بشكل غير متزامن (غير متزامن) أو بشكل متزامن (مزامنة). تسمح واجهة برمجة التطبيقات غير المتزامنة للمتصل بتجميع ما يصل إلى 700 استعلامات ومزامنة واجهة برمجة التطبيقات حتى 100 استعلامات. لاستدعاء واجهة برمجة تطبيقات Post Route Directions Batch في طلب غير متزامن، راجع دفعة اتجاهات التوجيهات اللاحقة.

إرسال طلب دفعي متزامن

يوصى باستخدام واجهة برمجة التطبيقات المتزامنة لطلبات الدفعات الخفيفة. عندما تتلقى الخدمة طلبا، سوف تستجيب بمجرد حساب عناصر الدفعة ولن تكون هناك إمكانية لاسترداد النتائج لاحقا. سترجع واجهة برمجة التطبيقات المتزامنة خطأ مهلة (استجابة 408) إذا استغرق الطلب أكثر من 60 ثانية. يقتصر عدد عناصر الدفعات على 100 لواجهة برمجة التطبيقات هذه.

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

نموذج استجابة الدفعة

محتوى البيانات الذي تم إرجاعه مشابه لطلبات المزامنة وغير المتزامنة. عند تنزيل نتائج طلب دفعة غير متزامنة، إذا انتهت معالجة الدفعة، يحتوي نص الاستجابة على استجابة الدفعة. تحتوي استجابة الدفعة هذه على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequestsأي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. يحتوي كل عنصر في batchItems على حقول statusCoderesponse. كل response في batchItems من أحد الأنواع التالية:

  • RouteDirections - إذا اكتمل الاستعلام بنجاح.

  • Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

فيما يلي نموذج استجابة دفعية مع 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncMediaTypesParam
RouteRequestRouteMatrix200Response

Post Route Matrix API هو طلب POST HTTP يسمح بحساب مصفوفة من ملخصات المسار لمجموعة من المسارات المحددة بواسطة مواقع الأصل والوجهة باستخدام طلب غير متزامن (غير متزامن). لإجراء طلب متزامن (مزامنة)، راجع مزامنة مصفوفة التوجيه اللاحقة. لكل أصل معين، تحسب الخدمة تكلفة التوجيه من هذا الأصل إلى كل وجهة معينة. يمكن اعتبار مجموعة الأصول ومجموعة الوجهات كرؤوس أعمدة وصف لجدول وتحتوي كل خلية في الجدول على تكاليف التوجيه من الأصل إلى الوجهة لتلك الخلية. على سبيل المثال، لنفترض أن شركة توصيل الأغذية لديها 20 سائقا ويحتاجون إلى العثور على أقرب سائق لالتقاط التسليم من المطعم. لحل حالة الاستخدام هذه، يمكنهم استدعاء واجهة برمجة تطبيقات مسار المصفوفة.

لكل مسار، يتم إرجاع أوقات السفر والمسافات. يمكنك استخدام التكاليف المحسوبة لتحديد المسارات التفصيلية التي يجب حسابها باستخدام واجهة برمجة تطبيقات توجيه التوجيهات.

الحد الأقصى لحجم مصفوفة الطلب غير المتزامن هو 700 ولطلب المزامنة 100 (عدد الأصول مضروبا في عدد الوجهات).

ملاحظة

يجب احتواء جميع الأصول والوجهات في مربع إحاطة بمحاذاة المحور 400 كم × 400 كم. وإلا سيتم حل بعض خلايا المصفوفة ك OUT_OF_REGION.

إرسال طلب مصفوفة توجيه متزامن

إذا كان السيناريو الخاص بك يتطلب طلبات متزامنة وكان الحد الأقصى لحجم المصفوفة أقل من أو يساوي 100، فقد تحتاج إلى تقديم طلب متزامن. الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 100 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 10x10، 6x8، 9x8 (لا تحتاج إلى أن تكون مربعة).

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

إرسال طلب مصفوفة مسار غير متزامن

واجهة برمجة التطبيقات غير المتزامنة مناسبة لمعالجة كميات كبيرة من طلبات التوجيه المعقدة نسبيا. عند تقديم طلب باستخدام طلب غير متزامن، تقوم الخدمة بشكل افتراضي بإرجاع رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. إذا تم تعيين المعلمة waitForResults في الطلب إلى true، فسيحصل المستخدم على استجابة 200 إذا تم الانتهاء من الطلب أقل من 120 ثانية.

الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 700 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 50x10، 10x10، 28x25. 10x70 (لا يلزم أن يكون مربعا).

يتم تخزين الاستجابات غير المتزامنة لمدة 24 ساعة. يقوم عنوان URL لإعادة التوجيه بإرجاع استجابة 404 إذا تم استخدامها بعد فترة انتهاء الصلاحية.

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

فيما يلي تسلسل نموذجي للعمليات غير المتزامنة:

  1. يرسل العميل طلب Route Matrix POST إلى خرائط Azure

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب مصفوفة التوجيه.

    HTTP Error - حدث خطأ أثناء معالجة طلب مصفوفة التوجيه. قد يكون هذا إما طلب غير صحيح 400 أو أي رمز حالة خطأ آخر.

  3. إذا تم قبول طلب مسار المصفوفة بنجاح، يحتوي عنوان الموقع في الاستجابة على عنوان URL لتنزيل نتائج الطلب. يبدو عنوان URI للحالة هذا كما يلي:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. يصدر العميل طلب GET على عنوان URL للتنزيل الذي تم الحصول عليه في الخطوة 3 لتنزيل النتائج

تنزيل نتائج المزامنة

عند إجراء طلب POST لواجهة برمجة تطبيقات مزامنة مصفوفة التوجيه، تقوم الخدمة بإرجاع رمز استجابة 200 لطلب ناجح وصفيف استجابة. سيحتوي نص الاستجابة على البيانات ولن تكون هناك إمكانية لاسترداد النتائج لاحقا.

تنزيل نتائج غير متزامنة

عندما يصدر طلب استجابة 202 Accepted، تتم معالجة الطلب باستخدام البنية الأساسية لبرنامج ربط العمليات التجارية غير المتزامنة. سيتم منحك عنوان URL للتحقق من تقدم طلبك غير المتزامن في عنوان الموقع للاستجابة. يبدو عنوان URI للحالة هذا كما يلي:

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

سيعيد عنوان URL الذي يوفره عنوان الموقع الاستجابات التالية عند إصدار طلب GET.

HTTP 202 Accepted - تم قبول طلب المصفوفة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

HTTP 200 OK - تمت معالجة طلب المصفوفة بنجاح. يحتوي نص الاستجابة على جميع النتائج.
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

Post Route Matrix API هو طلب POST HTTP يسمح بحساب مصفوفة من ملخصات المسار لمجموعة من المسارات المحددة بواسطة مواقع الأصل والوجهة باستخدام طلب غير متزامن (غير متزامن). لإجراء طلب متزامن (مزامنة)، راجع مزامنة مصفوفة التوجيه اللاحقة. لكل أصل معين، تحسب الخدمة تكلفة التوجيه من هذا الأصل إلى كل وجهة معينة. يمكن اعتبار مجموعة الأصول ومجموعة الوجهات كرؤوس أعمدة وصف لجدول وتحتوي كل خلية في الجدول على تكاليف التوجيه من الأصل إلى الوجهة لتلك الخلية. على سبيل المثال، لنفترض أن شركة توصيل الأغذية لديها 20 سائقا ويحتاجون إلى العثور على أقرب سائق لالتقاط التسليم من المطعم. لحل حالة الاستخدام هذه، يمكنهم استدعاء واجهة برمجة تطبيقات مسار المصفوفة.

لكل مسار، يتم إرجاع أوقات السفر والمسافات. يمكنك استخدام التكاليف المحسوبة لتحديد المسارات التفصيلية التي يجب حسابها باستخدام واجهة برمجة تطبيقات توجيه التوجيهات.

الحد الأقصى لحجم مصفوفة الطلب غير المتزامن هو 700 ولطلب المزامنة 100 (عدد الأصول مضروبا في عدد الوجهات).

ملاحظة

يجب احتواء جميع الأصول والوجهات في مربع إحاطة بمحاذاة المحور 400 كم × 400 كم. وإلا سيتم حل بعض خلايا المصفوفة ك OUT_OF_REGION.

إرسال طلب مصفوفة توجيه متزامن

إذا كان السيناريو الخاص بك يتطلب طلبات متزامنة وكان الحد الأقصى لحجم المصفوفة أقل من أو يساوي 100، فقد تحتاج إلى تقديم طلب متزامن. الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 100 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 10x10، 6x8، 9x8 (لا تحتاج إلى أن تكون مربعة).

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

إرسال طلب مصفوفة مسار غير متزامن

واجهة برمجة التطبيقات غير المتزامنة مناسبة لمعالجة كميات كبيرة من طلبات التوجيه المعقدة نسبيا. عند تقديم طلب باستخدام طلب غير متزامن، تقوم الخدمة بشكل افتراضي بإرجاع رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. إذا تم تعيين المعلمة waitForResults في الطلب إلى true، فسيحصل المستخدم على استجابة 200 إذا تم الانتهاء من الطلب أقل من 120 ثانية.

الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 700 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 50x10، 10x10، 28x25. 10x70 (لا يلزم أن يكون مربعا).

يتم تخزين الاستجابات غير المتزامنة لمدة 24 ساعة. يقوم عنوان URL لإعادة التوجيه بإرجاع استجابة 404 إذا تم استخدامها بعد فترة انتهاء الصلاحية.

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

فيما يلي تسلسل نموذجي للعمليات غير المتزامنة:

  1. يرسل العميل طلب Route Matrix POST إلى خرائط Azure

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب مصفوفة التوجيه.

    HTTP Error - حدث خطأ أثناء معالجة طلب مصفوفة التوجيه. قد يكون هذا إما طلب غير صحيح 400 أو أي رمز حالة خطأ آخر.

  3. إذا تم قبول طلب مسار المصفوفة بنجاح، يحتوي عنوان الموقع في الاستجابة على عنوان URL لتنزيل نتائج الطلب. يبدو عنوان URI للحالة هذا كما يلي:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. يصدر العميل طلب GET على عنوان URL للتنزيل الذي تم الحصول عليه في الخطوة 3 لتنزيل النتائج

تنزيل نتائج المزامنة

عند إجراء طلب POST لواجهة برمجة تطبيقات مزامنة مصفوفة التوجيه، تقوم الخدمة بإرجاع رمز استجابة 200 لطلب ناجح وصفيف استجابة. سيحتوي نص الاستجابة على البيانات ولن تكون هناك إمكانية لاسترداد النتائج لاحقا.

تنزيل نتائج غير متزامنة

عندما يصدر طلب استجابة 202 Accepted، تتم معالجة الطلب باستخدام البنية الأساسية لبرنامج ربط العمليات التجارية غير المتزامنة. سيتم منحك عنوان URL للتحقق من تقدم طلبك غير المتزامن في عنوان الموقع للاستجابة. يبدو عنوان URI للحالة هذا كما يلي:

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

سيعيد عنوان URL الذي يوفره عنوان الموقع الاستجابات التالية عند إصدار طلب GET.

HTTP 202 Accepted - تم قبول طلب المصفوفة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

HTTP 200 OK - تمت معالجة طلب المصفوفة بنجاح. يحتوي نص الاستجابة على جميع النتائج.
RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

Post Route Matrix Sync API هو طلب POST HTTP يسمح بحساب مصفوفة من ملخصات المسار لمجموعة من المسارات المحددة بواسطة مواقع الأصل والوجهة باستخدام طلب (مزامنة) واحد متزامن. لإجراء طلب غير متزامن (غير متزامن)، راجع Post Route Matrix. لكل أصل معين، تحسب الخدمة تكلفة التوجيه من هذا الأصل إلى كل وجهة معينة. يمكن اعتبار مجموعة الأصول ومجموعة الوجهات كرؤوس أعمدة وصف لجدول وتحتوي كل خلية في الجدول على تكاليف التوجيه من الأصل إلى الوجهة لتلك الخلية. على سبيل المثال، لنفترض أن شركة توصيل الأغذية لديها 20 سائقا ويحتاجون إلى العثور على أقرب سائق لالتقاط التسليم من المطعم. لحل حالة الاستخدام هذه، يمكنهم استدعاء واجهة برمجة تطبيقات مسار المصفوفة.

لكل مسار، يتم إرجاع أوقات السفر والمسافات. يمكنك استخدام التكاليف المحسوبة لتحديد المسارات التفصيلية التي يجب حسابها باستخدام واجهة برمجة تطبيقات توجيه التوجيهات.

الحد الأقصى لحجم مصفوفة الطلب غير المتزامن هو 700 ولطلب المزامنة 100 (عدد الأصول مضروبا في عدد الوجهات).

إرسال طلب مصفوفة توجيه متزامن

إذا كان السيناريو الخاص بك يتطلب طلبات متزامنة وكان الحد الأقصى لحجم المصفوفة أقل من أو يساوي 100، فقد تحتاج إلى تقديم طلب متزامن. الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 100 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 10x10، 6x8، 9x8 (لا تحتاج إلى أن تكون مربعة).

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

إرسال طلب مصفوفة مسار غير متزامن

واجهة برمجة التطبيقات غير المتزامنة مناسبة لمعالجة كميات كبيرة من طلبات التوجيه المعقدة نسبيا. عند تقديم طلب باستخدام طلب غير متزامن، تقوم الخدمة بشكل افتراضي بإرجاع رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. إذا تم تعيين المعلمة waitForResults في الطلب إلى true، فسيحصل المستخدم على استجابة 200 إذا تم الانتهاء من الطلب أقل من 120 ثانية.

الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 700 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 50x10، 10x10، 28x25. 10x70 (لا يلزم أن يكون مربعا).

يتم تخزين الاستجابات غير المتزامنة لمدة 24 ساعة. يقوم عنوان URL لإعادة التوجيه بإرجاع استجابة 404 إذا تم استخدامها بعد فترة انتهاء الصلاحية.

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

فيما يلي تسلسل نموذجي للعمليات غير المتزامنة:

  1. يرسل العميل طلب Route Matrix POST إلى خرائط Azure

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب مصفوفة التوجيه.

    HTTP Error - حدث خطأ أثناء معالجة طلب مصفوفة التوجيه. قد يكون هذا إما طلب غير صحيح 400 أو أي رمز حالة خطأ آخر.

  3. إذا تم قبول طلب مسار المصفوفة بنجاح، يحتوي عنوان الموقع في الاستجابة على عنوان URL لتنزيل نتائج الطلب. يبدو عنوان URI للحالة هذا كما يلي:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. يصدر العميل طلب GET على عنوان URL للتنزيل الذي تم الحصول عليه في الخطوة 3 لتنزيل النتائج

تنزيل نتائج المزامنة

عند إجراء طلب POST لواجهة برمجة تطبيقات مزامنة مصفوفة التوجيه، تقوم الخدمة بإرجاع رمز استجابة 200 لطلب ناجح وصفيف استجابة. سيحتوي نص الاستجابة على البيانات ولن تكون هناك إمكانية لاسترداد النتائج لاحقا.

تنزيل نتائج غير متزامنة

عندما يصدر طلب استجابة 202 Accepted، تتم معالجة الطلب باستخدام البنية الأساسية لبرنامج ربط العمليات التجارية غير المتزامنة. سيتم منحك عنوان URL للتحقق من تقدم طلبك غير المتزامن في عنوان الموقع للاستجابة. يبدو عنوان URI للحالة هذا كما يلي:

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

سيعيد عنوان URL الذي يوفره عنوان الموقع الاستجابات التالية عند إصدار طلب GET.

HTTP 202 Accepted - تم قبول طلب المصفوفة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

HTTP 200 OK - تمت معالجة طلب المصفوفة بنجاح. يحتوي نص الاستجابة على جميع النتائج.
RouteRequestRouteMatrixSync408Response

Post Route Matrix Sync API هو طلب POST HTTP يسمح بحساب مصفوفة من ملخصات المسار لمجموعة من المسارات المحددة بواسطة مواقع الأصل والوجهة باستخدام طلب (مزامنة) واحد متزامن. لإجراء طلب غير متزامن (غير متزامن)، راجع Post Route Matrix. لكل أصل معين، تحسب الخدمة تكلفة التوجيه من هذا الأصل إلى كل وجهة معينة. يمكن اعتبار مجموعة الأصول ومجموعة الوجهات كرؤوس أعمدة وصف لجدول وتحتوي كل خلية في الجدول على تكاليف التوجيه من الأصل إلى الوجهة لتلك الخلية. على سبيل المثال، لنفترض أن شركة توصيل الأغذية لديها 20 سائقا ويحتاجون إلى العثور على أقرب سائق لالتقاط التسليم من المطعم. لحل حالة الاستخدام هذه، يمكنهم استدعاء واجهة برمجة تطبيقات مسار المصفوفة.

لكل مسار، يتم إرجاع أوقات السفر والمسافات. يمكنك استخدام التكاليف المحسوبة لتحديد المسارات التفصيلية التي يجب حسابها باستخدام واجهة برمجة تطبيقات توجيه التوجيهات.

الحد الأقصى لحجم مصفوفة الطلب غير المتزامن هو 700 ولطلب المزامنة 100 (عدد الأصول مضروبا في عدد الوجهات).

إرسال طلب مصفوفة توجيه متزامن

إذا كان السيناريو الخاص بك يتطلب طلبات متزامنة وكان الحد الأقصى لحجم المصفوفة أقل من أو يساوي 100، فقد تحتاج إلى تقديم طلب متزامن. الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 100 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 10x10، 6x8، 9x8 (لا تحتاج إلى أن تكون مربعة).

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

إرسال طلب مصفوفة مسار غير متزامن

واجهة برمجة التطبيقات غير المتزامنة مناسبة لمعالجة كميات كبيرة من طلبات التوجيه المعقدة نسبيا. عند تقديم طلب باستخدام طلب غير متزامن، تقوم الخدمة بشكل افتراضي بإرجاع رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. إذا تم تعيين المعلمة waitForResults في الطلب إلى true، فسيحصل المستخدم على استجابة 200 إذا تم الانتهاء من الطلب أقل من 120 ثانية.

الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 700 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 50x10، 10x10، 28x25. 10x70 (لا يلزم أن يكون مربعا).

يتم تخزين الاستجابات غير المتزامنة لمدة 24 ساعة. يقوم عنوان URL لإعادة التوجيه بإرجاع استجابة 404 إذا تم استخدامها بعد فترة انتهاء الصلاحية.

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

فيما يلي تسلسل نموذجي للعمليات غير المتزامنة:

  1. يرسل العميل طلب Route Matrix POST إلى خرائط Azure

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب مصفوفة التوجيه.

    HTTP Error - حدث خطأ أثناء معالجة طلب مصفوفة التوجيه. قد يكون هذا إما طلب غير صحيح 400 أو أي رمز حالة خطأ آخر.

  3. إذا تم قبول طلب مسار المصفوفة بنجاح، يحتوي عنوان الموقع في الاستجابة على عنوان URL لتنزيل نتائج الطلب. يبدو عنوان URI للحالة هذا كما يلي:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. يصدر العميل طلب GET على عنوان URL للتنزيل الذي تم الحصول عليه في الخطوة 3 لتنزيل النتائج

تنزيل نتائج المزامنة

عند إجراء طلب POST لواجهة برمجة تطبيقات مزامنة مصفوفة التوجيه، تقوم الخدمة بإرجاع رمز استجابة 200 لطلب ناجح وصفيف استجابة. سيحتوي نص الاستجابة على البيانات ولن تكون هناك إمكانية لاسترداد النتائج لاحقا.

تنزيل نتائج غير متزامنة

عندما يصدر طلب استجابة 202 Accepted، تتم معالجة الطلب باستخدام البنية الأساسية لبرنامج ربط العمليات التجارية غير المتزامنة. سيتم منحك عنوان URL للتحقق من تقدم طلبك غير المتزامن في عنوان الموقع للاستجابة. يبدو عنوان URI للحالة هذا كما يلي:

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

سيعيد عنوان URL الذي يوفره عنوان الموقع الاستجابات التالية عند إصدار طلب GET.

HTTP 202 Accepted - تم قبول طلب المصفوفة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

HTTP 200 OK - تمت معالجة طلب المصفوفة بنجاح. يحتوي نص الاستجابة على جميع النتائج.
RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

Post Route Matrix Sync API هو طلب POST HTTP يسمح بحساب مصفوفة من ملخصات المسار لمجموعة من المسارات المحددة بواسطة مواقع الأصل والوجهة باستخدام طلب (مزامنة) واحد متزامن. لإجراء طلب غير متزامن (غير متزامن)، راجع Post Route Matrix. لكل أصل معين، تحسب الخدمة تكلفة التوجيه من هذا الأصل إلى كل وجهة معينة. يمكن اعتبار مجموعة الأصول ومجموعة الوجهات كرؤوس أعمدة وصف لجدول وتحتوي كل خلية في الجدول على تكاليف التوجيه من الأصل إلى الوجهة لتلك الخلية. على سبيل المثال، لنفترض أن شركة توصيل الأغذية لديها 20 سائقا ويحتاجون إلى العثور على أقرب سائق لالتقاط التسليم من المطعم. لحل حالة الاستخدام هذه، يمكنهم استدعاء واجهة برمجة تطبيقات مسار المصفوفة.

لكل مسار، يتم إرجاع أوقات السفر والمسافات. يمكنك استخدام التكاليف المحسوبة لتحديد المسارات التفصيلية التي يجب حسابها باستخدام واجهة برمجة تطبيقات توجيه التوجيهات.

الحد الأقصى لحجم مصفوفة الطلب غير المتزامن هو 700 ولطلب المزامنة 100 (عدد الأصول مضروبا في عدد الوجهات).

إرسال طلب مصفوفة توجيه متزامن

إذا كان السيناريو الخاص بك يتطلب طلبات متزامنة وكان الحد الأقصى لحجم المصفوفة أقل من أو يساوي 100، فقد تحتاج إلى تقديم طلب متزامن. الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 100 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 10x10، 6x8، 9x8 (لا تحتاج إلى أن تكون مربعة).

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

إرسال طلب مصفوفة مسار غير متزامن

واجهة برمجة التطبيقات غير المتزامنة مناسبة لمعالجة كميات كبيرة من طلبات التوجيه المعقدة نسبيا. عند تقديم طلب باستخدام طلب غير متزامن، تقوم الخدمة بشكل افتراضي بإرجاع رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. إذا تم تعيين المعلمة waitForResults في الطلب إلى true، فسيحصل المستخدم على استجابة 200 إذا تم الانتهاء من الطلب أقل من 120 ثانية.

الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 700 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 50x10، 10x10، 28x25. 10x70 (لا يلزم أن يكون مربعا).

يتم تخزين الاستجابات غير المتزامنة لمدة 24 ساعة. يقوم عنوان URL لإعادة التوجيه بإرجاع استجابة 404 إذا تم استخدامها بعد فترة انتهاء الصلاحية.

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

فيما يلي تسلسل نموذجي للعمليات غير المتزامنة:

  1. يرسل العميل طلب Route Matrix POST إلى خرائط Azure

  2. سيستجيب الخادم بأحد الإجراءات التالية:

    HTTP 202 Accepted - تم قبول طلب مصفوفة التوجيه.

    HTTP Error - حدث خطأ أثناء معالجة طلب مصفوفة التوجيه. قد يكون هذا إما طلب غير صحيح 400 أو أي رمز حالة خطأ آخر.

  3. إذا تم قبول طلب مسار المصفوفة بنجاح، يحتوي عنوان الموقع في الاستجابة على عنوان URL لتنزيل نتائج الطلب. يبدو عنوان URI للحالة هذا كما يلي:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. يصدر العميل طلب GET على عنوان URL للتنزيل الذي تم الحصول عليه في الخطوة 3 لتنزيل النتائج

تنزيل نتائج المزامنة

عند إجراء طلب POST لواجهة برمجة تطبيقات مزامنة مصفوفة التوجيه، تقوم الخدمة بإرجاع رمز استجابة 200 لطلب ناجح وصفيف استجابة. سيحتوي نص الاستجابة على البيانات ولن تكون هناك إمكانية لاسترداد النتائج لاحقا.

تنزيل نتائج غير متزامنة

عندما يصدر طلب استجابة 202 Accepted، تتم معالجة الطلب باستخدام البنية الأساسية لبرنامج ربط العمليات التجارية غير المتزامنة. سيتم منحك عنوان URL للتحقق من تقدم طلبك غير المتزامن في عنوان الموقع للاستجابة. يبدو عنوان URI للحالة هذا كما يلي:

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

سيعيد عنوان URL الذي يوفره عنوان الموقع الاستجابات التالية عند إصدار طلب GET.

HTTP 202 Accepted - تم قبول طلب المصفوفة ولكن لا يزال تتم معالجته. الرجاء المحاولة مرة أخرى في بعض الوقت.

HTTP 200 OK - تمت معالجة طلب المصفوفة بنجاح. يحتوي نص الاستجابة على جميع النتائج.
RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

تحتوي أقسام المسار على معلومات إضافية حول أجزاء من المسار. يحتوي كل قسم على الأقل على العناصر startPointIndexendPointIndexsectionType.
RouteSectionTecCauseOutput

سبب حدث نسبة استخدام الشبكة. يمكن أن يحتوي على عناصر mainCauseCode و subCauseCode. يمكن استخدامها لتعريف الأيقونات والأوصاف.
RouteSectionTecOutput

تفاصيل حدث حركة المرور، باستخدام التعريفات في معيار TPEG2-TEC. يمكن أن يحتوي على effectCode وعناصر الأسباب.
RouteSummaryOutput

كائن الملخص
Routes
SimplePollerLike

استقصاء بسيط يمكن استخدامه لاستقصاء عملية طويلة الأمد.

النوع أسماء مستعارة

GeoJsonGeometry

عنصر هندسي GeoJSON صالح. يجب أن يكون النوع أحد أنواع هندسة GeoJSON السبعة الصالحة - Point و MultiPoint و LineString و MultiLineString و Polygon و MultiPolygon و GeometryCollection. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
GeoJsonObject

كائن GeoJSON صالح. يرجى الرجوع إلى RFC 7946 للحصول على التفاصيل.
MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

الوظائف

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

إنشاء نص طلب دفعي لمجموعة من طلبات توجيه المسار.
default(AzureKeyCredential, ClientOptions)

إنشاء مثيل MapsRouteClient من مفتاح اشتراك.

مثال

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

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

إنشاء مثيل MapsRoute من Azure Identity TokenCredential.

مثال

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

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

إنشاء مثيل MapsRoute من Azure Identity AzureSASCredential.

مثال

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

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

دالة المساعد التي تنشئ كائن Poller للمساعدة في التحقق من عملية طويلة الأمد.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

تحويل صفيف من [خط العرض، Longtitute] إلى سلسلة بالتنسيق التالي: "Latitude_1،Longtitute_1:Latitude_2،Longtitute_2:..."

تفاصيل الوظيفة

buildMultiCollection(string[], string) 

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

المعلمات

items

string[]

parameterName

string

المرتجعات

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

إنشاء نص طلب دفعي لمجموعة من طلبات توجيه المسار.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

المعلمات

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

كائن معلمات الاستعلام لطلب اتجاه المسار

المرتجعات

BatchRequest

طلب الدفعة المكونة.

default(AzureKeyCredential, ClientOptions)

إنشاء مثيل MapsRouteClient من مفتاح اشتراك.

مثال

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

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

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

المعلمات

credential
AzureKeyCredential

مثيل AzureKeyCredential يستخدم لمصادقة الطلبات إلى الخدمة

options
ClientOptions

الخيارات المستخدمة لتكوين عميل المسار

المرتجعات

MapsRouteClient

default(TokenCredential, string, ClientOptions)

إنشاء مثيل MapsRoute من Azure Identity TokenCredential.

مثال

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

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

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

المعلمات

credential
TokenCredential

مثيل TokenCredential يستخدم لمصادقة الطلبات إلى الخدمة

mapsAccountClientId

string

معرف عميل خرائط Azure لمورد خريطة معين

options
ClientOptions

الخيارات المستخدمة لتكوين عميل المسار

المرتجعات

MapsRouteClient

default(AzureSASCredential, ClientOptions)

إنشاء مثيل MapsRoute من Azure Identity AzureSASCredential.

مثال

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

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

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

المعلمات

credential
AzureSASCredential

مثيل AzureSASCredential يستخدم لمصادقة الطلبات إلى الخدمة

options
ClientOptions

الخيارات المستخدمة لتكوين عميل المسار

المرتجعات

MapsRouteClient

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

دالة المساعد التي تنشئ كائن Poller للمساعدة في التحقق من عملية طويلة الأمد.

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

المعلمات

client
Client

العميل لاستخدامه لإرسال الطلب للحصول على صفحات إضافية.

initialResponse

TResult

الاستجابة الأولية.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

خيارات لتعيين حالة استئناف أو فاصل زمني مخصص للاستقصاء.

المرتجعات

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

  • كائن الاستقصاء للاستقصاء عن تحديثات حالة العملية والحصول في النهاية على الاستجابة النهائية.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse) 

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

المعلمات

response

RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse

المرتجعات

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

المعلمات

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

المرتجعات

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

المعلمات

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

المرتجعات

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

المعلمات

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

المرتجعات

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

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

المعلمات

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

المرتجعات

response

toColonDelimitedLatLonString(LatLon[])

تحويل صفيف من [خط العرض، Longtitute] إلى سلسلة بالتنسيق التالي: "Latitude_1،Longtitute_1:Latitude_2،Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

المعلمات

coordinates

LatLon[]

صفيف من زوج خط العرض/Longtitute للتحويل.

المرتجعات

string

السلسلة المحولة.