Dodaj nowe zdarzenie
Około 1 minut
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 parametru | Typ parametru | Opis |
|---|---|---|
| sumary | string (wymagany) | Temat zdarzenia |
| dscrpt | string | Opis zdarzenia |
| trmtyp | string (wymagany) | Typ zdarzenia:
|
| type__ | string | Typ rozmowy tel. jeśli trmtyp = PHONECALL
|
| start_ | string (wymagany) | Data rozpoczęcia w formacie YYYY-MM-DD HH:MM:SS np 2010-01-01 08:00:00 |
| duratn | string (wymagany) | Czas trwania np 2h30m - co oznacza 2 godziny 30 minut |
| type__ | int | Typ produktu
|
| usr_id | int lub array (wymagany) | Identyfikator użytkownika (może być tablica identyfikatorów), któremu zleca się wykonanie zdarzenia (users.usr_id) |
| contid | int | Identyfikator kontaktu (contacts.contid) pod którym zostanie utworzone zdarzenie |
| prc_id | int | Identyfikator sprawy (processes.prc_id) do której zostanie dołączone zdarzenie |
| adduid | int | Identyfikator użytkownika (users.usr_id) który zleca zdarzenie, musi należeć do jednostki i mieć aktywne konto |
| evcaid | int | Identyfikator kategorii zdarzenia właściwy dla danego typu patrz słownik kategorii zdarzeń |
| ccalid | int | Nazwa stawki VAT (vat.vatnam). Jeśli system nie znajdzie stawki wyrzucany jest wyjątek |
| acorid | int | Identyfikator jednostki rozliczeniowej (organization_units.orunid) |
| tovcid | int | Identyfikator typu zdarzenia korporacyjnego dotyczy tylko zdarzeń tworzonych z parametrem trmtyp = CORPEVENT |
| witinf | bool | Powiadom o wykonaniu zadania (true/false) |
| on_tod | bool | Plan dnia (true/false) |
| ismile | bool | Czy ustawić jako milestone (true/false) |
| prior_ | int | Priorytet. 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