وب سرویس اعضای رسمی شرکت‌ها (Company Members API)

15 مهر 1403

مستندات API

در این قسمت به بررسی وب‌سرویس اعضای رسمی شرکت‌ها (Company Members API) می‌پردازیم. این سرویس اطلاعات مربوط به افرادی را که در شرکت سمت‌های رسمی داشته‌اند، بازمی‌گرداند.

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

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

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

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

{{baseUrl}}/Company/{{CompanyId}}/People

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

{{baseUrl}}: آدرس پایه (https://api.rasm.io/API)
{{CompanyId}}: شناسه ملی شرکت (مثلاً 14009396050)

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

CompanyId: شناسه ملی شرکت که به صورت عددی وارد می‌شود. این پارامتر الزامی است.

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

curl --location --request GET 'https://api.rasm.io/API/Company/14009396050/People' \
--header 'X-Key: {{XKEY}}'

پاسخ نمونه:

در اینجا یک نمونه پاسخ برای دریافت اعضای رسمی یک شرکت آورده شده است:

[
    {
        "id": 8574554,
        "companyId": 14009396050,
        "personId": 923198891,
        "positionId": 17,
        "startDate": "2020-08-31T00:00:00",
        "endDate": "2022-08-31T00:00:00",
        "byNewsId": 15381919,
        "duration": "2",
        "person": {
            "id": 923198891,
            "title": "محمدحسین ملک نژاد یزدی",
            "gender": true,
            "tagline": "مدیرعامل رسمیو",
            "pictureUrl": "https://static.lilak.org/DefaultPerson.jpg"
        },
        "position": {
            "id": 17,
            "title": "عضو هیئت مدیره و مدیرعامل",
            "firstRole": "مدیرعامل",
            "secondRole": "عضو هیئت مدیره"
        }
    }
]

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

id: شناسه داخلی تخصیص سمت به فرد.
companyId: شناسه ملی شرکت.
personId: شناسه ملی شخص.
positionId: شناسه داخلی سمت.
startDate: تاریخ شروع سمت به فرمت YYYY-MM-DD.
endDate: تاریخ پایان سمت (در صورت موجود بودن).
byNewsId: شماره آگهی روزنامه رسمی که تعیین کننده این سمت است.
duration: مدت زمانی که فرد در این سمت فعالیت داشته است (به سال).
person: شامل اطلاعات شخص مانند نام، جنسیت، و لینک تصویر.
position: شامل اطلاعات سمت، اولین و دومین سمت فرد (در صورت وجود).

نکات مهم:

تاریخ شروع و پایان: برخی سمت‌ها ممکن است تاریخ پایان نداشته باشند، به این معنی که فرد هنوز در آن سمت فعالیت می‌کند.
اطلاعات سمت: برخی افراد ممکن است چند سمت در یک شرکت داشته باشند. در این صورت، فیلدهای firstRole و secondRole به تفکیک نمایش داده می‌شوند.

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

400 Bad Request: پارامتر ورودی شناسه ملی اشتباه است.
404 Not Found: شرکتی با شناسه ملی داده‌شده یافت نشد.
401 Unauthorized: کلید API اشتباه است یا وجود ندارد.

نتیجه‌گیری:

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