مستندات ساده و کاربردی جهت ارسال دستورالعملهای درمانی و یادآورهای روزانه به اپلیکیشن بیماران
برای اینکه مشخص شود این توصیه درمانی برای چه کسی ثبت میشود، کافی است تنها یکی از سه کلید زیر را در ارسال اطلاعات قرار دهید:
یک نمونه کامل و استاندارد از ساختار اطلاعات ارسالی به صورت زیر است:
{
"mobile": "09129999999",
"startDate": "2026-08-01",
"endDate": "2026-08-05",
"task": {
"name": "مصرف قرص متفورمین",
"text": "لطفاً بعد از وعده ناهار همراه با یک لیوان آب کامل مصرف شود.",
"actionText": "مشاهده مقاله درمانی",
"actionType": "link",
"action": "https://liom.app/articles/",
"exclude": ["pms", "period"]
}
}
| نام فیلد | نوع داده | وضعیت ارسال | توضیحات ساده |
|---|---|---|---|
| mobile | متن (String) | یکی از این ۳ کلید | شماره همراه بیمار جهت یافتن حساب کاربری. |
| username | متن (String) | یکی از این ۳ کلید | نام کاربری ثبتشده بیمار در سیستم. |
| متن (String) | یکی از این ۳ کلید | ایمیل اختصاصی بیمار در سامانه. | |
| startDate | تاریخ میلادی | الزامی | تاریخ شروع اجرای دستورالعمل (مثلاً: 2026-08-01). |
| endDate | تاریخ میلادی | الزامی | تاریخ پایان اجرای دستورالعمل (مثلاً: 2026-08-05). |
| task.name | متن (String) | الزامی | عنوان کوتاه برنامه (مثل: مصرف قرص، انجام ورزش). |
| task.text | متن (String) | الزامی | توضیحات کامل و راهنمای درمانی برای بیمار. |
| task.actionText | متن (String) | اختیاری | عنوان دکمه راهنما در اپلیکیشن بیمار. |
| task.actionType | متن (String) | اختیاری | نوع عملکرد دکمه (همیشه مقدار "link" قرار گیرد). |
| task.action | متن (آدرس وب) | اختیاری | لینک وبسایت یا لینک خارجی آموزشی. |
| task.exclude | لیستی از متن | اختیاری | عدم نمایش در روزهای خاص. مقادیر مجاز: ["pms"] و ["period"]. |
در صورت ثبت موفق، لیستی از کدهای پیگیری مربوط به روزهای ثبتشده بازگردانده میشود:
{
"success": true,
"result": [
"task_id_day1",
"task_id_day2",
"task_id_day3"
]
}
در صورتی که مشکلی در ثبت اطلاعات (مانند عدم ارسال فیلدهای الزامی یا مشخصات بیمار) وجود داشته باشد، پیغام خطایی به شکل زیر دریافت خواهید کرد:
{
"success": false,
"error": {
"code": "REST_API_USER_ADD_TASK_ERROR",
"message": "اطلاعات ورودی کامل نیست یا شناسایی بیمار انجام نشد."
}
}