Wyszukaj jeden lub wiele kontaktów (kontrahentów)
Mniej niż 1 minuta
Wyszukaj jeden lub wiele kontaktów (kontrahentów)
Definicja Funkcji
Array searchContacts(Array $data, String $fields = NULL)
Szuka kontaktów wg. zadanych kryteriów i zwraca listę identyfikatorów znalezionych dokumentów.
Definicja parametrów
Nazwa parametru | Typ parametru | Opis |
---|---|---|
data | array (Wymagany) | Tablica z parametrami w formie klucz => wartość, gdzie klucz to nazwa pola z bazy z tabeli contacts natomiast wartość to ciąg tekstowy, który szukamy i który ma się znaleźć w kluczu. Możliwe jest określenie operatora logicznego, który zostanie użyty do łączenia wyrażeń/warunków. Przykład: ['(AND)name_2' => 'FIRMA', '(AND)city__' => 'warszawa',] wyszuka kontakty, których nazwa skrócona zawiera słowo "FIRMA" i miasto zawiera słowo "warszawa" wygenerowany na tej podstawie SQL: (name_2 ~* 'FIRMA' AND city__ ~* 'warszawa') Możliwe jest również określenie operatora porównania (=, !=, ~, ~*) pola z podanym tekstem/wartością. Przykład: ['name_2=' => 'FIRMA'] wyszuka kontakty których nazwa skrócona jest równa "FIRMA" i miasto jest równe "Warszawa" wygenerowany na tej podstawie SQL: (name_2 = 'FIRMA') |
fields | string | Nazwy pól z tabli contacts. Domyślnie NULL, wtedy zostaną zwrócone wszystkie pola |
Przykład użycia
require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
// znajdź kontakt (kontrahenta) o nazwie 'WAŻNY KONTAKT', w wyniku podaj wszystkie pola kontaktu
$contacts = $api->searchContacts(['name_1' => 'WAŻNY KONTAKT',]);
// znajdź kontakt (kontrahenta) który posiada email: 'BETASOFT@BETASOFT.PL', w wyniku podaj nazwe i nr telefonu kontaktu
$contacts = $api->searchContacts(['email_' => 'BETASOFT@BETASOFT.PL',]['name_1', 'ph_num']);
} catch(\Exception $e) {
throw new \Exception($e->getMessage());
}
Zwracane dane lub wyjątki
Metoda zwraca tablicę identyfikatorów klientów 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