Motoshub · REST API v1 · branch API

مرجع کامل API موتوشاب

تمام امکانات موتوشاب به‌صورت REST استاندارد — GET برای خواندن، POST ساختن، PATCH ویرایش، DELETE حذف. جایگزین کامل گیت‌وی قدیمی /mobile/services که همه‌ی عملیاتش POST بود.

Swagger تعاملی Postman Collection openapi.json

281 endpoint

55 گروه

GET 115

POST 80

PATCH 35

DELETE 51

شروع کار: ابتدا POST /v1/auth/login را فراخوانی کرده و توکن JWT دریافت کنید، سپس آن را در هدر Authorization: Bearer <token> بفرستید. در Swagger از دکمه‌ی Authorize و در Postman از متغیر {{token}} استفاده کنید. آدرس پایه‌ی تولید: https://motonext.shub.ir/api.
endpointهای جدید پس از merge برنچ API و اجرای composer dump-autoload && php motoshub api:permissions-migrate روی سرور فعال می‌شوند.

هسته و کاربران 23 endpoint

Auth 3

Verb	مسیر	شرح	پارامترها
POST	/v1/auth/login	ورود کاربر به سیستم body	—
GET	/v1/auth/me	دریافت اطلاعات کاربر جاری	—
GET	/v1/auth/permissions	دریافت دسترسی های کاربر جاری	—

Users 3

Verb	مسیر	شرح	پارامترها
GET	/v1/users	دریافت لیست کاربران (به همراه صفحه‌بندی و جستجو)	page perPage search
PATCH	/v1/users/me	ویرایش فیلدهای پروفایل کاربر جاری body	—
GET	/v1/users/{id}	دریافت پروفایل کامل یک کاربر (به همراه سوالات پروفایل)	id

User Blocks 3

Verb	مسیر	شرح	پارامترها
GET	/v1/users/blocked	دریافت لیست کاربران بلاک‌شده توسط کاربر جاری	page perPage
DELETE	/v1/users/{id}/block	آنبلاک کردن یک کاربر توسط کاربر جاری	id
POST	/v1/users/{id}/block	بلاک کردن یک کاربر توسط کاربر جاری	id

User Follows 2

Verb	مسیر	شرح	پارامترها
DELETE	/v1/users/{id}/follow	لغو دنبال کردن یک کاربر توسط کاربر جاری	id
POST	/v1/users/{id}/follow	دنبال کردن یک کاربر توسط کاربر جاری	id

Avatar 2

Verb	مسیر	شرح	پارامترها
DELETE	/v1/users/me/avatar	حذف آواتار کاربر جاری	—
POST	/v1/users/me/avatar	تغییر آواتار کاربر جاری (آپلود multipart) body	—

Sessions 3

Verb	مسیر	شرح	پارامترها
DELETE	/v1/users/me/sessions	خاتمه دادن به تمام سشن‌های دیگر کاربر جاری	—
GET	/v1/users/me/sessions	دریافت تاریخچه ورود و سشن‌های فعال کاربر جاری	page perPage
DELETE	/v1/users/me/sessions/{id}	خاتمه دادن به یک سشن کاربر جاری	id

Files 3

Verb	مسیر	شرح	پارامترها
POST	/v1/files	بارگذاری یک فایل به صورت پیوست (multipart) body	—
GET	/v1/files/config	دریافت پسوندهای مجاز و حداکثر حجم فایل برای اعتبارسنجی سمت کلاینت	—
GET	/v1/files/{uid}	دریافت اطلاعات یک پیوست بر اساس شناسه بسته (bundle)	uid

Flags 1

Verb	مسیر	شرح	پارامترها
POST	/v1/flags	گزارش (فلگ) یک محتوا توسط کاربر جاری body	—

Contact 1

Verb	مسیر	شرح	پارامترها
POST	/v1/contact	ارسال پیام تماس با ما از طرف کاربر جاری body	—

Privacy 2

Verb	مسیر	شرح	پارامترها
GET	/v1/privacy/settings	دریافت تنظیمات حریم خصوصی کاربر جاری	—
PATCH	/v1/privacy/settings	بروزرسانی تنظیمات حریم خصوصی کاربر جاری body	—

شبکه اجتماعی 54 endpoint

Feed 9

Verb	مسیر	شرح	پارامترها
GET	/v1/feed	دریافت فید خبری (داشبورد، پروفایل کاربر، گروه یا کل سایت — به همراه صفحه‌بندی)	page perPage search feedListFeedType feedListEntityId feedListStartTime
POST	/v1/feed	ارسال پست جدید روی فید (دیوار خود، دیوار کاربر دیگر یا گروه) body	—
DELETE	/v1/feed/{id}	حذف کامل یک پست از فید	id
GET	/v1/feed/{id}	دریافت اطلاعات یک پست خاص از فید خبری	id
PATCH	/v1/feed/{id}	ویرایش متن یک پست فید body	id
POST	/v1/feed/{id}/forward	بازنشر (فوروارد) یک پست فید روی دیوار کاربر(ان) یا گروه(ها) body	id
DELETE	/v1/feed/{id}/like	حذف لایک/دیس‌لایک کاربر جاری از یک پست فید	id
POST	/v1/feed/{id}/like	لایک (vote=1) یا دیس‌لایک (vote=-1) یک پست فید body	id
PATCH	/v1/feed/{id}/privacy	تغییر سطح حریم خصوصی یک پست فید body	id

