در این بخش شما میتوانید لیست 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}}
JSONAPI Url از طریق پنل کاربری قابل مشاهده خواهد بود.
مقادیر ارسالی – Request Data #
عنوان | نوع | وضعیت | مقادیر | توضیحات |
code | Integer | اختیاری | error code | در صورت عدم ارسال این کلید لیست کل ارور ها و راه های آن برگردانده میشود. |
{
"code": error code
}
JSONپاسخ صحیح – Response True #
هنگام ارسال کلید code جواب دریافتی به صورت زیر میباشد.
عنوان | نوع | مقادیر | توضیحات |
payload | |||
payload.title | String | عنوان ارور | |
payload.solution | String | راه حل ارور مربوطه | |
meta | |||
meta.timestamp | Timestamp | زمان تولید پاسخ | این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود. |
{
"payload": {
"title": "",
"solution": ""
},
"meta": {
"timestamp": "Timestamp" // Timestamp
}
}
JSONهنگام عدم ارسال کلید code جواب دریافتی به صورت زیر میباشد.
عنوان | نوع | مقادیر | توضیحات |
items | Array | ||
items[index].code | Integer | error code | |
items[index].title | String | عنوان ارور | |
items[index].solution | String | راه حل ارور مربوطه | |
meta | |||
meta.timestamp | Timestamp | زمان تولید پاسخ | این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود. |
{
"items": [
{
"code": error code,
"title": "",
"solution": ""
},
...
],
"meta": {
"timestamp": "Timestamp" // Timestamp
}
}
JSONپاسخ نادرست – Response False #
عنوان | نوع | مقادیر | توضیحات |
error | |||
error.code | Integer | شماره خطا مربوطه | جهت استعلام خطا میتوانید از طریق این لینک اقدام کنید. |
meta | |||
meta.timestamp | Timestamp | زمان تولید پاسخ | این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود. |
{
"error": {
"code":"Error Code"
},
"meta": {
"timestamp": "Timestamp" // Timestamp
}
}
JSONدر صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نموده اید.