Zwraca listę zdarzeń według zadanych parametrów.

Definicja Funkcji

Array getEvents(Array $data)

Definicja parametrów

Metoda przyjmuje 1 argument, jako tablica lub string JSON.

Nazwa parametru	Typ parametru	Opis
from__	string	Data w formacie YYYY-MM-DD (np 2023-05-09) Od jakiego dnia ma pobrać zdarzenia
to____	string	Data w formacie YYYY-MM-DD (np 2023-05-09) do jakiego dnia ma pobrać zdarzenia,
usr_id	int	Id pracownika (users.usr_id)
contid	int	Id kontaktu (contacts.contid)

Podanie każdego powyższego parametru spowoduje dodanie warunków, które każde zdarzenie musi spełnić, aby zostało zwrócone w tablicy.

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
     $data = [
        'from__' => '2023-05-09',
        'to____' => '2023-05-11',
        'contid' => 1,    
    ];
    $events = $api->getEvents($data);
} catch(\Exception $e) {
    throw new \Exception($e->getMessage());
}

Zwracane dane lub wyjątki

Metoda zwraca tablicę asocjacyjną z danymi zdarzenia w przypadku sukcesu. Jeśli wystąpi błąd wtedy, zostanie zwrócony wyjątek.

Zwracane wyjątki w zależności od wywołania

• SOAP - SoapFault
• Lokalnie - Exception