Friends 5

Verb	مسیر	شرح	پارامترها
GET	/v1/friends	دریافت لیست دوستان کاربر جاری (به همراه صفحه‌بندی)	page perPage friendListSortByCreatedAt
POST	/v1/friends	ارسال درخواست دوستی body	—
GET	/v1/friends/requests	دریافت لیست درخواست‌های دوستی دریافتی کاربر جاری	page perPage friendListSortByCreatedAt
DELETE	/v1/friends/{id}	حذف دوست یا لغو/رد درخواست دوستی	id
POST	/v1/friends/{id}/accept	تایید درخواست دوستی دریافتی	id

Groups 15

Verb	مسیر	شرح	پارامترها
GET	/v1/groups	دریافت لیست گروه‌ها (به همراه صفحه‌بندی)	page perPage search groupListMy groupListUserUsername groupListMemberId
POST	/v1/groups	ایجاد گروه جدید body	—
DELETE	/v1/groups/files/{fileId}	حذف فایل گروه	fileId
POST	/v1/groups/invites/accept	پذیرش دعوت‌نامه گروه body	—
DELETE	/v1/groups/{id}	حذف کامل گروه	id
GET	/v1/groups/{id}	دریافت اطلاعات یک گروه خاص	id
PATCH	/v1/groups/{id}	ویرایش اطلاعات گروه body	id
GET	/v1/groups/{id}/files	دریافت لیست فایل‌های یک گروه (به همراه صفحه‌بندی)	id page perPage search groupFileListSortByCreatedAt
POST	/v1/groups/{id}/files	بارگذاری فایل جدید در گروه body	id
POST	/v1/groups/{id}/invites	دعوت کاربر به گروه body	id
DELETE	/v1/groups/{id}/join	خروج از گروه	id
POST	/v1/groups/{id}/join	عضویت در گروه	id
POST	/v1/groups/{id}/managers	افزودن مدیر به گروه body	id
DELETE	/v1/groups/{id}/managers/{userId}	حذف مدیر گروه	id userId
GET	/v1/groups/{id}/members	دریافت لیست اعضای یک گروه (به همراه صفحه‌بندی)	id page perPage groupMemberListSortByJoinedAt

Mailbox 13

Verb	مسیر	شرح	پارامترها
GET	/v1/conversations	دریافت لیست گفتگوهای کاربر جاری (به همراه صفحه‌بندی)	page perPage conversationListMode conversationListSortByLastMessageAt
GET	/v1/conversations/forward-targets	دریافت لیست کاربران قابل انتخاب برای هدایت پیام (طرف‌های گفتگو + دوستان)	page perPage
GET	/v1/conversations/search	جستجو در پیام‌های گفتگوها (کل گفتگوها یا محدود به یک گفتگو)	page perPage conversationSearchQuery conversationSearchConversationId conversationSearchOpponentId
DELETE	/v1/conversations/{id}	پاک کردن گفتگو برای کاربر جاری (تاریخچه سمت مقابل حفظ می‌شود)	id
GET	/v1/conversations/{id}	دریافت یک گفتگو به همراه پیام‌های آن (خواندن گفتگو پیام‌های خوانده‌نشده را خوانده‌شده می‌کند)	id page perPage conversationShowBeforeId
GET	/v1/conversations/{id}/media	دریافت رسانه‌های (پیوست‌های) یک گفتگو با فیلتر اختیاری photo \| video	id page perPage conversationMediaType
POST	/v1/conversations/{id}/mute	بی‌صدا کردن گفتگو برای کاربر جاری	id
POST	/v1/conversations/{id}/read	علامت‌گذاری همه پیام‌های خوانده‌نشده گفتگو به عنوان خوانده‌شده	id
POST	/v1/conversations/{id}/unmute	باصدا کردن (خروج از حالت بی‌صدا) گفتگو برای کاربر جاری	id
POST	/v1/messages	ارسال پیام جدید به یک کاربر (opponent_id) یا گفتگوی موجود (conversation_id) body	—
DELETE	/v1/messages/{id}	حذف یکی از پیام‌های کاربر جاری	id
PATCH	/v1/messages/{id}	ویرایش متن یکی از پیام‌های کاربر جاری body	id
POST	/v1/messages/{id}/forward	هدایت (forward) یک پیام به یک یا چند کاربر دیگر body	id

