Көрсетілген кезең үшін визитке қатысы жоқ активтілік (тапсырмалар) туралы ақпаратты қайтарады. Тапсырма 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 | Ішкі сервер қатесі |