api_get_company – Proxima Research Ukraine

Повертає перелік установ (компаній), які були відвідані хоча б один раз. Обмежень щодо періоду відвідувань немає.

Запит

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Аутентифікація

Bearer Token (обов'язковий)

Структура запиту

Заголовки

Ключ	Значення
Authorization	Bearer `<token>`
Content-Type	application/json

Тіло запиту

{
  "function": "api_get_company",
  "format": "csv",
  "arguments": {
    "ids": "1,2,3,4"
  }
}

Поле	Тип	Обов'язковий	Опис
function	string	Так	Ім’я викликаного методу. Для цього запиту — "api_get_company"
format	string	Так	Формат відповіді - csv
arguments	object	Ні	Необов’язкові аргументи, специфічні для методу
ids	string	Ні	Список ID компаній через кому. Якщо не вказано, повертаються всі відвідані компанії

Успішна відповідь

200 OK

В залежності від вказаного формату (csv) система повертає перелік відвідуваних установ у вигляді тексту

Content-Type

text/plain

Приклад відповіді

company_name,company_type,company_address,company_categ,company_categ_by_direction,company_code,company_chain,company_main,isarchive,company_isshop,company_morionid,company_region,company_city,company_phone,company_gps_lat,company_gps_lng,company_country,company_id
Health Clinic,Pharmacy,Kyiv St. 12,A,B,40112233,PharmaNet,MainCorp,No,1,AXM12345,Kyiv,Kyiv,+380441234567,50.4501,30.5234,Ukraine,1033

Поле	Опис
company_name	Назва установи
company_type	Тип установи (наприклад, аптека, клініка)
company_address	Адреса установи
company_categ	Загальна категорія установи
company_categ_by_direction	Категорія за направленням продукту
company_code	ІПН юридичної особи
company_chain	Назва аптечної/медичної мережі (якщо використовується)
comapny_main	назва головної установи
isarchive	Флаг архіву - причина архівації
company_isshop	Прапорець, що вказує, чи є точка торговою (1 = так)
company_morionid	Ідентифікатор закладу в базі Axioma
company_region	Адміністративний регіон
company_city	Місто
company_phone	Контактний номер телефону
company_gps_lat	GPS широта
company_gps_lng	GPS довгота
company_id	Внутрішній ID закладу в Proxima CRM

Помилкова відповідь

40x/50x

{
  "message": "string"
}

Код	Опис
400-499	Помилка на стороні клієнта
500-599	Помилка на стороні сервера

Пошук