Notifications 5

Verb	مسیر	شرح	پارامترها
GET	/v1/notifications	دریافت لیست اعلان‌های کاربر جاری (به همراه صفحه‌بندی)	page perPage notificationListViewed notificationListPluginKey notificationListSortByCreatedAt
POST	/v1/notifications/seen	علامت‌گذاری همه اعلان‌های کاربر جاری به عنوان دیده‌شده	—
GET	/v1/notifications/settings	دریافت تنظیمات اعلان‌های کاربر جاری	—
PATCH	/v1/notifications/settings	بروزرسانی تنظیمات اعلان‌های کاربر جاری body	—
POST	/v1/notifications/{id}/read	علامت‌گذاری یک اعلان مشخص به عنوان خوانده‌شده	id

Comments 5

Verb	مسیر	شرح	پارامترها
GET	/v1/comments	دریافت لیست نظرات یک محتوا (به همراه صفحه‌بندی)	page perPage commentListEntityType commentListEntityId commentListSortByCreatedAt
POST	/v1/comments	ثبت نظر جدید روی یک محتوا body	—
DELETE	/v1/comments/{id}	حذف یک نظر	id
DELETE	/v1/comments/{id}/like	حذف پسند از یک نظر	id
POST	/v1/comments/{id}/like	ثبت پسند برای یک نظر	id

Mentions 1

Verb	مسیر	شرح	پارامترها
GET	/v1/mentions/suggestions	پیشنهاد کاربران قابل منشن برای کاربر جاری (دوستان و اعضای گروه)	search mentionSuggestionContext

Search 1

Verb	مسیر	شرح	پارامترها
GET	/v1/search	جستجوی سراسری (کاربران و پست‌های خوراک) به همراه صفحه‌بندی	search searchListType page perPage

محتوا 67 endpoint

Blogs 5

Verb	مسیر	شرح	پارامترها
GET	/v1/blogs	دریافت لیست وبلاگ‌ها (به همراه صفحه‌بندی)	page perPage search blogListAuthorUsername blogListSortByCreatedAt
POST	/v1/blogs	ایجاد وبلاگ جدید body	—
DELETE	/v1/blogs/{id}	حذف کامل وبلاگ	id
GET	/v1/blogs/{id}	دریافت اطلاعات یک وبلاگ خاص	id
PATCH	/v1/blogs/{id}	ویرایش اطلاعات وبلاگ body	id

News 5

Verb	مسیر	شرح	پارامترها
GET	/v1/news	دریافت لیست اخبار	page perPage search newsListAuthorUsername newsListSortByCreatedAt
POST	/v1/news	ایجاد خبر جدید body	—
DELETE	/v1/news/{id}	حذف کامل خبر	id
GET	/v1/news/{id}	دریافت اطلاعات یک خبر خاص	id
PATCH	/v1/news/{id}	ویرایش اطلاعات خبر body	id

Photos 5

Verb	مسیر	شرح	پارامترها
GET	/v1/photos	دریافت لیست عکس‌ها	page perPage search photoListAlbumId photoListUserId photoListUserUsername
POST	/v1/photos	آپلود عکس جدید body	—
DELETE	/v1/photos/{id}	حذف کامل عکس	id
GET	/v1/photos/{id}	دریافت اطلاعات یک عکس خاص	id
PATCH	/v1/photos/{id}	ویرایش اطلاعات عکس body	id

Albums 6

Verb	مسیر	شرح	پارامترها
GET	/v1/albums	دریافت لیست آلبوم‌ها	page perPage search albumListUserId albumListUserUsername albumListSortByCreatedAt
POST	/v1/albums	ایجاد آلبوم جدید body	—
DELETE	/v1/albums/{id}	حذف کامل آلبوم	id
GET	/v1/albums/{id}	دریافت اطلاعات یک آلبوم خاص	id
PATCH	/v1/albums/{id}	ویرایش اطلاعات آلبوم body	id
GET	/v1/albums/{id}/photos	دریافت عکس‌های یک آلبوم	id page perPage

Videos 5

Verb	مسیر	شرح	پارامترها
GET	/v1/videos	دریافت لیست ویدیوها (به همراه صفحه‌بندی)	page perPage search videoListUserId videoListUserUsername videoListSortByCreatedAt
POST	/v1/videos	افزودن ویدیو جدید body	—
DELETE	/v1/videos/{id}	حذف کامل ویدیو	id
GET	/v1/videos/{id}	دریافت اطلاعات یک ویدیو خاص	id
PATCH	/v1/videos/{id}	ویرایش اطلاعات ویدیو body	id

Events 14

