Pobierz definicje wszystkich rejestrów
Mniej niż 1 minuta
Pobierz definicje wszystkich rejestrów
Definicja Funkcji
Array getAvailableRegisters($include_fields_def = FALSE)
Pobiera definicje wszystkich dostępnych rejestrów (rekordy z cregisters.registers). Na kluczu fields pojawią się tylko te pola, które są zadeklarowane w zakładce pola (tabela cregisters.register_fields)
Definicja parametrów
Metoda przyjmuje następujące parametry.
Nazwa parametru | Typ parametru | Opis |
---|---|---|
include_fields_def | bool | Czy dołączyć definicje pól. Domyślnie FALSE |
Przykład użycia
require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
$data = $api->getAvailableRegisters();
} catch(\Exception $e) {
throw new \Exception($e->getMessage());
}
Zwracane dane lub wyjątki
Metoda zwraca tablicę asocjacyjną z danymi rejestró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