Pobierz definicję rejestru
Mniej niż 1 minuta
Pobierz definicję rejestru
Definicja Funkcji
Array getRegister($params)
Pobiera definicję rejestru (rekord 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 1 argument, jako tablica lub string JSON. Dostępne klucze:
Nazwa klucza | Typ klucza | Opis |
---|---|---|
id____ | int (wymagany) | Identyfikator rejestru (cregisters.register.id____), klucz zamienny z name__ |
name__ | text (zamienny z id____) | Unikalna nazwa rejestru. Klucz zamienny z id____ |
Przykład użycia
require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
$param['id____'] = 1;
$register = $api->getRegister($param);
} catch(\Exception $e) {
throw new \Exception($e->getMessage());
}
Zwracane dane lub wyjątki
Metoda zwraca tablicę asocjacyjną z danymi rejestru 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