آدرس وب سرویس:
http://api.payamak-panel.com/post/Actions.asmx برای کد نویسی دات نت
http://api.payamak-panel.com/post/Actions.asmx?wsdl برای کدنویسی php و Java
متد AddGroup؛ جهت اضافه کردن گروه جدید در دفترچه تلفن استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| GroupName | string | نام گروه موردنظر جهت اضافه شدن |
| Descriptions | string | شرح |
| Showtochilds | Bool | جهت نمایش اطلاعات گروه به کاربران زیر مجموعه true و جهت عدم نمایش false استفاده شود. |
| مقدار بازگشتی | ||
| ReturnValue | Int | ۰ : نام کاربری یا کلمه عبور وارد شده صحیح نمی باشد. ۱ : ثبت گروه موردنظر و درج در دفترچه تلفن |
متد AddContact؛ جهت اضافه کردن کاربر جدید در دفترچه تلفن استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| GroupIds | string | Id مربوط به گروهی که کاربر قرار است در آن گروه ثبت نام شود. (این کد در بخش گروه های دفترچه تلفن ، قبل از عنوان گروه درج گردیده است.) |
| FirstName | string | نام |
| LastName | string | نام خانوادگی |
| NickName | string | نام مستعار |
| Corporation | string | نام شرکت |
| MobileNumber | string | شماره موبایل |
| Phone | string | تلفن ثابت |
| Fax | string | شماره فکس |
| Birthdate | DateTime | تاریخ تولد |
| string | آدرس ایمیل | |
| Gender | Byte | جنسیت (عدد ۱ برای جنسیت مؤنث و عدد ۲ برای جنسیت مذکر استفاده شود) |
| Province | int | کد استان (کدها در وب سرویس users موجود می باشند) |
| City | int | کد شهر (کدها در وب سرویس users موجود می باشند) |
| Province | int | کد استان (کدها در وب سرویس users موجود می باشند) |
| Address | String | آدرس |
| PostalCode | String | کد پستی |
| AdditionalDate | DateTime | تاریخ مناسبت اضافی (برای خالی رها کردن از MaxValue استفاده شود) |
| AdditionalText | String | متن اضافی |
| Descriptions | String | شرح |
| مقدار بازگشتی | ||
| ReturnValue | Int | ۰ : عدم ثبت اطلاعات کاربر ۱ : ثبت اطلاعات کاربر و درج در دفترچه تلفن |
متد CheckMobileExistInContact؛ جهت بررسی موجود بودن شماره در دفترچه تلفن
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| MobileNumber | String | شماره موبایل موردنظر جهت بررسی |
| مقدار بازگشتی | ||
| ReturnValue | Int | -۱ : نام کاربری یا کلمه عبور وارد شده صحیح نمی باشد. ۰ : شماره در دفترچه تلفن موجود نمی باشد. ۱ : شماره در دفترچه تلفن موجود است. |
متد GetContacts؛ جهت دریافت اطلاعات دفترچه تلفن استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| GroupId | Int | آی دی مربوط به گروه موردنظر |
| GroupId | Int | آی دی مربوط به گروه موردنظر |
| Keyword | String | واژه یا شماره مورنظر جهت جستجو |
| From | Int | شماره ردیف |
| Count | Int | تعداد درخواستی |
| مقدار بازگشتی | ||
| ReturnValue | Gridlist[] | خروجی لیستی از کلاس contacts می باشد که اطلاعات مربوط به واژه جستجو شده را نمایش می دهد. |
متد GetGroups؛ ج جهت دریافت اطلاعات گروه ها استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| مقدار بازگشتی | ||
| ReturnValue | list[] | خروجی لیستی از کلاس Groups می باشد. |
متد ChangeContact؛ جهت ویرایش مخاطب استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| contactId | int | شناسه مخاطب مورد نظر |
| MobileNumber | string | شماره موبایل |
| FirstName | string | نام |
| LastName | string | نام خانوادگی |
| NickName | string | نام مستعار |
| Corporation | string | نام شرکت |
| Phone | string | تلفن ثابت |
| Fax | string | شماره فکس |
| Birthdate | DateTime | تاریخ تولد |
| string | آدرس ایمیل | |
| Gender | Byte | جنسیت (عدد ۱ برای جنسیت مؤنث و عدد ۲ برای جنسیت مذکر استفاده شود) |
| Province | int | کد استان (کدها در وب سرویس users موجود می باشند) |
| City | int | کد شهر (کدها در وب سرویس users موجود می باشند) |
| Address | String | آدرس |
| PostalCode | String | کد پستی |
| AdditionalText | String | متن اضافی |
| Descriptions | String | شرح |
| ContactStatuse | int | ۰ فعال ، ۱ غیر فعال - پیشنهاد می گردد این گزینه را ۱ قرار دهید که وضعیت تغییری نکند. |
| مقدار بازگشتی | ||
| ReturnValue | Int | ۱ : با موفقیت ویرایش گردید. ۰ : نام کاربری یا رمز عبور صحیح نمی باشد. |
متد RemoveContact؛ جهت حذف مخاطب استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| MobileNumber | String | شماره موبایل |
| مقدار بازگشتی | ||
| ReturnValue | Int | ۱ : با موفقیت حذف گردید. ۰ : نام کاربری یا رمز عبور صحیح نمی باشد. -۱ : شماره موبایل در دفترچه تلفن موجود نمی باشد. |
متد GetContactEvents؛ جهت دریافت اطلاعات مناسبت های فرد مورد نظر استفاده می شود.
| پارامتر های ورودی | ||
| نام پارامتر | نوع پارامتر | توضیحات |
| UserName | String | نام کاربری مربوط به حساب شما در سامانه |
| PassWord | String | کلمه عبور مربوط به حساب شما در سامانه |
| ContactId | Int | کد شخص که می توان آنرا از طریق متد GetContacts بدست آورد. |
| مقدار بازگشتی | ||
| ReturnValue | Gridlist[] | فهرست مناسبت های درج شده شخص مورد نظر |