Verb	مسیر	شرح	پارامترها
GET	/v1/events	دریافت لیست رویدادها (به همراه صفحه‌بندی)	page perPage search eventListUserUsername eventListSortByCreatedAt
POST	/v1/events	ایجاد رویداد جدید body	—
DELETE	/v1/events/{id}	حذف کامل رویداد	id
GET	/v1/events/{id}	دریافت اطلاعات یک رویداد خاص	id
PATCH	/v1/events/{id}	ویرایش اطلاعات رویداد body	id
PATCH	/v1/events/{id}/attendance	تغییر وضعیت حضور در رویداد body	id
POST	/v1/events/{id}/files	افزودن فایل به رویداد (multipart) body	id
DELETE	/v1/events/{id}/files/{fileId}	حذف فایل رویداد	id fileId
GET	/v1/events/{id}/invitable-users	لیست کاربران قابل‌دعوت به رویداد	id page perPage search
DELETE	/v1/events/{id}/invites	رد/لغو دعوت رویداد برای کاربر جاری	id
POST	/v1/events/{id}/invites	دعوت کاربر به رویداد body	id
POST	/v1/events/{id}/invites/accept	پذیرش دعوت رویداد	id
DELETE	/v1/events/{id}/join	خروج از رویداد (مالک = حذف کل رویداد)	id
POST	/v1/events/{id}/join	عضویت در رویداد	id

Forum 11

Verb	مسیر	شرح	پارامترها
DELETE	/v1/forum/posts/{id}	حذف یک پاسخ	id
PATCH	/v1/forum/posts/{id}	ویرایش یک پاسخ body	id
GET	/v1/forum/topics	دریافت لیست موضوعات انجمن (به همراه صفحه‌بندی)	page perPage search topicListGroupId topicListUserUsername topicListSortByCreatedAt
POST	/v1/forum/topics	ایجاد موضوع جدید body	—
DELETE	/v1/forum/topics/{id}	حذف کامل موضوع	id
GET	/v1/forum/topics/{id}	دریافت اطلاعات یک موضوع خاص	id
PATCH	/v1/forum/topics/{id}	ویرایش اطلاعات موضوع body	id
POST	/v1/forum/topics/{id}/lock	قفل کردن موضوع	id
POST	/v1/forum/topics/{id}/unlock	باز کردن قفل موضوع	id
GET	/v1/forum/topics/{topicId}/posts	دریافت لیست پاسخ‌های یک موضوع (به همراه صفحه‌بندی)	topicId page perPage search postListSortByCreatedAt
POST	/v1/forum/topics/{topicId}/posts	ارسال پاسخ جدید در یک موضوع body	topicId

Polls 6

Verb	مسیر	شرح	پارامترها
GET	/v1/polls	دریافت لیست نظرسنجی‌ها (به همراه صفحه‌بندی)	page perPage search pollListOwnerUsername pollListSortByCreatedAt
POST	/v1/polls	ایجاد نظرسنجی جدید body	—
DELETE	/v1/polls/{id}	حذف کامل نظرسنجی	id
GET	/v1/polls/{id}	دریافت اطلاعات یک نظرسنجی خاص	id
PATCH	/v1/polls/{id}	ویرایش تنظیمات نظرسنجی body	id
POST	/v1/polls/{id}/vote	ثبت یا حذف رأی برای یک گزینه نظرسنجی body	id

LandingPages 5

Verb	مسیر	شرح	پارامترها
GET	/v1/landing-pages	دریافت لیست صفحات فرود (به همراه صفحه‌بندی)	page perPage search landingPageListIsActive landingPageListAdminId landingPageListSortByCreatedAt
POST	/v1/landing-pages	ایجاد صفحه فرود جدید body	—
DELETE	/v1/landing-pages/{id}	حذف کامل صفحه فرود	id
GET	/v1/landing-pages/{id}	دریافت اطلاعات یک صفحه فرود خاص	id
PATCH	/v1/landing-pages/{id}	ویرایش اطلاعات صفحه فرود body	id

LandingSections 5

Verb	مسیر	شرح	پارامترها
GET	/v1/landing-pages/{id}/sections	دریافت لیست بخش‌های یک صفحه فرود	id
POST	/v1/landing-pages/{id}/sections	ایجاد بخش جدید برای صفحه فرود body	id
DELETE	/v1/landing-sections/{id}	حذف کامل بخش صفحه فرود	id
GET	/v1/landing-sections/{id}	دریافت اطلاعات یک بخش صفحه فرود خاص	id
PATCH	/v1/landing-sections/{id}	ویرایش اطلاعات بخش صفحه فرود body	id

آزمون و داوری 55 endpoint

Quizzes 5

Verb	مسیر	شرح	پارامترها
GET	/v1/quizzes	دریافت لیست آزمون‌ها / نظرسنجی‌ها (به همراه صفحه‌بندی)	page perPage search quizListType quizListSortByCreatedAt
POST	/v1/quizzes	ایجاد آزمون / نظرسنجی جدید body	—
DELETE	/v1/quizzes/{id}	حذف کامل آزمون به همراه پرسش‌ها، شرکت‌کنندگان و داوری‌های آن	id
GET	/v1/quizzes/{id}	دریافت اطلاعات یک آزمون خاص به همراه پرسش‌های آن	id
PATCH	/v1/quizzes/{id}	ویرایش اطلاعات آزمون body	id

