Получает информацию, которую вносят на визите в карточку “Договоренность”. Набор заполненных параметров зависит от настроек на конкретном клиенте. Для получения конкретных настроек используется метод 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_json",
"format": "json",
"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_json". |
| format | string | Да | Формат ответа - JSON |
| arguments | object | Да | Блок параметров. |
| date_from | string | Да | Дата начала формирования списка визитов (по дате начала визита). Формат YYYY-MM-DD |
| date_till | string | Да | Дата окончания формирования списка визитов (по дате завершения визита). Формат YYYY-MM-DD |
| preparation_ids | string | Нет | принимает идентификаторы препаратов из БД Proxima CRM. Для поиска информации по конкретным препаратам. Разделитель запятая. |
| brend_ids | string | Нет | Принимает идентификаторы брендов из БД Proxima CRM. Для поиска информации по конкретным препаратам. Разделитель запятая, тип string |
Успешный ответ
200 OK
Формат JSON
Пример ответа
[
{
"patalog": "Some text",
"task_id": 51970,
"brend_id": 6,
"factcount": 1,
"plancount": 1,
"potential": 1,
"preparation_id": 1
}
]| Поле | Описание |
|---|---|
| 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 | Внутренняя ошибка сервера |