OneBox
OneBox Rest API
API leksykony

API leksykony

Dodanie jednego wpisu do katalogu, metoda: /api/directory/change/?actiontype=insert

Opcje

Przykład:

http://myboxurl/api/directory/change/?login=XXXX&password=YYY&actiontype=insert&directoryid=1&field1=value1&field2=value2

№	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	directoryid	integer	id informator	Pole obowiązkowe.
4	[KEY]	string	pola katalogów		Aby wstawić wymagane parametry należy przekazać w formacie KEY=VALUE, gdzie KLUCZ jest identyfikatorem wymaganego pola
5	dataFromBody	boolean	Pobieraj dane nie z argumentów, ale z treści	Pole nie wymagane.	Jeżeli zostanie przekazane dataFromBody=1, to dane zostaną pobrane nie z argumentów, ale z treści żądania. Należy przekazać treść json, w której klucze muszą mieć parametry opisane powyżej. login i hasło powinny zostać wysłane jak zwykle

Edycja jednego wpisu w książce telefonicznej, metoda: /api/directory/change/?actiontype=update

Opcje

Przykład:

http://myboxurl/api/directory/change/?login=XXXX&password=YYY&actiontype=update&directoryid=1&id=1&field2=value2&data[field1]=value1&data[field2]=value2

№	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	directoryid	integer	id informator	Pole obowiązkowe.
5	data	array	pola katalogu do aktualizacji		Tablica asocjacyjna wartości do edycji katalogu. Tablica zawiera wartości w formacie KEY=VALUE, gdzie KEY jest identyfikatorem wymaganego pola
6	id lub nagrany	integer	id wpisy do katalogu	Pole nie wymagane.	Jeśli chcesz zmienić konkretny wpis w katalogu
7	[KEY]	string	pola katalogów		Aby wyszukać wymagany rekord do edycji można przekazać wartość w formacie KEY=VALUE, gdzie KLUCZ jest identyfikatorem wymaganego pola
8	dataFromBody	boolean	Pobieraj dane nie z argumentów, ale z treści	Pole nie wymagane.	Jeżeli zostanie przekazane dataFromBody=1, to dane zostaną pobrane nie z argumentów, ale z treści żądania. Należy przekazać treść json, w której klucze muszą mieć parametry opisane powyżej. login i hasło powinny zostać wysłane jak zwykle

Usuwanie wpisu w książce telefonicznej, metoda: /api/directory/change/?actiontype=delete

Opcje

Przykład:

http://myboxurl/api/directory/get/?login=XXXX&password=YYY&directoryid=1

№	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	directoryid	integer	id informator	Pole obowiązkowe.
6	recordid	integer	id wpisy do katalogu	Pole nie wymagane.
7	dataFromBody	boolean	Pobieraj dane nie z argumentów, ale z treści	Pole nie wymagane.	Jeżeli zostanie przekazane dataFromBody=1, to dane zostaną pobrane nie z argumentów, ale z treści żądania. Należy przekazać treść json, w której klucze muszą mieć parametry opisane powyżej. login i hasło powinny zostać wysłane jak zwykle

Dodawanie wielu wpisów do katalogu, metoda: /api/directory/change/?actiontype=insert

Opcje

Przykład:

http://myboxurl/api/directory/change/?login=XXXX&password=YYY&actiontype=insert&directoryid=1&massivechange=[{"field1":"val1","field2":"val2","field3":"val3"},{"field1":"val11","field2":"val22","field3":"val33"}]

№	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	directoryid	integer	id informator	Pole obowiązkowe.
4	massivechange	json	Tablica w formacie json z danymi niezbędnymi do wstawienia		Tablica musi składać się z tablic asocjacyjnych z danymi umożliwiającymi wstawienie wpisu do katalogu. Taka tablica musi zawierać dane w formacie KLUCZ=WARTOŚĆ, gdzie KLUCZ jest identyfikatorem wymaganego pola
5	dataFromBody	boolean	Pobieraj dane nie z argumentów, ale z treści	Pole nie wymagane.	Jeżeli zostanie przekazane dataFromBody=1, to dane zostaną pobrane nie z argumentów, ale z treści żądania. Należy przekazać treść json, w której klucze muszą mieć parametry opisane powyżej. login i hasło powinny zostać wysłane jak zwykle

Edycja wielu wpisów w katalogu, metoda: /api/directory/change/?actiontype=update

Opcje

Przykład:

http://myboxurl/api/directory/change/?login=XXXX&password=YYY&actiontype=update&directoryid=1&massivechange=[{"field1":"11","data":{"field1":"val1","field2":"val2"}},{"field1":"val1","data":{"field1":"val1","field2":"val2"}}]

№	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	directoryid	integer	id informator	Pole obowiązkowe.
5	data	array	pola katalogu do aktualizacji		Tablica asocjacyjna wartości do edycji katalogu. Tablica zawiera wartości w formacie KEY=VALUE, gdzie KEY jest identyfikatorem wymaganego pola
6	id lub nagrany	integer	id wpisy do katalogu	Pole nie wymagane.	Jeśli chcesz zmienić konkretny wpis w katalogu
7	[KEY]	string	pola katalogów		Aby wyszukać wymagany rekord do edycji można przekazać wartość w formacie KEY=VALUE, gdzie KLUCZ jest identyfikatorem wymaganego pola
4	massivechange	json	Tablica w formacie json z danymi niezbędnymi do edycji		Tablica musi składać się z tablic asocjacyjnych z danymi umożliwiającymi wstawienie wpisu do katalogu. Każda tablica asocjacyjna musi mieć tę strukturę: id Lub recordid - edytować konkretny wpis w katalogu (parametr opcjonalny) data - tablica asocjacyjna z danymi do aktualizacji pozostałe parametry wyszukiwania wpisu w katalogu w formacie KEY=VALUE, gdzie KLUCZ jest identyfikatorem wymaganego pola
5	dataFromBody	boolean	Pobieraj dane nie z argumentów, ale z treści	Pole nie wymagane.	Jeżeli zostanie przekazane dataFromBody=1, to dane zostaną pobrane nie z argumentów, ale z treści żądania. Należy przekazać treść json, w której klucze muszą mieć parametry opisane powyżej. login i hasło powinny zostać wysłane jak zwykle

Pobranie jednego wpisu lub wszystkich wpisów do katalogu, metoda: /api/directory/get/

Opcje

Przykład:

http://myboxurl/api/directory/get/?login=XXXX&password=YYY&directoryid=1

№	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	directoryid	integer	id informator	Pole obowiązkowe.
4	recordid	integer	id wpisy do katalogu	Pole nie wymagane.	Jeśli chcesz otrzymać konkretny wpis do katalogu

API leksykony

Dziękujemy za wybór.