Przejdź do głównej zawartości

Szukaj

api_get_contact

Zwraca listę klientów (kontaktów), którzy zostali odwiedzeni co najmniej raz. Bez ograniczeń czasowych.

Żądanie

Endpoint

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

Uwierzytelnianie

Bearer Token (wymagany)

Struktura żądania

Nagłówki

Klucz Wartość
Authorization Bearer <token>
Content-Type application/json

Treść żądania

{
  "function": "api_get_contact",
  "format": "csv",
  "arguments": {
    "ids": "1,2,3,4"
  }
}
Pole Typ Wymagane Opis
function string Tak Nazwa wywoływanej metody — "api_get_contact"
format string Tak Format odpowiedzi — csv
arguments object Nie Obiekt dodatkowych argumentów
ids string Nie Lista ID klientów rozdzielonych przecinkami. Jeśli nie podano — zwracani są wszyscy odwiedzeni klienci

Odpowiedź udana

200 OK

Format csv: odpowiedź w postaci tekstu CSV.

Content-Type

text/plain

Przykład odpowiedzi
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
Pole Opis
contact_name Pełne imię i nazwisko klienta
contact_type Typ klienta (lekarz, farmaceuta)
contact_spec Specjalizacja klienta
contact_target Grupa docelowa / kategoria klienta
contact_categ Ogólna kategoria klienta
contact_categ_by_direction Kategoria wg linii / kierunku produktu
isarchive Flaga archiwum — zawiera powód archiwizacji
contact_morionid Identyfikator klienta w bazie Axioma
conpamy_id ID placówki z Proxima CRM (miejsce pracy)
company_morionid Identyfikator placówki w bazie Axioma (główne miejsce pracy)
contact_email Adres e-mail klienta
contact_phone Telefon klienta
contact_id Identyfikator klienta w bazie Proxima CRM

Odpowiedź błędu

40x/50x

{
  "message": "string"
}
Kod Opis
400-499 Błąd po stronie klienta
500-599 Błąd po stronie serwera