api_get_actions – Proxima Research

Возвращает информацию о вневизитных активностях (задачах) за указанный период. Поддерживается фильтрация по ID задач и ID пользователя.

Запрос

Endpoint

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

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

Bearer Token (обязателен)

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

Заголовки

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

Тело запроса

{
  "function": "api_get_actions",
  "format": "csv",
  "arguments": {
    "date_from": "2025-08-04",
    "date_till": "2025-08-04",
    "ids": "1,2,3,4",
    "user_id": 1
  }
}

Поле	Тип	Обязательный	Описание
function	string	Да	Название метода API. Для этого запроса используйте `"api_get_actions"`.
format	string	Да	Формат ответа - csv
arguments	object	Да	Блок параметров.
date_from	string	Да	Дата начала отчетного периода (по дате начала визита). Формат: `YYYY-MM-DD`
date_till	string	Да	Дата окончания отчетного периода (по дате завершения визита). Формат: `YYYY-MM-DD`
ids	string	Нет	Список идентификаторов НЕ визитной активности (задач) из Proxima CRM, разделённых запятыми.
user_id	integer	Нет	Идентификатор пользователя из Proxima CRM. Возвращает НЕ визитную активность для конкретного пользователя.

Успешный ответ

200 OK

Формат "csv": ответ в виде текста CSV.

Content-Type

text/plain

Пример ответа

action_id,action_name,action_datefrom,action_datetill,action_tasktype,action_user_id,action_state
1001,Internal Meeting,2025-08-04T10:00:00Z,2025-08-04T11:00:00Z,Meeting,12,Completed

Поле	Описание
action_id	Идентификатор задачи в базе данных Proxima CRM
action_name	Название или заголовок задачи
action_datefrom	Дата и время планового начала задачи (UTC). Формат: YYYY-MM-DD HH:MM:SS
action_datetill	Дата и время планового завершения задачи (UTC). Формат: YYYY-MM-DD HH:MM:SS
action_tasktype	Тип задачи (например, Встреча, Обучение, Административная работа)
action_user_id	Идентификатор пользователя, назначенного на задачу, в Proxima CRM
action_state	Статус задачи (например, Запланирована, Завершена, Отменена)

Ошибочный ответ

40x/50x

{
  "message": "string"
}

Код	Описание
400	Неверный запрос (например, отсутствуют обязательные параметры)
401	Неавторизовано (недействительный или отсутствующий токен)
500	Внутренняя ошибка сервера

Поиск