OneBox
OneBox Rest API
API Nachschlagewerke

API Nachschlagewerke

Hinzufügen eines Eintrags zum Verzeichnis, Methode: /api/directory/change/?actiontype=insert

Optionen

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	directoryid	integer	id Verzeichnis	Pflichtfeld.
4	[KEY]	string	Verzeichnisfelder		Um die erforderlichen Parameter einzufügen, übergeben Sie das Format SCHLÜSSEL=WERT, wobei SCHLÜSSEL der Bezeichner des erforderlichen Felds ist
5	dataFromBody	boolean	Nehmen Sie Daten nicht aus Argumenten, sondern aus dem Körper	Nicht erforderliches Feld.	Wenn dataFromBody=1 übergeben wird, werden die Daten nicht aus den Argumenten, sondern aus dem Request-Body genommen. Json muss an den Body übergeben werden, in dem die Schlüssel die oben beschriebenen Parameter sein müssen. login und Passwort sollten wie gewohnt gesendet werden

Bearbeiten eines Eintrags im Telefonbuch, Methode: /api/directory/change/?actiontype=update

Optionen

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	directoryid	integer	id Verzeichnis	Pflichtfeld.
5	data	array	Nachschlagefelder zu aktualisieren		Assoziatives Array von Werten zum Bearbeiten des Wörterbuchs. Das Array enthält Werte im Format SCHLÜSSEL=WERT, wobei SCHLÜSSEL die ID des erforderlichen Feldes ist
6	id oder recordid	integer	id Verzeichniseinträge	Nicht erforderliches Feld.	Wenn Sie einen bestimmten Telefonbucheintrag ändern möchten
7	[KEY]	string	Verzeichnisfelder		Um nach einem erforderlichen Datensatz zum Bearbeiten zu suchen, können Sie einen Wert im Format SCHLÜSSEL=WERT übergeben, wobei SCHLÜSSEL die Kennung des erforderlichen Felds ist
8	dataFromBody	boolean	Nehmen Sie Daten nicht aus Argumenten, sondern aus dem Körper	Nicht erforderliches Feld.	Wenn dataFromBody=1 übergeben wird, werden die Daten nicht aus den Argumenten, sondern aus dem Request-Body genommen. Json muss an den Body übergeben werden, in dem die Schlüssel die oben beschriebenen Parameter sein müssen. login und Passwort sollten wie gewohnt gesendet werden

Telefonbucheintrag löschen Methode: /api/directory/change/?actiontype=delete

Optionen

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	directoryid	integer	id Verzeichnis	Pflichtfeld.
6	recordid	integer	id Verzeichniseinträge	Nicht erforderliches Feld.
7	dataFromBody	boolean	Nehmen Sie Daten nicht aus Argumenten, sondern aus dem Körper	Nicht erforderliches Feld.	Wenn dataFromBody=1 übergeben wird, werden die Daten nicht aus den Argumenten, sondern aus dem Request-Body genommen. Json muss an den Body übergeben werden, in dem die Schlüssel die oben beschriebenen Parameter sein müssen. login und Passwort sollten wie gewohnt gesendet werden

Hinzufügen mehrerer Einträge zum Verzeichnis, Methode: /api/directory/change/?actiontype=insert

Optionen

Beispiel:

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"}]

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	directoryid	integer	id Verzeichnis	Pflichtfeld.
4	massivechange	json	Array im json-Format mit zum Einfügen erforderlichen Daten		Das Array muss aus assoziativen Arrays mit Daten zum Einfügen eines Eintrags in das Verzeichnis bestehen. Ein solches Array muss Daten im Format SCHLÜSSEL=WERT enthalten, wobei SCHLÜSSEL der Bezeichner des erforderlichen Felds ist
5	dataFromBody	boolean	Nehmen Sie Daten nicht aus Argumenten, sondern aus dem Körper	Nicht erforderliches Feld.	Wenn dataFromBody=1 übergeben wird, werden die Daten nicht aus den Argumenten, sondern aus dem Request-Body genommen. Json muss an den Body übergeben werden, in dem die Schlüssel die oben beschriebenen Parameter sein müssen. login und Passwort sollten wie gewohnt gesendet werden

Bearbeiten mehrerer Einträge im Telefonbuch, Methode: /api/directory/change/?actiontype=update

Optionen

Beispiel:

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"}}]

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	directoryid	integer	id Verzeichnis	Pflichtfeld.
5	data	array	Nachschlagefelder zu aktualisieren		Assoziatives Array von Werten zum Bearbeiten des Wörterbuchs. Das Array enthält Werte im Format SCHLÜSSEL=WERT, wobei SCHLÜSSEL die ID des erforderlichen Feldes ist
6	id oder recordid	integer	id Verzeichniseinträge	Nicht erforderliches Feld.	Wenn Sie einen bestimmten Telefonbucheintrag ändern möchten
7	[KEY]	string	Verzeichnisfelder		Um nach einem erforderlichen Datensatz zum Bearbeiten zu suchen, können Sie einen Wert im Format SCHLÜSSEL=WERT übergeben, wobei SCHLÜSSEL die Kennung des erforderlichen Felds ist
4	massivechange	json	Array im json-Format mit Daten, die für die Bearbeitung erforderlich sind		Das Array muss aus assoziativen Arrays mit Daten zum Einfügen eines Eintrags in das Verzeichnis bestehen. Jedes assoziative Array muss diese Struktur haben: id oder recordid - um einen bestimmten Verzeichniseintrag zu bearbeiten (optional) data - assoziatives Array mit zu aktualisierenden Daten andere Parameter für die Suche nach einem Eintrag im Verzeichnis im Format SCHLÜSSEL=WERT, wobei SCHLÜSSEL der Bezeichner des erforderlichen Feldes ist
5	dataFromBody	boolean	Nehmen Sie Daten nicht aus Argumenten, sondern aus dem Körper	Nicht erforderliches Feld.	Wenn dataFromBody=1 übergeben wird, werden die Daten nicht aus den Argumenten, sondern aus dem Request-Body genommen. Json muss an den Body übergeben werden, in dem die Schlüssel die oben beschriebenen Parameter sein müssen. login und Passwort sollten wie gewohnt gesendet werden

Abrufen eines Eintrags oder aller Telefonbucheinträge, Methode: /api/directory/get/

Optionen

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	directoryid	integer	id Verzeichnis	Pflichtfeld.
4	recordid	integer	id Verzeichniseinträge	Nicht erforderliches Feld.	Wenn Sie einen bestimmten Telefonbucheintrag wünschen

API Nachschlagewerke

Vielen Dank für Ihre Wahl.