Перейти до основного контенту

Пошук

api_get_actions

Повертає інформацію про невізитну активність (завдання) за вказаний період. Підтримується фільтрація за 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 Так Бажаний формат відповіді
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

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 Внутрішня помилка сервера