متدهای وب سرویس تقویم (بخش اول)

مدیر سایت
شهریور ۰۶, ۱۳۹۸

متدهای API تقویم فارسی (بخش اول)

در مقاله قبل به معرفی وب سرویس تقویم فارسی پرداختیم در این مقاله در مورد متدهای وب سرویس تقویم (بخش اول) توضیح میدهیم.

ای پی آی
راهنمای استفاده از ای پی آی

پایگاه داده این وب سایت از طریق این آدرس قابل دسترسی است https://farsicalendar.com/api . کاربران و برنامه نویسان عزیز میتوانند با ارسال درخواست Http GET به آدرس ذکر شده به اطلاعات موجود دسترسی پیدا کنند. کاربران میتوانند با تنظیم Content-Type هدر درخواست Http GET نتایج را به شکل فرمت های معتبر JSON , XML و … دریافت کنند.

در صورت مواجه شدن با هر گونه خطا و یا مشکل در استفاده از این سرویس میتوانید از طریق ارسال کامنت و یا ایمیل مشکل خود را مطرح کنید.

JSON

در صورت ارسال درخواست معتبر شما پاسخی با فرمت json به شکل زیر دریافت خواهید کرد:

{ “type” = “…”, values = “…” }

مثال:

{ “type” : “success”, “values” : [{“id”:188448, “type”:”SH”, “category”:”iran”, “occasion”:”روز طبیعت”}]}

و در صورت بروز خطا:

{ “type”:”failed”, “vlaues”:{“error”:”Request is invalid.”, “code”:400} }

پارامترها

پارامترهای موجود برای اعمال تنظیمات به این شکل میباشد:

api/type [required]/day [required]/month [required]/year [optional]

با مقداردهی Query String های زیر میتوانید فیلترهای مورد نظر خود را اعمال کنید:

api/type/day/month/year?category=[…]&lang=[…]&limit=[…]

مثال:

api/sh/29/12
api/ic/10/1
api/wc/26/9

جستجو به صورت همزمان:
api/sh,ic,wc/29,10,26/12,1,9

api/sh/29/12?lang=eng&limit=10
api/sh/29/12?category=iran,iran-history

همچنین میتوانید چند تاریخ را به صورت همزمان جستجو کنید. به عنوان مثال تاریخ 13 فروردین (ه ش) و 25 December (میلادی) :

api/sh,wc/13,25/1,12

انتخاب نوع تقویم

تقویم های موجود فعلی تقویم هجری شمسی و قمری و تقویم میلادی است. مقدار پیش فرض نوع تقویم SH میباشد برای انتخاب نوع تقویم به صورت زیر عمل کنید:

api/[type=…]/29/12

api/wc/13/1

api/sh/13/1

مقادیر معتبر فعلی برای type عبارت است از هجری شمسی (SH = Solar Hijri Calendar)، هجری قمری (IC = Islamic Calendar) و میلادی (WC = World Calendar).

در این مقاله در مورد متدهای وب سرویس تقویم (بخش اول) صحبت کردیم در مقاله بعد در مورد متدهای وب سرویس تقویم (بخش دوم) صحبت خواهیم کرد.

منبع

متدهای API تقویم فارسی (بخش اول)

JSON

پارامترها

انتخاب نوع تقویم

2 دیدگاه :

دیدگاهتان را بنویسید لغو پاسخ