Szukaj wpisów w podanym rejestrze

Definicja Funkcji

Array searchRegisterEntries($register_id, $fields, $limit, $offset, $params)

Wyszukuje wpisy w podanym rejestrze. Dla typów danych innych niż boolean wyszukiwanie jest tekstowe (wielkość liter nie ma znaczenia). Przykład: {"ulica":"Stefana batorego"} w SQLu będzie równoznaczne z (ulica ~* 'Stefana' AND ulica ~* 'batorego')

Definicja parametrów

Nazwa parametru	Typ parametru	Opis
register_id	int (wymagany)	Id rejestru (cregisters.register.id____) do którego chcemy dodać/zaktualizować wpisy
fields	string	Pola z rejestru (jedno lub więcej, wymienione po przecinku), których wartości mają zostać zwrócone w wyniku wyszukiwania (np. "id____,imie,nazwisko"). Jeżeli mają zostać zwrócone kolumny z raportu podpiętego do rejestru wtedy należy pole ustawić na wartość $fields = 'REPORT_DEFINED_COLUMNS'
limit	int	Maksymalna ilość zwracanych wpisów w rejestrze (0 = bez limitu)
offset	int	Od którego rekordu mają zostać zwrócone dane (działa jeżeli określono limit większy od 0)
params	array lub json (wymagany)	Dane do wyszukiwania (np. {"imie":"jan","nazwisko":"nowak"})

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
    $registerId = 1; 
    $fields = 'doc_id, tpstid';
    $limit = 2;
    $offset = 2; 
    $params = ['kolumna' => 'Nowy'];
    $res = $api->searchRegisterEntries($registerId, $fields, $limit, $offset, $params);
} catch(\Exception $e) {
    throw new \Exception($e->getMessage());
}

Zwracane dane lub wyjątki

Metoda zwraca tablicę ze znalezionymi wpisami w rejestrze 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