مستندات استفاده از API حسابیکس

افزودن و ویرایش اطلاعات شخص

/api/person/mod/{code}


از این متد برای ویرایش اطلاعات اشخاصی که قبلا ثبت شده اند یا افزودن شخص جدید استفاده می شود. در صورتی که در پارامتر code در url فراخوانی شده کد شخص قبلی ارسال شود اطلاعات ارسالی با اطلاعات قبلی جایگزین خواهد شد و در صورت عدم ارسال پارامتر code اطلاعات به صورت جدید ذخیره خواهد شد.

نمونه پارامترهای ارسالی

{
	"accounts": [
		{
			"accountNum": "856124555",
			"bank": "بانک مهر ایران",
			"cardNum": "637691836129856",
			"shabaNum": "IR0100000000000000000"
		}
	],
	"address": "",
	"code": 0,
	"codeeghtesadi": "",
	"company": "",
	"des": "",
	"email": "",
	"fax": "",
	"keshvar": "",
	"mobile": "",
	"mobile2": "",
	"name": "",
	"nikename": "نام مستعار",
	"ostan": "",
	"postalcode": "",
	"sabt": "",
	"shahr": "",
	"shenasemeli": "",
	"tel": "",
	"types": [
		{
			"checked": false,
			"code": "customer",
			"label": "مشتری"
		},
		{
			"checked": false,
			"code": "marketer",
			"label": "بازاریاب"
		},
		{
			"checked": false,
			"code": "emplyee",
			"label": "کارمند"
		},
		{
			"checked": false,
			"code": "supplier",
			"label": "تامین‌کننده"
		},
		{
			"checked": false,
			"code": "colleague",
			"label": "همکار"
		},
		{
			"checked": false,
			"code": "salesman",
			"label": "فروشنده"
		}
	],
	"website": ""
}


  • در بخش types از پارامتر های ارسالی با تغییر checked در آن نوع شخص میتوانید شخص را در یک نوع اضافه یا حذف کنید.
  • در بخش accounts پارامتر ارسالی به صورت آرایه ای از اشیا json است و به تعداد نا محدود میتوانید حساب بانکی ارسال کنید. همچنین در مود ویرایش اگر اطلاعات حساب بانکی قبلی مجددا ارسال نشود اطلاعات قبلی به عنوان حذف شده در نظر گرفته می شود.

نمونه پاسخ :

{
	"Success": true,
	"result": 1
}


پارامتر success با مقدار true نشانگر موفقیت آمیز بودن عملیات است.در صورت خطا در عملیات این مقدار به false تغییر و در پارامتر data دلیل شکست عملیات در قالب رشته برگشت داده می شود.