پرش به مطلب اصلی

دریافت اشخاص و مانده‌حساب

پاتریس یار اشخاصی را که در پاتریس برای مای پاتریس تعریف شده‌اند، با POST /patris-yar/mypatris/persons به سایت می‌فرستد. هر شخص با username شناخته می‌شود و سایت آن را ذخیره یا جایگزین می‌کند.

پیش‌نیازها​

Endpoint​

POST /patris-yar/mypatris/persons

هدرها​

نامنوعالزامیتوضیح
X-Payava-Keystringبلهکلید API حساب پاتریس.
Content-Typestringبلهapplication/json; charset=utf-8

پارامترها​

نامنوعالزامیتوضیح
personsarrayبلهاشخاص تغییرکرده. ممکن است خالی باشد.
deletedstring[]بلهusername اشخاصی که در پاتریس حذف شده‌اند. ممکن است خالی باشد.

فیلدهای هر شخص​

نامنوعالزامیتوضیح
usernamestringبلهنام کاربری شخص در مای پاتریس. شخص بدون username را ذخیره نکنید.
codeintegerبلهکد حساب شخص در پاتریس. صورت‌حساب با همین کد ارسال می‌شود.
namestringخیرنام شخص.
mobilestringخیرموبایل شخص.
telstringخیرتلفن ثابت.
addressstringخیرنشانی.
emailstringخیرایمیل.
rolestringخیرنقش شخص در مای پاتریس.
debtornumberبلهمانده‌حساب، به واحد پاتریس. مثبت یعنی بدهکار، منفی یعنی بستانکار، صفر یعنی بی‌حساب.
credit_limitnumberبلهسقف اعتبار، به واحد پاتریس.
is_lockbooleanبلهtrue یعنی حساب شخص در پاتریس قفل است.
national_codestringخیرکد ملی.

نمونه درخواست و پیاده‌سازی​

ارسال اشخاص
curl -X POST https://shop.example.com/patris-yar/mypatris/persons \
-H "X-Payava-Key: YOUR_API_KEY" \
-H "Content-Type: application/json; charset=utf-8" \
-d '{"persons":[{"username":"09120000000","code":101001,"name":"علی رضایی","mobile":"09120000000","tel":"","address":"","email":"","role":"","debtor":3500000,"credit_limit":10000000,"is_lock":false,"national_code":""}],"deleted":["old.customer"]}'

نمونه پاسخ موفق​

200 OK
{ "stored": 1, "deleted": 1 }

پاتریس یار مقدارهای پاسخ را نمی‌خواند. فقط موفق بودن پاسخ مهم است.

کدهای خطا​

نامنوعالزامیتوضیح
401payava_patris_unauthorized—کلید نادرست است.
400invalid_json—بدنه‌ی درخواست JSON معتبر نیست.

نکته‌ها​

  • اول deleted و بعد persons را پردازش کنید. اگر یک username در هر دو آمد، شخص باید باقی بماند.
  • username ناشناخته در deleted را بدون خطا رد کنید.
  • موبایل را پیش از ذخیره به شکل 09xxxxxxxxx یکسان کنید تا با موبایل حساب مشتری تطبیق پیدا کند.
  • کد ملی و مانده‌حساب اطلاعات حساس هستند. آن‌ها را فقط به خود شخص نشان دهید.