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

Пошук

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_json",
  "format": "json",
  "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)
task_fact_end Фактичний час завершення візиту (UTC)
task_dist Відстань закриття візиту (у км або метрах, залежно від налаштувань)
task_gps_lng Довгота координати закриття візиту
task_gps_lat Широта координати закриття візиту

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

40x/50x

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