مستندات API – استعلام عضویت هیئت مدیره
مستندات سرویس API عضویت هیئت مدیره
Check board-of-directors API Documents
نسخه 1.1.1 - 05/01/2024
فهرست مطالب
بخش اول: فراخوانی board-of-directors
این بخش مربوط به سرویس استعلام عضویت هیئت مدیره می‌باشد.
۱. مقدمه
در سرویس استعلام عضویت هیئت مدیره یوآیدی، با ارسال کد ملی و شناسه ملی شرکت، عضویت یا عدم عضویت فرد در هیئت مدیره و نقش فرد در هیئت مدیره را دریافت کنید.
۲. استعلام استعلام عضویت هیئت مدیره یوآیدی
برای استفاده از سرویس API استعلام عضویت هیئت مدیره یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت کد ملی فرد و شناسه ملی شرکت ،نتیجه استعلام عضویت هیئت مدیره را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست استعلام عضویت هیئت مدیره
نمونه‌ی درخواست به شرح زیر است:
https://json-api.uid.ir/api/board-of-directors
Content-Type: application/json;charset=UTF-8
{
"requestContext" : {
"apiInfo" : {
"businessId" : <UID_BUSINESS_ID>,
"businessToken" : <UID_BUSINESS_TOKEN>
}
},
"nationalId" : "0123456789",
"legalId" : "14005556644"
}
۲.۲. پارامترها
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار یا BusinessID (توسط یوآیدی در اختیار شما قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار یا BusinessToken (توسط یوآیدی در اختیار شما قرار می‌گیرد) |
| nationalId | string | Required | کد ملی کاربر |
legalId | string | Required | شناسه ملی شرکت |
۳. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS.",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
},
"isMatched": true,
"positions": [
{
"positionName": "MEMBER_OF_MANAGING_BOARD",
"issueTrackingNo": "030204701538710",
"rrkNewsPaperDate": "1403/02/06",
"rrkNewsPaperNumber": "23035",
"rrkPageNumber": "74"
}
]
}
۱.۳.توضیح پارامترهای پاسخ
| Field | Type | Description |
message | string | پیام وضعیت سرویس |
isMatched | bool | وضعیت عضویت هیئت مدیره عضویت هیئت مدیره: true |
positionName | string | نقش فرد در هیئت مدیره |
issueTrackingNo | string | شماره پیگیری نقش فرد |
rrkNewsPaperDate | string | تاریخ روزنامه رسمی |
rrkNewsPaperNumber | string | شماره روزنامه رسمی |
rrkPageNumber | string | شماره صفحه |