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

Поиск

api_get_tasks_json

Получает информацию о визитах за указанный период. Поддерживается фильтрация по 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_tasks",
  "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_tasks_json".
format string Да Формат ответа - JSON
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

Формат JSON

Пример ответа
[{"task_id":48313,
      "task_datefrom":"2025-08-01T12:30:00",
      "task_datetill":"2025-08-01T13:00:00",
      "task_gmt_offset":10800,
      "task_type":"Дзвінок лікарю",
      "task_user_id":38,
      "task_user2_id":38,
      "task_company_id":41016,
      "task_contact_id":36242,
      "task_target":[
         "Rx-Сімейний лікар"
      ],
      "task_spec":"Загальна практика - сімейна медицина (поликлиника)",
      "task_taskstate":"Виконаний",
      "task_created":"2025-07-05T22:47:51",
      "task_fact_start":"2025-08-01T11:20:15",
      "task_fact_end":"2025-08-01T13:27:14",
      "task_dist":null,
      "task_gps_lng":null,
      "task_gps_lat":null}]
Поле Описание
task_id Идентификатор визита в базе данных Proxima CRM
task_datefrom Дата и время планового начала визита (UTC). Формат: YYYY-MM-DD HH:MM:SS
task_datetill Дата и время планового завершения визита (UTC). Формат: YYYY-MM-DD HH:MM:SS
task_gmt_offset Смещение от UTC в минутах
task_type Тип визита
task_user_id Идентификатор исполнителя (пользователя) из Proxima CRM
task_user2_id Идентификатор наблюдателя/подчинённого (если есть)
task_company_id Идентификатор учреждения в Proxima CRM
task_contact_id Идентификатор клиента в Proxima CRM
task_target Таргет-группа визита
task_spec Специализация клиента, указанная во время визита
task_taskstate Статус визита (например, Запланирован, Завершен, Отменен)
task_created Дата и время создания задачи (UTC). Формат: YYYY-MM-DD HH:MM:SS
task_fact_start Фактическое время начала визита (UTC). Формат: YYYY-MM-DD HH:MM:SS
task_fact_end Фактическое время завершения визита (UTC). Формат: YYYY-MM-DD HH:MM:SS
task_dist Расстояние закрытия визита (в км или метрах, в зависимости от настроек)
task_gps_lng Долгота координаты закрытия визита
task_gps_lat Широта координаты закрытия визита

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

40x/50x

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