Quiz Questions 4

Verb	مسیر	شرح	پارامترها
DELETE	/v1/quiz-questions/{id}	حذف یک پرسش آزمون (به همراه اصلاح زنجیره ترتیب پرسش‌ها)	id
PATCH	/v1/quiz-questions/{id}	ویرایش یک پرسش آزمون body	id
GET	/v1/quizzes/{id}/questions	دریافت لیست مرتب پرسش‌های یک آزمون	id quizQuestionListParticipantId
POST	/v1/quizzes/{id}/questions	افزودن پرسش جدید به یک آزمون body	id

Quiz Submissions 4

Verb	مسیر	شرح	پارامترها
GET	/v1/quizzes/{id}/statistics	دریافت آمار تجمیعی یک آزمون (تعداد شرکت‌کنندگان، میانگین زمان پاسخ و شمارش آرا)	id
GET	/v1/quizzes/{id}/submissions	دریافت لیست شرکت‌های کاربر جاری در یک آزمون (به همراه صفحه‌بندی)	id page perPage
POST	/v1/quizzes/{id}/submissions	شرکت در آزمون: شروع (یا ادامه) شرکت، ثبت پاسخ‌های ارسالی و در صورت درخواست اتمام آزمون body	id
GET	/v1/submissions/{id}	دریافت اطلاعات یک شرکت در آزمون به همراه پاسخ‌های ثبت‌شده	id

Judgements 4

Verb	مسیر	شرح	پارامترها
GET	/v1/judgements	دریافت لیست داوری‌ها (به همراه صفحه‌بندی و انتساب داور جاری)	page perPage judgementListQuizId judgementListStep judgementListType judgementListDone
GET	/v1/judgements/{id}	دریافت اطلاعات یک داوری به همراه معیارهای مرتب آن و پاسخ‌های داور جاری	id
GET	/v1/judgements/{id}/scores	دریافت لیست امتیازهای ثبت‌شده داور جاری برای انتساب خود در یک داوری	id
POST	/v1/judgements/{id}/scores	ثبت (یا بروزرسانی) امتیاز داور جاری برای یک معیار داوری body	id

Challenges 4

Verb	مسیر	شرح	پارامترها
GET	/v1/challenge-scores	دریافت جدول امتیازات کلی کاربران در مسابقات (به همراه صفحه‌بندی)	page perPage
GET	/v1/challenges	دریافت لیست مسابقات تعاملی کاربران (به همراه صفحه‌بندی)	page perPage search challengeListType challengeListStatus challengeListMinPoint
GET	/v1/challenges/{id}	دریافت اطلاعات یک مسابقه به همراه بیشترین امتیاز قابل کسب	id
GET	/v1/challenges/{id}/questions	دریافت دفترچه پرسش‌های یک مسابقه به همراه پاسخ‌های کاربر جاری	id

Solitary Challenges 6

Verb	مسیر	شرح	پارامترها
GET	/v1/solitary-challenges	دریافت لیست مسابقات انفرادی کاربر جاری یا دعوت‌های باز (به همراه صفحه‌بندی)	page perPage solitaryChallengeListScope
POST	/v1/solitary-challenges	ایجاد مسابقه انفرادی (در صورت وجود مسابقه باز منطبق، به آن پیوسته می‌شود) body	—
DELETE	/v1/solitary-challenges/{id}	انصراف کاربر جاری از یک مسابقه انفرادی در جریان	id
GET	/v1/solitary-challenges/{id}	دریافت وضعیت یک مسابقه انفرادی به همراه پرسش جاری و امتیاز طرفین	id
POST	/v1/solitary-challenges/{id}/answers	ثبت پاسخ کاربر جاری به پرسش جاری یک مسابقه انفرادی body	id
POST	/v1/solitary-challenges/{id}/participants	پیوستن کاربر جاری به یک مسابقه انفرادی باز	id

Universal Challenges 6

Verb	مسیر	شرح	پارامترها
GET	/v1/universal-challenges	دریافت لیست مسابقات عمومی (به همراه صفحه‌بندی)	page perPage universalChallengeListMine
POST	/v1/universal-challenges	ایجاد مسابقه عمومی جدید body	—
DELETE	/v1/universal-challenges/{id}	حذف یک مسابقه عمومی توسط سازنده یا مدیر	id
GET	/v1/universal-challenges/{id}	دریافت وضعیت یک مسابقه عمومی به همراه پرسش جاری، امتیاز کاربر و برنده	id
POST	/v1/universal-challenges/{id}/answers	ثبت پاسخ کاربر جاری به پرسش جاری یک مسابقه عمومی body	id
GET	/v1/universal-challenges/{id}/scores	دریافت جدول امتیازات شرکت‌کنندگان یک مسابقه عمومی	id perPage

