api_get_company – Proxima Research

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

Запрос

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	Ошибка на стороне сервера

Поиск