رفتن به محتوا

همان قواعد نمایش پنل اعمال می‌شود: سرویس‌هایی که مدتشان کاملاً تمام شده، به‌طور پیش‌فرض پنهان‌اند. با state می‌توانید بر اساس وضعیتی که در پنل دیده می‌شود فیلتر کنید.

یک پارامتر ناشناخته یا مقدار نامعتبر 400 invalid_request برمی‌گرداند؛ details.field می‌گوید کدام پارامتر است.

نقطه پایانی فهرست آمار ندارد. چون برای هر سرویس باید به بک‌اند مراجعه شود، عمداً سبک نگه داشته شده است؛ اطلاعات مصرف را از نقطه پایانی جزئیات سرویس بگیرید.

مجوزدهی

Authorizationstringالزامی

به‌صورت Bearer <token> ارسال می‌شود. این نقطه پایانی مجوز orders:read (اطلاعات سرویس) را لازم دارد؛ توکنی که این مجوز را نداشته باشد پاسخ 403 می‌گیرد.

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

typeenum<string>

بر اساس نوع سرویس فیلتر می‌کند.

statusstring

بر اساس وضعیت خام فیلتر می‌کند.

stateenum<string>

بر اساس وضعیتی که در پنل دیده می‌شود فیلتر می‌کند. اگر expired داده شود، سرویس‌هایی که مدتشان کاملاً تمام شده نیز فهرست می‌شوند. مقادیر در صفحه وضعیت‌های سرویس آمده‌اند.

limitintegerپیش‌فرض: 25

تعداد رکورد در هر صفحه: 1 تا 100. مقدار 0، منفی یا غیرصحیح 400 برمی‌گرداند؛ مقدار بیش از 100 به 100 کاهش می‌یابد (meta.limit مقدار اعمال‌شده را نشان می‌دهد).

offsetintegerپیش‌فرض: 0

تعداد رکوردهایی که از ابتدا رد می‌شوند.

include_expiredboolean

true سرویس‌هایی را که مدتشان کاملاً تمام شده یا لغو شده‌اند نیز فهرست می‌کند. اگر status=expired یا cancelled داده شود، خودبه‌خود فعال می‌شود.

پاسخ

200
application/json
dataobject[]
metaobject