Skip to main content

Search

api_get_arrangement_json

Визит кезінде «Келісім» картасына енгізілген ақпаратты қайтарады.
Толтырылған параметрлер жиынтығы нақты клиенттің баптауларына байланысты.
 

Сұраныс

Endpoint

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

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

Bearer Token (міндетті)

Сұраныс құрылымы

Тақырыптар

Кілт Мән
Authorization Bearer <token>
Content-Type application/json

Сұраныс денесі

{
    "function": "api_get_arrangement_json",
    "format": "json",
    "arguments": {
        "date_from": "2025-08-04",
        "date_till": "2025-08-04",
        "preparation_ids": "1,2,3,4",
        "brend_ids": "1,2,3,4"
    }
}
Өріс Түрі Міндетті Сипаттамасы
function string Иә API әдісі — "api_get_arrangement_json".
format string Иә Жауап форматы — json.
arguments object Иә Параметрлер блогы.
date_from string Иә Визит тізімін құрастырудың басталу күні. Формат: YYYY-MM-DD.
date_till string Иә Визит тізімін құрастырудың аяқталу күні. Формат: YYYY-MM-DD.
preparation_ids string Жоқ Препарат идентификаторлары (үтірмен бөлінген).
brend_ids string Жоқ Бренд идентификаторлары (string, үтірмен бөлінген).

Сәтті жауап

200 OK

json

Жауап мысалы
[
    {
        "patalog": "Some text",
        "task_id": 51970,
        "brend_id": 6,
        "factcount": 1,
        "plancount": 1,
        "potential": 1,
        "preparation_id": 1
    }
]
Өріс Сипаттамасы
preparation_id Препарат идентификаторы (клиент баптауына қарай preparation_id немесе brend_id ғана болады).
brend_id Бренд идентификаторы (баптауға қарай тек біреуі көрсетіледі).
potential Float типті сандық мән.
plancount Float типті сандық мән.
factcount Float типті сандық мән.
patalog Патология атауы (мәтіндік мән).
task_id Proxima CRM жүйесіндегі визит идентификаторы.

Қате жауап

40x/50x

{
  "message": "string"
}
Код Сипаттамасы
400 қате сұраныс
401 рұқсат жоқ
500 сервер қатесі