api_get_arrangement – Proxima Research Qazaqstan

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

Сұраныс

Endpoint

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

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

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

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

Тақырыптар

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

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

{
    "function": "api_get_arrangement",
    "format": "csv",
    "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"`.
format	string	Иә	Жауап форматы — `csv`.
arguments	object	Иә	Параметрлер блогы.
date_from	string	Иә	Визит тізімін құрастырудың басталу күні. Формат: `YYYY-MM-DD`.
date_till	string	Иә	Визит тізімін құрастырудың аяқталу күні. Формат: `YYYY-MM-DD`.
preparation_ids	string	Жоқ	Препарат идентификаторлары (үтірмен бөлінген).
brend_ids	string	Жоқ	Бренд идентификаторлары (string, үтірмен бөлінген).

Сәтті жауап

200 OK

Формат csv — CSV мәтіні ретінде.

Content-Type

text/plain

Жауап мысалы

preparation_id,brend_id,potential,plancount,factcount,patalog,task_id
1,6,,2,2,,51365
13,1,1,5,5,,51365
14,4,3,5,5,,51365

Өріс	Сипаттамасы
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	сервер қатесі

Search