Отримання адреси з довідника компанії за назвою / містом / вулицею / кодом КОАТУУ¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі) |
URL запиту |
{url серверу} /api/oas/v2/company/addresses/search |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: edrpou - ЄДРПОУ компанії в довіднику якої здійснюється пошук Опціональні url-параметри: query - текст пошуку (пошук здійснюється за назвою / містом / вулицею / кодом КОАТУУ). Якщо не вказувати параметр query, то прийде список з перших 10 адрес з довідника даної компанії |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
RESPONSE
У відповідь передаються список адрес (об’єкт Address).
Таблиця 1 - Опис параметрів об’єкта Address
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Address |
||
uuid |
UUID |
ідентифікатор адреси |
name |
String |
назва адреси |
city |
String |
місто |
street |
String |
вулиця |
koatuu |
String |
код КОАТУУ |
Приклади¶
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді в json форматі:
{
приклад тимчасово відсутній
}