Challenge Categories 2

Verb	مسیر	شرح	پارامترها
GET	/v1/challenge-categories	دریافت لیست دسته‌بندی‌های پرسش مسابقات (به همراه صفحه‌بندی)	page perPage
GET	/v1/challenge-categories/{id}	دریافت اطلاعات یک دسته‌بندی پرسش	id

Competitions 5

Verb	مسیر	شرح	پارامترها
GET	/v1/competitions	دریافت لیست مسابقات (به همراه صفحه‌بندی)	page perPage search competitionListType competitionListActive competitionListSortByCreatedAt
POST	/v1/competitions	ایجاد مسابقه جدید body	—
DELETE	/v1/competitions/{id}	حذف کامل مسابقه	id
GET	/v1/competitions/{id}	دریافت اطلاعات یک مسابقه خاص به همراه تعداد شرکت‌کنندگان	id
PATCH	/v1/competitions/{id}	ویرایش اطلاعات مسابقه body	id

Competition Submissions 4

Verb	مسیر	شرح	پارامترها
GET	/v1/competition-submissions/{id}	دریافت اطلاعات یک اثر ارسال شده	id
PATCH	/v1/competition-submissions/{id}	ثبت امتیاز داور برای یک اثر ارسال شده body	id
GET	/v1/competitions/{id}/submissions	دریافت لیست آثار ارسال شده به یک مسابقه (به همراه صفحه‌بندی)	id page perPage competitionSubmissionListMine
POST	/v1/competitions/{id}/submissions	ارسال (یا جایگزینی) اثر کاربر جاری در یک مسابقه از نوع submitted body	id

Evaluations 5

Verb	مسیر	شرح	پارامترها
GET	/v1/evaluations	دریافت لیست ارزیابی‌ها به همراه پیشرفت کاربر (با صفحه‌بندی)	page perPage search evaluationListUserId evaluationListSortByOrder evaluationListSortByName
POST	/v1/evaluations	ایجاد ارزیابی جدید body	—
DELETE	/v1/evaluations/{id}	حذف کامل ارزیابی	id
GET	/v1/evaluations/{id}	دریافت اطلاعات یک ارزیابی خاص	id
PATCH	/v1/evaluations/{id}	ویرایش اطلاعات ارزیابی body	id

Evaluation Criteria 6

Verb	مسیر	شرح	پارامترها
DELETE	/v1/evaluation-criteria/{id}	حذف یک شاخص ارزیابی	id
PATCH	/v1/evaluation-criteria/{id}	ویرایش یک شاخص ارزیابی body	id
GET	/v1/evaluation-criteria/{id}/options	دریافت گزینه‌های پاسخ یک شاخص ارزیابی	id
POST	/v1/evaluation-criteria/{id}/options	افزودن گزینه پاسخ جدید به یک شاخص ارزیابی body	id
GET	/v1/evaluations/{id}/criteria	دریافت شاخص‌های یک ارزیابی به همراه گزینه‌ها و پاسخ کاربر جاری	id page perPage
POST	/v1/evaluations/{id}/criteria	افزودن شاخص جدید به یک ارزیابی body	id

سازمانی و پژوهشی 56 endpoint

Grants 5

Verb	مسیر	شرح	پارامترها
GET	/v1/grants	دریافت لیست گرنت‌ها (به همراه صفحه‌بندی)	page perPage search grantListProfessor grantListCollegeAndField grantListStartedYear
POST	/v1/grants	ایجاد گرنت جدید body	—
DELETE	/v1/grants/{id}	حذف کامل گرنت	id
GET	/v1/grants/{id}	دریافت اطلاعات یک گرنت خاص	id
PATCH	/v1/grants/{id}	ویرایش اطلاعات گرنت body	id

Cfps 12

Verb	مسیر	شرح	پارامترها
GET	/v1/cfps	دریافت لیست فراخوان‌ها (به همراه صفحه‌بندی)	page perPage search cfpListUserUsername cfpListStatus cfpListWhoCanView
POST	/v1/cfps	ایجاد فراخوان جدید body	—
DELETE	/v1/cfps/{id}	حذف کامل فراخوان	id
GET	/v1/cfps/{id}	دریافت اطلاعات یک فراخوان خاص	id
PATCH	/v1/cfps/{id}	ویرایش اطلاعات فراخوان body	id
GET	/v1/cfps/{id}/applicants	دریافت لیست متقاضیان فراخوان	id page perPage cfpApplicantListStatus
POST	/v1/cfps/{id}/applicants	ثبت یک کاربر به عنوان متقاضی فراخوان (توسط مالک/مدیر) body	id
DELETE	/v1/cfps/{id}/apply	انصراف کاربر جاری از فراخوان	id
POST	/v1/cfps/{id}/apply	ثبت درخواست کاربر جاری در فراخوان body	id
GET	/v1/cfps/{id}/files	دریافت لیست فایل‌های فراخوان	id page perPage
POST	/v1/cfps/{id}/files	افزودن فایل به فراخوان (multipart) body	id
DELETE	/v1/cfps/{id}/files/{fileId}	حذف فایل پیوست فراخوان	id fileId

