Отримання даних про компанію за назвою / ІНН / ЄДРПОУ

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/oas/v2/company/search

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

query - текст пошуку (пошук здійснюється за назвою компанії, ІНН, ЄДРПОУ)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані компанії (об’єкт CompanyV2).

Таблиця 1 - Опис параметрів об’єкта CompanyV2

Параметр

Формат

Опис

Об’єкт CompanyV2

uuid

UUID

ідентифікатор компанії

name

String

назва компанії

type

int

форма власності; 1 - Юридична особа, 2 - Фізична особа

ipn

String

код ІПН

edrpou

String

код ЄДРПОУ

city

String

місто

address

String

адреса


Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)


Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}