Отримання даних компанії, співробітників, адрес з довідників сервісу «ЕТТН»¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP POST |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі) |
URL запиту |
{url серверу} /api/oas/v2/exdata |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
В цьому методі в json-тілі запиту передаються ідентифікатори компанії, співробітників, адрес у вигляді масивів. По кожному масиву ідентифікаторів здійснюється незалежний пошук даних.
RESPONSE
У відповідь передається json-тіло з даними компанії, співробітників, адрес в випадку, якщо в запиті передавався відповідний ідентифікатор (об’єкти CompanyV2, Employee, Address).
Таблиця 1 - Опис параметрів об’єкта CompanyV2
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт CompanyV2 |
||
uuid |
UUID |
ідентифікатор компанії |
name |
String |
назва компанії |
type |
int |
форма власності; 1 - Юридична особа, 2 - Фізична особа |
ipn |
String |
код ІПН |
edrpou |
String |
код ЄДРПОУ |
city |
String |
місто |
address |
String |
адреса |
Таблиця 2 - Опис параметрів об’єкта Employee
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Employee |
||
uuid |
UUID |
ідентифікатор співробітника |
userId |
long |
id користувача |
lastName |
String |
прізвище співробітника |
firstName |
String |
ім’я співробітника |
middleName |
String |
по батькові співробітника |
ipn |
long |
код ІПН співробітника |
String |
email співробітника |
|
tel |
String |
номер телефону співробітника |
identifiers |
Map<Integer, String> |
додаткові дані; контакти |
Таблиця 3 - Опис параметрів об’єкта Address
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Address |
||
uuid |
UUID |
ідентифікатор адреси |
name |
String |
назва адреси |
city |
String |
місто |
street |
String |
вулиця |
koatuu |
String |
код КОАТУУ |
Приклади¶
Приклад тіла запиту в json форматі:
{
"companies": [
"uuid1",
"uuid2"
],
"employees": [
"uuid1",
"uuid2"
],
"addresses": [
"uuid1",
"uuid2"
]
}
Приклад тіла відповіді в json форматі:
{
"companies": {
"uuid1": {
дані по компанії
}
},
"employees": {
"uuid1": {
дані по співробітнику
}
},
"addresses": {
"uuid1": {
дані по адресі
}
}
}