Опис АПІ функцій для доступу до інформації Агентства Корпоративних Новин
Загальний формат відповіді (json):{
“status”: “Error/Success/Warning”,
“statusCode”: 201,
“message”: “Повідомлення що описує помилку або попередження”,
“answer”: (структура відповіді залежить від функції. Поле может бути відсутнім, якщо функція не повертає дані)
}
statusCode - стандарт ні значення#
| status:Error | |
|---|
| 101 | Токен не знайдено або некоректний токен |
| 102 | Дія недоступна (не підключено тарифний план або недостатньо прав) |
| 103 | Некоректні значення параметрів |
| 104 | Заборонено для IP |
| 105 | Некоректний пароль\login |
| 106 | Не вистачає коштів на рахунку для виконання операції |
| 130-199 | Зарезервовано для помилок відповідних API (будуть вказані у описі API) |
| 900 | внутрішня помилка серверу |
| 901 | технічні роботи на сервері |
| status:Warning | |
|---|
| 2XX | Операцію виконано, однак є попередження. Відповідні описи кодів попереджень можуть бути надано в описі відповідних API. |
statusCode - значення специфічні для функцій АПІ#
| status:Warning | |
|---|
| 202 | Інформацію надано, але є процеси що завершилися невдало (з помилками). Незавершених процесів по цьому коду немає.Можуть повертати ф-ції getlist, getpdf |
| 203 | Код не проходить перевірку - можливо помилка вводу. Можуть повертати ф-ції person/detail/info_raw, person/detail/information, person/detail/changes |
| 204 | Дані не актуальні. Це можливо якщо дані були видалені з ЄДР. Буде показано останній стан що був в ЄДР. Дату останнього оновлення можна побачити в полі updatedDateTime. Можуть повертати ф-ції person/detail/info_raw, person/detail/information, person/detail/changes |
| 205 | Дані поставлено на оновлення або Дані оновлюються. Дату останнього оновлення можна побачити в полі updatedDateTime. Можуть повертати ф-ції person/detail/info_raw, person/detail/information |
| status:Error | |
|---|
| 131 | Не можу створити перелік - оброблено не всі коди. Можуть повертати функції /company/create_list, /company/get_list, /estate/request/getfile |
| 132 | Не заповнені рядки для пошуку. /person/search |
date - Дата передається та повертається в форматі ‘yyyy-mm-dd’datetime - Дата + час повертається у форматі 'yyyy-mm-dd hh:nn:ss.zzz' (:ss та .zzz можуть бути опущені) , передається в функції в такому ж форматі або в форматі 'yyyy-mm-dd hh:nn:ss.zzz+XX:YY' - для передачі часового поясуbool - можна передавати значення true/false; “true”/”false”; “yes”/”no”; 1/0; “1”/”0”. Повертаємо завжди Json bool (true/false). Modified at 2025-04-28 13:02:06