Tickets 12

Verb	مسیر	شرح	پارامترها
GET	/v1/ticket-categories	دریافت لیست دسته‌بندی‌های تیکت	ticketCategoryListStatus
GET	/v1/ticket-orders	دریافت لیست سفارش‌های قابل انتخاب برای تیکت	—
GET	/v1/tickets	دریافت لیست تیکت‌ها (به همراه صفحه‌بندی)	page perPage search ticketListCategoryId ticketListOrderId ticketListUserId
POST	/v1/tickets	ایجاد تیکت جدید body	—
DELETE	/v1/tickets/{id}	حذف کامل تیکت به همراه پاسخ‌ها و پیوست‌ها	id
GET	/v1/tickets/{id}	دریافت اطلاعات یک تیکت خاص	id
PATCH	/v1/tickets/{id}	ویرایش اطلاعات تیکت body	id
GET	/v1/tickets/{id}/replies	دریافت لیست پاسخ‌های یک تیکت	id page
POST	/v1/tickets/{id}/replies	ثبت پاسخ جدید برای تیکت body	id
DELETE	/v1/tickets/{id}/replies/{postId}	حذف پاسخ تیکت	id postId
PATCH	/v1/tickets/{id}/replies/{postId}	ویرایش پاسخ تیکت body	id postId
PATCH	/v1/tickets/{id}/status	قفل یا باز کردن تیکت body	id

Technologies 6

Verb	مسیر	شرح	پارامترها
GET	/v1/technologies	دریافت لیست فناوری‌ها (به همراه صفحه‌بندی)	page perPage search technologyListStatus technologyListArea technologyListTag
POST	/v1/technologies	ثبت فناوری جدید (در وضعیت غیرفعال تا تایید مدیر) body	—
DELETE	/v1/technologies/{id}	حذف کامل فناوری	id
GET	/v1/technologies/{id}	دریافت اطلاعات یک فناوری خاص	id
PATCH	/v1/technologies/{id}	ویرایش اطلاعات فناوری body	id
PATCH	/v1/technologies/{id}/status	فعال/غیرفعال کردن فناوری body	id

TechUnits 6

Verb	مسیر	شرح	پارامترها
GET	/v1/tech-units	دریافت لیست واحدهای فناور (به همراه صفحه‌بندی)	page perPage search techUnitListManager techUnitListSortByCreatedAt techUnitListSortByName
POST	/v1/tech-units	ایجاد واحد فناور جدید body	—
DELETE	/v1/tech-units/{id}	حذف کامل واحد فناور به همراه بخش‌های آن	id
GET	/v1/tech-units/{id}	دریافت اطلاعات یک واحد فناور خاص	id
PATCH	/v1/tech-units/{id}	ویرایش اطلاعات واحد فناور body	id
GET	/v1/tech-units/{id}/sections	دریافت محتوای بخش‌های یک واحد فناور	id

TechUnitSections 2

Verb	مسیر	شرح	پارامترها
GET	/v1/tech-unit-sections	دریافت فهرست بخش‌های قابل استفاده در واحدهای فناور	page perPage search techUnitSectionListRequired techUnitSectionListSortById techUnitSectionListSortByName
GET	/v1/tech-unit-sections/{section}	دریافت اطلاعات یک بخش بر اساس شناسه یا کلید آن	section

Journal Issues 5

Verb	مسیر	شرح	پارامترها
GET	/v1/journal-issues	دریافت لیست شماره‌های نشریه (به همراه صفحه‌بندی)	page perPage search issueListVolume issueListNo issueListSortByVolume
POST	/v1/journal-issues	ایجاد شماره جدید نشریه body	—
DELETE	/v1/journal-issues/{id}	حذف یک شماره نشریه	id
GET	/v1/journal-issues/{id}	دریافت اطلاعات یک شماره نشریه	id
PATCH	/v1/journal-issues/{id}	ویرایش اطلاعات یک شماره نشریه body	id

Journal Articles 8

