Przejdź do głównej treści

Utwórz nowy komentarz

Ready_™ Developer TeamMniej niż 1 minuta

Utwórz nowy komentarz

Definicja Funkcji

Int addComment(Array $data)

Definicja parametrów

Metoda przyjmuje 1 argument, jako tablica lub string JSON. Dostępne klucze:

Nazwa parametruTyp parametruOpis
prc_idInt(Wymagany)Identyfikator sprawy (processes.prc_id)
doc_idInt(Zamienny za 'prc_id')Identyfikator dokumentu (documents.doc_id)
evntidInt(Zamienny za 'prc_id')Identyfikator zdarzenia (events.evntid)
knbaidInt(Zamienny za 'prc_id')Identyfikator dokumentu bazy wiedzy (knowledge_base.knbaid)
commntString (Wymagany)Treść komentarza
adddatStringData dodania komentarza (w razie braku zostanie użyta bieżąca data)
adduidIntIdentyfikator użytkownika dodającego komentarz (users.usr_id). Parametr nie jest wymagany i ma znaczenie tylko wtedy jeśli API uruchominono z poziomou użytkownika EDOK_API. Jeśli API uruchominono z poziomu użytkownika systemu eDokumenty wtedy parametr usr_id jest pomijany
sendNotifiesInt1 lub 0 czy ma wysyłać powiadomienie domyślnie wysyła

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
    $data = [
        'doc_id' => 1
        'commnt' => "zatwierdzam dokument"
    ];
    $result = $api->addComment($data);
} catch(\Exception $e) {
    throw new \Exception($e->getMessage());
}

Zwracane dane lub wyjątki

Metoda zwraca ID komentarza 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