Dodanie dokumentu do procesu, metoda: /api/document/add/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | templateid | integer | Identyfikator szablonu dokumentu | Pole obowiązkowe. | Określ identyfikator szablonu dokumentu, aby utworzyć dokument. |
4 | orderid | integer | Identyfikator procesu | Pole obowiązkowe. | Podaj identyfikator lub kod zewnętrzny procesu, dla którego chcesz utworzyć dokument |
5 | ordercode | integer | Zewnętrzny kod procesu | Pole obowiązkowe. | Podaj identyfikator lub kod zewnętrzny procesu, dla którego chcesz utworzyć dokument |
6 | name | string | nazwa dokumentu | Pole nie wymagane. | |
7 | clientview | 1 / 0 | Dostępny do wglądu na koncie klienta | Pole nie wymagane. | Aby udostępnić dokument do wglądu w rachunku klienta wpisz w tym polu wartość 1 |
8 | fileoriginal | string | Plik z oryginałem | Pole nie wymagane. |
Otrzymanie jednego dokumentu i otrzymanie wszystkich dokumentów, metoda: /api/document/get/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | documentid | string | Identyfikator dokumentu | Pole obowiązkowe. | Jeśli potrzebujesz konkretnego zamówienia, w tym polu podajesz identyfikator dokumentu lub numer dokumentu. Silnik sam go znajdzie i zwróci. Zwróć wartości pól id - id dokument number - Numer dokumentu, name - nazwa dokumentu, contractorid - id osoba prawna w systemie BOX, contactorname - nazwa osoby prawnej, templateid - id szablon dokumentu, templatename - nazwa szablonu dokumentu, userid - id użytkownik, który utworzył dokument, cdate - data utworzenia dokumentu, sdate - data wysłania dokumentu, bdate - datę otrzymania dokumentu z powrotem, adate - data archiwizacji dokumentu, edate - data modyfikacji dokumentu, fileoriginal - link do oryginalnego pliku, file - link do zeskanowanej kopii, content - treść dokumentu w formacie HTML, clientview - dostępne do wglądu na Twoim koncie osobistym, clientpay - dostępne do zapłaty na Twoim koncie osobistym, sum - kwota dokumentu, currencyid - id waluta dokumentu, currencyname - nazwa waluty dokumentu, orderid - id proces dokumentowania |
4 | clientinfo | boolean | Przetwarzaj tablicę danych klienta | Pole nie wymagane. | Tablica będzie zawierać wszystkie pola systemowe i dodatkowe klienta procesu, w którym dokument został utworzony, określone w odpowiedzi na żądanie /api/contact-get/json/ |
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | orderid | string | ID proces | Pole nie wymagane. | Podaj identyfikator procesu, którego dokumenty chcesz otrzymać |
4 | templateid | string | ID szablon dokumentu | Pole nie wymagane. | Określ identyfikator szablonu dokumentu, według którego będą filtrowane dokumenty. |
5 | cdate | date | data utworzenia dokumentu | Pole nie wymagane. | Podaj datę utworzenia, a ostateczny wybór obejmie tylko te dokumenty, których data utworzenia jest większa lub równa podanej |
6 | part | integer | Część dokumentów | Pole obowiązkowe. | API wystawi do 1000 dokumentów w pierwszej części, aby otrzymać kolejne 1000 dokumentów, przekaż tam 2 (otrzymujesz część 2) i tak dalej. Zwróć wartości pól id - id dokument number - Numer dokumentu, name - nazwa dokumentu, contractorid - id osoba prawna w systemie BOX, contactorname - nazwa osoby prawnej, templateid - id szablon dokumentu, templatename - nazwa szablonu dokumentu, userid - id użytkownik, który utworzył dokument, cdate - data utworzenia dokumentu, sdate - data wysłania dokumentu, bdate - datę otrzymania dokumentu z powrotem, adate - data archiwizacji dokumentu, edate - data modyfikacji dokumentu, fileoriginal - link do oryginalnego pliku, file - link do zeskanowanej kopii, content - treść dokumentu w formacie HTML, clientview - dostępne do wglądu na Twoim koncie osobistym, clientpay - dostępne do zapłaty na Twoim koncie osobistym, sum - kwota dokumentu, currencyid - id waluta dokumentu, currencyname - nazwa waluty dokumentu, orderid - id proces dokumentowania |
7 | clientinfo | boolean | Przetwarzaj tablicę danych klienta | Pole nie wymagane. | Tablica będzie zawierać wszystkie pola systemowe i dodatkowe klienta procesu, w którym dokument został utworzony, określone w odpowiedzi na żądanie /api/contact-get/json/ |
Możliwe odpowiedzi na zapytanie
№ | Status | Wiadomość | Opis wiadomości |
1 | fail | login_empty | Brak logowania |
2 | fail | password_empty | Brak hasła |
3 | fail | Bad user level! | Niski poziom użytkownika, aby wykonać tę akcję (wymagany poziom 2 lub wyższy) |
4 | fail | Login or password not correct! | Login lub hasło wpisane niepoprawnie |