Verb	مسیر	شرح	پارامترها
GET	/v1/journal-articles	دریافت لیست مقالات نشریه (به همراه صفحه‌بندی و جستجو در عنوان و چکیده)	page perPage search articleListIssueId articleListIsActive articleListSortByCreatedAt
DELETE	/v1/journal-articles/{id}	حذف یک مقاله به همراه نویسندگان و کلیدواژه‌های آن	id
GET	/v1/journal-articles/{id}	دریافت اطلاعات یک مقاله به همراه نویسندگان و کلیدواژه‌ها	id
PATCH	/v1/journal-articles/{id}	ویرایش یک مقاله (کلیدواژه‌ها و نویسندگان در صورت ارسال جایگزین می‌شوند) body	id
POST	/v1/journal-articles/{id}/downloads	ثبت دریافت فایل مقاله (در هر نشست تنها یک بار شمارش می‌شود)	id
POST	/v1/journal-articles/{id}/views	ثبت بازدید مقاله (در هر نشست تنها یک بار شمارش می‌شود)	id
GET	/v1/journal-issues/{id}/articles	دریافت لیست مقالات یک شماره نشریه	id page perPage search articleListIsActive
POST	/v1/journal-issues/{id}/articles	افزودن مقاله جدید به یک شماره نشریه body	id

سایر 26 endpoint

Competition Participants 4

Verb	مسیر	شرح	پارامترها
GET	/v1/competitions/{id}/groups	دریافت جدول امتیازات گروه‌های یک مسابقه (به همراه صفحه‌بندی)	id page perPage
POST	/v1/competitions/{id}/groups	ثبت (یا بروزرسانی) امتیاز یک گروه در مسابقه body	id
GET	/v1/competitions/{id}/participants	دریافت جدول امتیازات کاربران یک مسابقه (به همراه صفحه‌بندی)	id page perPage
POST	/v1/competitions/{id}/participants	ثبت (یا بروزرسانی) امتیاز یک کاربر در مسابقه body	id

Evaluation Scores 3

Verb	مسیر	شرح	پارامترها
GET	/v1/evaluation-results	دریافت درجه نهایی ارزیابی کاربر به همراه جدول سطوح الزام	evaluationResultUserId
GET	/v1/evaluations/{id}/scores	دریافت پاسخ‌های ثبت شده در یک ارزیابی (به همراه صفحه‌بندی)	id page perPage evaluationScoreListUserId
POST	/v1/evaluations/{id}/scores	ثبت (یا بروزرسانی) پاسخ کاربر جاری به یک شاخص ارزیابی body	id

Iisemployee 4

Verb	مسیر	شرح	پارامترها
GET	/v1/companies	دریافت لیست شرکت‌ها/کارفرمایان (به همراه صفحه‌بندی)	page perPage search companyListSortByName
GET	/v1/companies/me	بررسی اینکه آیا کاربر جاری یک شرکت (کارفرما) است	—
GET	/v1/employees/{userId}/employer	دریافت کارفرمای یک کاربر	userId
POST	/v1/employees/{userId}/toggle	تغییر وضعیت تایید استخدام کارمند توسط کارفرما	userId

Journal Article Authors 3

Verb	مسیر	شرح	پارامترها
GET	/v1/journal-articles/{id}/authors	دریافت لیست نویسندگان یک مقاله	id page perPage search articleAuthorListSortByName
POST	/v1/journal-articles/{id}/authors	افزودن نویسنده به یک مقاله body	id
DELETE	/v1/journal-authors/{id}	حذف یک نویسنده	id

Journal Article Keywords 3

Verb	مسیر	شرح	پارامترها
GET	/v1/journal-articles/{id}/keywords	دریافت لیست کلیدواژه‌های یک مقاله	id page perPage search articleKeywordListSortByName
POST	/v1/journal-articles/{id}/keywords	افزودن کلیدواژه به یک مقاله body	id
DELETE	/v1/journal-keywords/{id}	حذف یک کلیدواژه	id

Journal Citation Formats 4

Verb	مسیر	شرح	پارامترها
GET	/v1/journal-articles/{id}/citations	دریافت متن ارجاع‌های یک مقاله بر پایه همه قالب‌های ذخیره‌شده به همراه BibTeX	id
GET	/v1/journal-citation-formats	دریافت لیست قالب‌های ارجاع‌دهی نشریه	page perPage search citationFormatListSortByTitle
POST	/v1/journal-citation-formats	ایجاد قالب ارجاع‌دهی جدید body	—
DELETE	/v1/journal-citation-formats/{id}	حذف یک قالب ارجاع‌دهی	id

TechnologyOrders 5

Verb	مسیر	شرح	پارامترها
GET	/v1/technologies/{id}/orders	دریافت سفارش‌های ثبت‌شده برای یک فناوری	id page perPage search
POST	/v1/technologies/{id}/orders	ثبت سفارش برای یک فناوری body	id
GET	/v1/technology-orders	دریافت لیست تمام سفارش‌های فناوری (ویژه مدیران)	page perPage search technologyOrderListTechnologyId technologyOrderListSortByCreatedAt
DELETE	/v1/technology-orders/{id}	حذف سفارش فناوری	id
GET	/v1/technology-orders/{id}	دریافت اطلاعات یک سفارش خاص	id

تولیدشده از اسپک زنده‌ی سرور · Motoshub API v1 · docs.shub.ir/reports