Aktywuj dany etap procedury
Mniej niż 1 minuta
Aktywuj dany etap procedury
Definicja Funkcji
Bool activateStage(Int $procid, Int $ptstid, Bool $runWorkflow = FALSE, Bool $force = FALSE)
Definicja parametrów
Metoda przyjmuje 4 argumenty.
Nazwa parametru | Typ parametru | Opis |
---|---|---|
procid | int (wymagany) | Identyfikator procedury (procedures.procid) |
ptstid | int (wymagany) | Identyfikator etapu z tabeli stages_def który jest w procedurze $procid |
runWorkflow | bool | Czy uruchomić workflow. Domyślnie FALSE |
force | bool | Jeżeli TRUE to pozwala na aktywowanie etapu w zakończonej procedurze (procedura zostanie ponownie aktywowana). Domyślnie FALSE |
Przykład użycia
require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
$procid = 1;
$ptstid = 1;
$out = $api->activateStage($procid, $ptstid);
} catch(\Exception $e) {
throw new \Exception($e->getMessage());
}
Zwracane dane lub wyjątki
Metoda zwraca (bool) TRUE w przypadku sukcesu. Jeśli się nie uda lub wystąpi błąd, wtedy zostanie zwrócony wyjątek. Zwracane wyjątki w zależności od wywołania
- SOAP - SoapFault
- Lokalnie - Exception