مستندات وب سرویس رسمیو

وب سرویس آگهی‌های مرتبط با یک شخص حقیقی (Person News API)

در این قسمت به بررسی وب‌سرویس آگهی‌های مرتبط با یک شخص حقیقی (Person News API) می‌پردازیم. این سرویس به شما امکان می‌دهد تا آگهی‌های روزنامه رسمی مرتبط با یک شخص حقیقی را که در ارتباط با شرکت‌ها منتشر شده‌اند، دریافت کنید.

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

نحوه استفاده:

روش درخواست (HTTP Method): GET

آدرس درخواست (Endpoint):

{{baseUrl}}/Person/{{PersonId}}/News

جایگزین‌های متغیرها:

  • {{baseUrl}}: آدرس پایه API (https://api.rasm.io/API)
  • {{PersonId}}: کد ملی شخص حقیقی (مثلاً 4900221112)

پارامترهای ورودی:

  • PersonId: کد ملی شخص حقیقی. این پارامتر الزامی است.

مثال درخواست:

curl --location --request GET 'https://api.rasm.io/API/Person/4900221112/News' \
--header 'X-Key: {{XKEY}}'

پاسخ نمونه:

در اینجا یک نمونه پاسخ برای دریافت آگهی‌های مرتبط با یک شخص حقیقی آورده شده است:

[
    {
        "id": 15753277,
        "title": "آگهی تغییرات شرکت صنف کفاشان تهران",
        "description": "جهت کوتاهی نمونه، متن آگهی حذف شده است",
        "companyId": 10100466802,
        "capitalTo": null,
        "newspaperDate": null,
        "newsLetterDate": "2021-04-13T00:00:00",
        "newspaperNumber": "",
        "newspaperCityType": "",
        "pageNumber": null,
        "indicatorNumber": "139930400901150465"
    },
    {
        "id": 12772398,
        "title": "آگهی تاسیس",
        "description": "جهت کوتاهی نمونه، متن آگهی حذف شده است",
        "companyId": 14005798500,
        "capitalTo": 10000000,
        "newspaperDate": "2016-05-04T00:00:00",
        "newsLetterDate": "2016-04-30T00:00:00",
        "newspaperNumber": "20727",
        "newspaperCityType": "تهران",
        "pageNumber": 1,
        "indicatorNumber": "139530400901011763"
    }
]

توضیحات فیلدهای خروجی:

  • id: شناسه داخلی تخصیص آگهی.
  • title: عنوان آگهی (مثلاً “آگهی تغییرات” یا “آگهی تاسیس”).
  • description: متن آگهی که در روزنامه رسمی منتشر شده است.
  • companyId: شناسه ملی شرکتی که آگهی مربوط به آن است.
  • capitalTo: سرمایه تغییر یافته در صورت وجود (در آگهی‌های مرتبط با تغییرات سرمایه).
  • newspaperDate: تاریخ چاپ روزنامه رسمی.
  • newsLetterDate: تاریخ نامه ثبت.
  • newspaperNumber: شماره روزنامه رسمی.
  • newspaperCityType: نوع روزنامه (تهران یا شهرستان).
  • pageNumber: شماره صفحه‌ای که آگهی در آن منتشر شده است.
  • indicatorNumber: شماره اندیکاتور یا مکانیزه آگهی.

نکات مهم:

  • دسترسی به آگهی‌های قدیمی: این سرویس تمامی آگهی‌های مرتبط با یک شخص حقیقی را بر اساس کد ملی او بازمی‌گرداند. آگهی‌های قدیمی نیز در صورتی که هنوز در سیستم موجود باشند، قابل دسترسی خواهند بود.
  • تغییرات سرمایه: در آگهی‌های تغییرات شرکت، فیلد capitalTo تغییرات در سرمایه شرکت را نشان می‌دهد. این اطلاعات برای تحلیل مالی شرکت‌ها می‌تواند مفید باشد.

خطاهای احتمالی:

  • 400 Bad Request: پارامتر ورودی کد ملی اشتباه است.
  • 404 Not Found: هیچ آگهی مرتبط با شخص حقیقی مورد نظر یافت نشد.
  • 401 Unauthorized: کلید API اشتباه است یا وجود ندارد.

نتیجه‌گیری:

در این قسمت، نحوه استفاده از وب سرویس آگهی‌های مرتبط با یک شخص حقیقی را بررسی کردیم. این سرویس به شما امکان می‌دهد تا به سرعت تمامی آگهی‌های منتشر شده در روزنامه‌های رسمی که به یک شخص حقیقی مرتبط هستند را دریافت کنید.