api_get_actions – Proxima Research Poland

Zwraca informacje o aktywnościach niewizytowych (zadaniach) za wskazany okres. Obsługiwane jest filtrowanie według ID zadań oraz ID użytkownika.

Żą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_actions",
  "format": "csv",
  "arguments": {
    "date_from": "2025-08-04",
    "date_till": "2025-08-04",
    "ids": "1,2,3,4",
    "user_id": 1
  }
}

Pole	Typ	Wymagane	Opis
function	string	Tak	Nazwa metody API. Dla tego żądania — "api_get_actions".
format	string	Tak	Format odpowiedzi — csv
arguments	object	Tak	Blok parametrów
date_from	string	Tak	Data początku okresu raportowego (wg daty rozpoczęcia wizyty/zadania). Format: YYYY-MM-DD
date_till	string	Tak	Data końca okresu raportowego (wg daty zakończenia wizyty/zadania). Format: YYYY-MM-DD
ids	string	Nie	Lista identyfikatorów aktywności niewizytowych (zadań) w Proxima CRM, rozdzielonych przecinkami
user_id	integer	Nie	Identyfikator użytkownika w Proxima CRM. Zwraca aktywności niewizytowe dla konkretnego użytkownika

Odpowiedź udana

200 OK

Format csv: odpowiedź w postaci tekstu CSV.

Content-Type

text/plain

Przykład odpowiedzi

action_id,action_name,action_datefrom,action_datetill,action_tasktype,action_user_id,action_state
1001,Internal Meeting,2025-08-04T10:00:00Z,2025-08-04T11:00:00Z,Meeting,12,Completed

Pole	Opis
action_id	Identyfikator zadania w bazie Proxima CRM
action_name	Nazwa lub tytuł zadania
action_datefrom	Planowana data i godzina rozpoczęcia zadania (UTC). Format: YYYY-MM-DD HH:MM:SS
action_datetill	Planowana data i godzina zakończenia zadania (UTC). Format: YYYY-MM-DD HH:MM:SS
action_tasktype	Typ zadania (np. Spotkanie, Szkolenie, Praca administracyjna)
action_user_id	Identyfikator użytkownika przypisanego do zadania w Proxima CRM
action_state	Status zadania (np. Zaplanowana, Zakończona, Anulowana)

Odpowiedź błędu

40x/50x

{
  "message": "string"
}

Kod	Opis
400	Nieprawidłowe żądanie (np. brak wymaganych parametrów)
401	Brak autoryzacji (nieprawidłowy lub brakujący token)
500	Wewnętrzny błąd serwera

Szukaj