انواع داده‌ها

فرمت‌های تاریخ

API از دو فرمت تاریخ پشتیبانی می‌کند:

فرمت پاسخ خطا

تمامی خطاها در قالب زیر برمی‌گردند:

{
  "message": "پیام خطا"
}

کدهای وضعیت HTTP:

صفحه‌بندی (Pagination)

تمامی endpointهای لیست از صفحه‌بندی استفاده می‌کنند:

پارامترهای درخواست:

ساختار پاسخ:

{
  "records": [...],
  "meta": {
    "total": 150,
    "total_pages": 8,
    "current_page": 1,
    "per_page": 20,
    "from": 1,
    "to": 20
  }
}

نوع رکورد در پاسخ‌ها

بیشتر endpointها یکی از دو الگوی زیر را دنبال می‌کنند:

لیست: { "records": [ ... ], "meta": { ... } } تکی: { "record": { ... } } یا { "data": { ... } }

فیلدهای عمومی

فیلد رکورد

فیلد جستجو

بیشتر endpointهای لیست از پارامترهای جستجوی زیر پشتیبانی می‌کنند: