Przejdź do głównej treści

Dodaj nowe zdarzenie


Dodaj nowe zdarzenie

Definicja Funkcji

Int createEvent(Array $data)

możliwe typy zdarzeń:

  • zadanie
  • rozmowę telefoniczną
  • spotkanie

Definicja parametrów

Metoda przyjmuje 1 argument, jako tablica lub string JSON.

Nazwa parametruTyp parametruOpis
sumarystring (wymagany)Temat zdarzenia
dscrptstringOpis zdarzenia
trmtypstring (wymagany)Typ zdarzenia:
  • TODO - zadanie
  • ** PHONECALL - rozmowa tel.**
  • MEETING - spotkanie
type__stringTyp rozmowy tel. jeśli trmtyp = PHONECALL
  • IN - przychodząca
  • OUT - wychodząca
  • INT - wewnętrzna
start_string (wymagany)Data rozpoczęcia w formacie YYYY-MM-DD HH:MM:SS np 2010-01-01 08:00:00
duratnstring (wymagany)Czas trwania np 2h30m - co oznacza 2 godziny 30 minut
type__intTyp produktu
  1. Usługa
  2. Produkt
  3. Towar
usr_idint lub array (wymagany)Identyfikator użytkownika (może być tablica identyfikatorów), któremu zleca się wykonanie zdarzenia (users.usr_id)
contidintIdentyfikator kontaktu (contacts.contid) pod którym zostanie utworzone zdarzenie
prc_idintIdentyfikator sprawy (processes.prc_id) do której zostanie dołączone zdarzenie
adduidintIdentyfikator użytkownika (users.usr_id) który zleca zdarzenie, musi należeć do jednostki i mieć aktywne konto
evcaidintIdentyfikator kategorii zdarzenia właściwy dla danego typu patrz słownik kategorii zdarzeń
ccalidintNazwa stawki VAT (vat.vatnam). Jeśli system nie znajdzie stawki wyrzucany jest wyjątek
acoridintIdentyfikator jednostki rozliczeniowej (organization_units.orunid)
tovcidintIdentyfikator typu zdarzenia korporacyjnego dotyczy tylko zdarzeń tworzonych z parametrem trmtyp = CORPEVENT
witinfboolPowiadom o wykonaniu zadania (true/false)
on_todboolPlan dnia (true/false)
ismileboolCzy ustawić jako milestone (true/false)
prior_intPriorytet. Domyślnie 2

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
    $data = [
        'sumary' => 'Temat Zdarzenia',
        'trmtyp' => 'TODO',
        'start_' => date('Y-m-d H:i:s'),
        'duratn' => '2h 30m',
        'usr_id' => 2,
    ];
    $evntid = $api->createEvent($data);
   
} catch(\Exception $e) {
    throw new \Exception($e->getMessage());
}

Zwracane dane lub wyjątki

Metoda zwraca id zdarzenia (events.evntid) 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