api_get_arrangement – Proxima Research Poland

Zwraca informacje wprowadzone podczas wizyty w karcie „Ustalenia”.
Zakres parametrów zależy od konfiguracji klienta.
Aby pobrać konfigurację, użyj api_get_entitymap.

Żą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_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"
    }
}

Pole	Typ	Wymagane	Opis
function	string	Tak	Metoda API — `"api_get_arrangement"`.
format	string	Tak	Format odpowiedzi — `csv`.
arguments	object	Tak	Blok parametrów.
date_from	string	Tak	Data rozpoczęcia generowania listy wizyt.
date_till	string	Tak	Data zakończenia generowania listy wizyt.
preparation_ids	string	Nie	ID preparatów (oddzielone przecinkami).
brend_ids	string	Nie	ID marek (string, oddzielone przecinkami).

Odpowiedź udana

200 OK

Format csv.

Content-Type

text/plain

Przykład

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

Pole	Opis
preparation_id	Identyfikator preparatu (tylko preparation_id lub brend_id — zależnie od konfiguracji).
brend_id	Identyfikator marki.
potential	Wartość liczbowa typu float.
plancount	Liczbowa wartość planu (float).
factcount	Faktyczna wartość (float).
patalog	Nazwa patologii (tekst).
task_id	ID wizyty w bazie Proxima CRM.

Odpowiedź błędu

40x/50x

{
  "message": "string"
}

Kod	Opis
400	nieprawidłowe żądanie
401	brak autoryzacji
500	błąd serwera

Szukaj