Перейти к основному контенту

Поиск

api_get_contact_json

Возвращает список клиентов (контактов), которые были посещены хотя бы один раз. Без ограничения по времени.

Запрос

Endpoint

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

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

Bearer Token (обязателен)

Структура запиту

Заголовки

Ключ Значение
Authorization Bearer <token>
Content-Type application/json

Тело запроса

{
  "function": "api_get_contact_json",
  "format": "json",
  "arguments": {
    "ids": "1,2,3,4"
  }
}
Поле Тип Обязательный Описание
function string Да Имя вызываемого метода. Для данного запроса — "api_get_contact_json"
format string Да Формат ответа - JSON
arguments object Нет Объект дополнительных аргументов
ids string Нет Список ID клиентов через запятую. Если не указан, возвращаются все посещенные клиенты

Успешный ответ

200 OK

Формат JSON

Пример ответа
[{
                                        "isarchive": null,
                                        "company_id": 87458,
                                        "contact_id": 196879,
                                        "contact_name": "Приймачук Валентина Анатоліївна ",
                                        "contact_spec": "Гастроентерологія",
                                        "contact_type": "All",
                                        "contact_categ": null,
                                        "contact_email": null,
                                        "contact_phone": " 0963289903",
                                        "contact_target": [
                                            "Rx-Гастроентеролог"
                                        ],
                                        "company_morionid": 3475149,
                                        "contact_morionid": null,
                                        "contact_categ_by_direction": ["RX-A","OTC-B"]
                                    }
                                ]
Поле Описание
contact_name Полное имя клиента
contact_type Тип клиента (врач, фармацевт)
contact_spec Специализация клиента
contact_target Целевая группа/категория клиента
contact_categ Общая категория клиента
contact_categ_by_direction Категория по направлению продукта
isarchive Флаг архива - содержит причину архивации
contact_morionid Идентификатор клиента в базе Axioma
conpamy_id ID учреждения из Proxima CRM (место работы)
company_morionid Идентификатор учреждения в БД Axioma (основное место работы)
contact_email email клиента
contact_phone Телефон
contact_id Идентификатор клиента БД Proxima CRM

Ошибочный ответ

40x/50x

{
  "message": "string"
}
Код Описание
400-499 Ошибка на стороне клиента
500-599 Ошибка на стороне сервера