وضعیت اشتراک در مبحث ای

سلام

 از آنجایی که اطلاع دارید، هر کسی می تونه بر روی موضوع، تگ و موارد این چنینی اشتراکی داشته باشه تا از مزایاش استفاده کرده و لذتش رو ببره. از رو برای اینکه بتونیم تصمیم بگیریم آیا از کسی اطلاعات مربوط را دوباره بگیریم یا نه، نیاز به مکانیزمی بود که بشه فهمید آیا کسی بر روی مبحث ای اشتراک داره یا نه.

بدنیا آمدن این ریسورس هم برای محقق کردن این هدف بود. البته بنظر ایراداتی دارد و درست و حسابی روش فکر نشده بود که چطور اجرا بشه. مسل اینکه کاربر مهمان رو چطور چک کنیم. . یا حتی کاربر ایوندی که ایمیل و موبایلش رو داشته باشیم هم ممکنه با ایمیل یا موبایل دیگه ای روی مبحث ای مشترک شده باشن و آیا باید دوباره فرم مربوطه براشون ظاهر شه یا چه اتفاق باید بیفته؟

به هر حال، برای فهمیدن از وضعیت اشتراک کاربری این چنین عمل می کنیم که یه درخواست SEARCH به ریسورس مربوطه، همراه به پارامتری های خاصی ارسال می کنیم:

SEARCH https://api.evand.com/subscribers

{

"email": "an email",

"mobile": "a mobile phone number"

"subscription" : "category",

"content": "1"

}

از بین پارامتر های ارسالی به سرور یکی از email و یا mobile اجباری می باشد و مابقی اختیاری خواهد بود.

توجه کنید که پارامتر با مقادیر خالی و یا null لحاظ نمی شن و از رده خارج می شن.

نکته بعدی اینکه همه‌ی پارامتر ها مثل با هم ارسال بشه، همه شون با هم لحاظ می شه و باید شخصی دقیقا با همون پارامتر ها اشتراک داشته باشه که از این موضوع مطلع شوید.

یعنی اگه فقط برای اشتراک از موبایل و یا ایمیل استفاده می کنید، هنگام جست و جو فقط یکیش رو ارسال کنید، مگر اینکه هنگام ایجاد اشترام هر دو رو با هم ارسال کرده باشید. البته این موضوه در مورد باقی پارامترها هم صدق می کنه.

مثال

• ممکنه کاربری با ایمیل husen@gmail.com بر روی هر موضوع ای اشتراک داشته و فقط می خواهیم بدونیم کسی با این ایمیل بر روی هر چی اشتراک داره یا نه. در اصل کلا می خواهیم بدونیم اشتراک داره یا نه جدای اینکه روی چه مبحث ای اشتراک داره. برای این کار پارامتر های زیر رو می فرستیم:

{

"email": "husen@gmail.com",

}

• برای اینکه از از وضعیت اشتراک کاربر husen@gmail.com بر روی نوع اشتراک ای اطلاع داشته باشیم این پارامتر ها رو می فرستیم:

{

"email": "husen@gmail.com",

"subscription" : "category",

}

منظور از نوع اشتراک همون subscription می شه که مقادیر tag, category , event, city رو شامل می شه.

• برای اطلاع از اشتراک کاربر بر موضوع X اینگونه عمل می کنیم که مقدار subscription رو category (برای موضوع) و مقدار X رو هم به عوان content ارسال می کنیم:

{

"email": "husen@gmail.com",

"subscription" : "category",

"content": "X"

}

نکته: در صورتی که با موبایل اشتراکی ایجاد شده باشه بجای email از mobile استفاده کنید.

در صورتی که دو همزمان نیاز به چک کردن باشه، که احتمال زیاد این وضعیت پیش نیاز، می تونید هر دو رو با هم ارسال کنید. هم email و mobile همزمان با هم.


خروجی

- در صورتی که جست و جو دارای نتیجه ای باشه status code برگشتی ۲۰۰ خواهد بود.
- در صورت ناموفق بودن و در صورتی که جست و جو شامل نتیجه ای نشه، status code عدد 404 خواهد بود.