api_get_arrangement – Proxima Research Ukraine

Отримує інформацію, яку вносять під час візиту в картку “Домовленість”. Набір заповнених параметрів залежить від налаштувань у конкретного клієнта. Для отримання конкретних налаштувань використовується метод api_get_entitymap.

Запит

Endpoint

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

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

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

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

Заголовки

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

Тіло запиту

{
    "function": "api_get_arrangement",
    "format": "csv",
    "arguments": {
        "date_from": "2025-08-04",
        "date_till": "2025-08-04",
        "preparation_ids": "1,2,3,4",
        "brend_ids": "1,2,3,4"
    }
}

Поле	Тип	Обов'язкове	Опис
function	string	Так	Назва методу API. Для цього запиту використовується "api_get_arrangement".
format	string	Так	Бажаний формат відповіді
arguments	object	Так	Блок параметрів.
date_from	string	Так	Дата початку формування списку візитів (по даті початку візиту). Формат YYYY-MM-DD
date_till	string	Так	Дата закінчення формування списку візитів (по даті закінчення візиту). Формат YYYY-MM-DD
preparation_ids	string	Ні	Приймає ідентифікатори препаратів з БД Proxima CRM. Для пошуку інформації щодо конкретних препаратів. Роздільник — кома
brend_ids	string	Ні	Приймає ідентифікатори брендів з БД Proxima CRM. Для пошуку інформації щодо конкретних препаратів. Роздільник — кома.

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

200 OK

Формат

Текст в форматі CSV

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

preparation_id,brend_id,potential,plancount,factcount,patalog,task_id
1,6,,2,2,,51365
13,1,1,5,5,,51365
14,4,3,5,5,,51365

Поле	Опис
preparation_id	Ідентифікатор препарату в БД Proxima CRM. Буде лише preparation_id або brend_id, залежить від налаштувань конкретного клієнта
brend_id	Ідентифікатор бренду в БД Proxima CRM. Буде лише preparation_id або brend_id, залежить від налаштувань конкретного клієнта
potential	Числові значення. Тип float. Бізнес-значення визначається згідно з налаштуваннями проєкту
plancount	Числові значення. Тип float. Бізнес-значення визначається згідно з налаштуваннями проєкту
factcount	Числові значення. Тип float. Бізнес-значення визначається згідно з налаштуваннями проєкту
patalog	Текстове значення. Назва нозології, в межах якої вказані числові значення
task_id	Ідентифікатор візиту, у якому внесли дані, у БД Proxima CRM.

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

40x/50x

{
  "message": "string"
}

Код	Значення
400	Невірний запит (наприклад, відсутні обов’язкові параметри)
401	Неавторизований доступ (недійсний або відсутній токен)
500	Внутрішня помилка сервера

Пошук