api_get_users – Proxima Research Qazaqstan

Proxima CRM жүйесіндегі барлық пайдаланушылардың тізімін алады. Қажет болса, тізімді нақты пайдаланушы идентификаторлары бойынша сүзуге болады.

Сұраныс

Endpoint

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

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

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

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

Тақырыптар

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

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

{
  "function": "api_get_users",
  "format": "csv",
  "arguments": {
    "ids": "1,2,3,4"
  }
}

Параметрлер

Өріс	Түрі	Міндетті	Сипаттамасы
function	string	Иә	Шақырылатын әдіс атауы — "api_get_users"
format	string	Иә	Жауап форматы — csv
arguments	object	Жоқ	Әдіске тән қосымша параметрлер
ids	string	Жоқ	Пайдаланушы ID тізімі (үтірмен бөлінген). Көрсетілмесе — барлық пайдаланушылар қайтарылады

Сәтті жауап

200 OK

CSV форматы сұралған жағдайда, жүйе пайдаланушылар тізімін жай мәтін ретінде қайтарады.

Content-type

text/plain

Жауап мысалы

name,manager,country,region,direction,position,active,user_id,workstartdate,workenddate,role
Ivan Petrov,A. Sidorov,Ukraine,Kyiv,RX,Medical Rep,0,12,2022-05-01,2025-05-01,ROLE_USER

Өрістер сипаттамасы

Өріс	Сипаттамасы
name	Пайдаланушының толық аты
manager	Тікелей басшысы
country	Пайдаланушы жұмыс істейтін ел
region	Аймақтары
direction	Өнім бағыты
position	Лауазымы
Active	Активтілік статусы: 0 = активті, 1 = активті емес
user_id	Proxima CRM жүйесіндегі ішкі ID
workstartdate	Жұмыс басталған күні
workenddate	Жұмыс аяқталу күні
role	Жүйедегі рөлі (мыс.: ROLE_USER, ROLE_ADMIN)

Қате жауап

40x/50x

{
  "message": "string"
}

Код	Сипаттамасы
400-499	Клиент қатесі
500-599	Сервер қатесі

Search