Ең болмағанда бір рет барылған клиенттердің (байланыстардың) тізімін қайтарады. Уақыт бойынша ешқандай шектеу жоқ.
Сұраныс
Endpoint
POST https://yourdomain.pharmahrm.com/crm-api/db-function/run
Autenticação
Bearer Token (міндетті)
Сұраныс құрылымы
Тақырыптар
| Кілт | Мән |
|---|---|
| Authorization | Bearer <token>
|
| Content-Type | application/json |
Сұраныс денесі
{
"function": "api_get_contact",
"format": "csv",
"arguments": {
"ids": "1,2,3,4"
}
}| Өріс | Түрі | Міндетті | Сипаттамасы |
|---|---|---|---|
| function | string | Иә | Әдіс атауы. Бұл сұраныс үшін — "api_get_contact" |
| format | string | Иә | Жауап форматы — csv |
| arguments | object | Жоқ | Қосымша аргументтер объектісі |
| ids | string | Жоқ | Клиент ID тізімі (үтірмен бөлінген). Көрсетілмесе, барлық барылған клиенттер қайтарылады |
Сәтті жауап
200 OK
csv форматы: жауап CSV мәтіні ретінде қайтарылады.
Content-Type
text/plain
Жауап мысалы
contact_name,contact_type,contact_spec,contact_target,contact_categ,contact_categ_by_direction,isarchive,contact_morionid,company_id,company_morionid,contact_email,contact_phone,contact_id
Dr. John Smith,Doctor,Cardiologist,A,VIP,A,No,AXC12345,110,AMX99322,j.smith@example.com,+380501234567,555
| Өріс | Сипаттамасы |
|---|---|
| contact_name | Клиенттің толық аты |
| contact_type | Клиент түрі (дәрігер, фармацевт) |
| contact_spec | Клиенттің мамандануы |
| contact_target | Клиенттің мақсатты тобы / санаты |
| contact_categ | Клиенттің жалпы санаты |
| contact_categ_by_direction | Өнім бағыты бойынша санаты |
| isarchive | Архив жалаушасы — архивке жіберу себебін қамтиды |
| contact_morionid | Клиенттің Axioma базасындағы идентификаторы |
| conpamy_id | Proxima CRM жүйесіндегі ұйым ID-і (жұмыс орны) |
| company_morionid | Axioma базасындағы ұйым ID-і (негізгі жұмыс орны) |
| contact_email | Клиенттің email-ы |
| contact_phone | Телефон нөмірі |
| contact_id | Proxima CRM деректер базасындағы клиент идентификаторы |
Қате жауап
40x/50x
{
"message": "string"
}| Код | Сипаттамасы |
|---|---|
| 400-499 | Клиент жағындағы қате |
| 500-599 | Сервер жағындағы қате |