View Categories

دریافت لیست خطا ها و راه حل ها – Get Errors

مدت زمان تخمینی مطالعه : 2 حداقل زمان مطالعه

در این بخش شما میتوانید لیست error code هایی که در api های مختلف ممکن است آنها با مواجه شوید را دریافت نمایید و راه حل های هر ارور را میتوانید مشاهده نمایید.


دریافت لیست ارور ها از طریق API: #

عنوانوضعیتمقادیرتوضیحات
MethodاجباریGETمتد ارسال درخواست
Domainاجبارینام دامنه ثبت شده در اتوماسیون
Api Urlاجباریدامنه هسته مرکزی سرویس
Api versionاجباریبه نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است.

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

سربرگ – Header #

{{Api Url}}/errors

HEADER
GET /api/reservation/{{Api version}}/errors HTTP/1.1
Host: {{Your Host}}
Content-Type: application/json
Domain: {{Your Domain}}
JSON

API Url از طریق پنل کاربری قابل مشاهده خواهد بود.

مقادیر ارسالی – Request Data #

عنواننوعوضعیتمقادیرتوضیحات
codeIntegerاختیاریerror codeدر صورت عدم ارسال این کلید لیست کل ارور ها و راه های آن برگردانده میشود.
{
    "code": error code
}
JSON

پاسخ صحیح – Response True #

هنگام ارسال کلید code جواب دریافتی به صورت زیر میباشد.

عنواننوعمقادیرتوضیحات
payload
payload.titleStringعنوان ارور
payload.solutionStringراه حل ارور مربوطه
meta
meta.timestampTimestamp  زمان تولید پاسخ  این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
دریافت این پاسخ با Status Code 200 دریافت خواهد شد.
{
    "payload": {
        "title": "",
        "solution": ""
    },
    "meta": {
        "timestamp": "Timestamp" // Timestamp
    }
}
JSON

هنگام عدم ارسال کلید code جواب دریافتی به صورت زیر میباشد.

عنواننوعمقادیرتوضیحات
itemsArray
items[index].codeIntegererror code
items[index].titleStringعنوان ارور
items[index].solutionStringراه حل ارور مربوطه
meta
meta.timestampTimestamp  زمان تولید پاسخ  این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
دریافت این پاسخ با Status Code 200 دریافت خواهد شد.
{
    "items": [
        {
            "code": error code,
            "title": "",
            "solution": ""
        },
        ...
    ],
    "meta": {
        "timestamp": "Timestamp" // Timestamp
    }
}
JSON

پاسخ نادرست – Response False #

عنواننوعمقادیرتوضیحات
error
error.codeIntegerشماره خطا مربوطهجهت استعلام خطا میتوانید از طریق این لینک اقدام کنید.
meta
meta.timestampTimestamp  زمان تولید پاسخ  این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
{
  "error": {
    "code":"Error Code"
  },
  "meta": {
    "timestamp": "Timestamp" // Timestamp
  }
}
JSON

در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نموده اید.

به‌روزرسانی در بهمن 1, 1403
Shopping Basket
خانه
وبلاگ
جست‌وجو
درخواست