1b.app
Link skopiowany -

API Dokument

Dodanie dokumentu do procesu, metoda: /api/document/add/

Opcje

Przykład:

http://myboxurl/api/document/add/?login=LOGIN&password=PASSWORD&ordercode=1&templateid=14&name=TEST

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/

Opcje
Opcje otrzymania pojedynczego dokumentu:

Przykład:

http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&documentid=7927

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/
Opcje odbioru wszystkich dokumentów:

Przykład:

http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&part=1
http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&part=2

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

Więcej szczegółów
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

Mogą również wystąpić błędy:

502 Bad Gateway - Jeśli wystąpi ten błąd, musisz to zrobić:
1. Sprawdź, czy jest dostęp do Internetu (przejdź do dowolnej innej witryny).
2. Jeśli nie ma problemów z dostępem — możesz usunąć pliki cookie.
Jeśli powyższe nie pomogło — problem po stronie serwera. Powinieneś skontaktować się z administratorem systemu lokacji.

503 (Service Temporarily Unavailable) - Ten błąd może wystąpić w wyniku zbyt dużej liczby żądania do serwera. Jeśli widzisz ten błąd, odczekaj kilka minut i spróbuj ponownie.

504 Gateway Timeout - cNajprawdopodobniej jest to spowodowane zwiększonym obciążeniem witryny, pod którym Apache nie jest w stanie zarządza wysyłaniem odpowiedzi HTTP, a nowe żądania ustawiają się w kolejce. Aby rozwiązać problem, możesz dodać zasobów serwera, w szczególności pamięci RAM, oraz zwiększenia liczby procesów httpd (Apache).
Inną możliwą przyczyną błędu 504 jest to, że wykonywany skrypt nie mieści się w wyznaczonym limicie. czas. Dzieje się tak, gdy żądanie jest zbyt ciężkie. Spróbuj podzielić żądanie na kilka kolejnych maluchy.

Błąd 505 Wersja HTTP nie jest obsługiwana oznacza, że ​​strona internetowa nie jest obsługuje wersję protokołu HTTP używaną przez przeglądarkę do żądania strony internetowej