مستندات

جست‌وجو در مستندات

نام اندپوینت، موضوع یا کلیدواژه را بنویسید

جزئیات خطا

پیام مربوط به یک یا چند کد خطا را دریافت کنید.

POST/Common/ErrorDetails

دسترسی نیازمند مجوز error_details

شناسه‌های خطایی را که دریافت کرده‌اید بفرستید تا پیام خوانای هر کدام را بگیرید. این اندپوینت برای تبدیل یک کد Err... ذخیره‌شده به متن، بدون نیاز به هاردکد کردن جدول خطاها، به کار می‌آید. فهرست کامل در مرجع خطاها آمده است.

پارامترهای مسیر#

ندارد.

پارامترهای کوئری#

ندارد.

پارامترهای بدنه#

نامنوعالزامیتوضیح
SessionIdstringالزامیشناسهٔ نشست شما.
ErrorIdsarray of stringالزامیکدهای خطایی که می‌خواهید پیامشان را بگیرید.

درخواست#

curl -X POST https://api.simorghapi.com/api/Common/ErrorDetails \
  -H "Content-Type: application/json" \
  -d '{
    "SessionId": "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
    "ErrorIds": ["Err0102005", "Err0101001"]
  }'
const res = await fetch("https://api.simorghapi.com/api/Common/ErrorDetails", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    SessionId: "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
    ErrorIds: ["Err0102005", "Err0101001"]
  })
});

const data = await res.json();
import requests

res = requests.post(
    "https://api.simorghapi.com/api/Common/ErrorDetails",
    json={
        "SessionId": "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
        "ErrorIds": ["Err0102005", "Err0101001"],
    },
)

data = res.json()

پاسخ#

فیلدنوعتوضیح
Successbooleanدر صورت موفقیت true.
ErrorDetailsarray of objectبرای هر شناسهٔ درخواستی یک مورد، هر کدام با Id و Message.
Errorobjectدر صورت موفقیت null.
{
  "Success": true,
  "ErrorDetails": [
    { "Id": "Err0102005", "Message": "Fare has expired or is no longer available. Please search again." },
    { "Id": "Err0101001", "Message": "Invalid session. Please create a new session." }
  ],
  "Error": null
}

خطاها#

کدمعناراه‌حل
Err0106001ErrorIds ارسال نشده یا آرایه نیست.آرایه‌ای از کدهای خطا بفرستید.
ویرایش این صفحه در گیت‌هابمشکلی دیدید؟ از پنل ← پشتیبانی خبرمان کنید.