OneBox
OneBox Rest API
API references

API references

Add one entry to the directory, method: /api/directory/change/?actiontype=insert

Parameters

Example:

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

№	Field	Type	Description	Required or not	Comment
1	login	string	Login in BOX system	Required field.
2	password	string	Password in md5 format	Required field.	Contact tech support and we will give you a hash for the API
3	directoryid	integer	id reference	Required field.
4	[KEY]	string	dictionary fields		To insert the required parameters, pass in the format KEY = VALUE, where KEY is the identifier of the required field
5	dataFromBody	boolean	Take data not from arguments, but from body	Optional field.	If dataFromBody = 1 is passed, then data will be taken not from arguments, but from the request body. Json must be passed to the body, in which the keys must be the parameters described above. login and password should be sent as usual

Editing one entry in the directory, method: /api/directory/change/?actiontype=update

Parameters

Example:

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

№	Field	Type	Description	Required or not	Comment
1	login	string	Login in BOX system	Required field.
2	password	string	Password in md5 format	Required field.	Contact tech support and we will give you a hash for the API
3	directoryid	integer	id reference	Required field.
5	data	array	reference fields to update		Associative array of values for editing the directory. The array contains values in the format KEY = VALUE, where KEY is the identifier of the required field
6	id or recordid	integer	id directory entries	Optional field.	If you want to change a specific directory entry
7	[KEY]	string	dictionary fields		To find the required record for editing, you can send a value in the format KEY = VALUE, where KEY is the identifier of the required field
8	dataFromBody	boolean	Take data not from arguments, but from body	Optional field.	If dataFromBody = 1 is passed, then data will be taken not from arguments, but from the request body. Json must be passed to the body, in which the keys must be the parameters described above. login and password should be sent as usual

Deleting a directory entry, method: /api/directory/change/?actiontype=delete

Parameters

Example:

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

№	Field	Type	Description	Required or not	Comment
1	login	string	Login in BOX system	Required field.
2	password	string	Password in md5 format	Required field.	Contact tech support and we will give you a hash for the API
3	directoryid	integer	id reference	Required field.
6	recordid	integer	id directory entries	Optional field.
7	dataFromBody	boolean	Take data not from arguments, but from body	Optional field.	If dataFromBody = 1 is passed, then data will be taken not from arguments, but from the request body. Json must be passed to the body, in which the keys must be the parameters described above. login and password should be sent as usual

Add multiple entries to the directory, method: /api/directory/change/?actiontype=insert

Parameters

Example:

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

№	Field	Type	Description	Required or not	Comment
1	login	string	Login in BOX system	Required field.
2	password	string	Password in md5 format	Required field.	Contact tech support and we will give you a hash for the API
3	directoryid	integer	id reference	Required field.
4	massivechange	json	Array in json format with data required for insertion		The array should consist of associative arrays with data to insert a record into the directory. This array must contain data in the format KEY = VALUE, where KEY is the identifier of the required field
5	dataFromBody	boolean	Take data not from arguments, but from body	Optional field.	If dataFromBody = 1 is passed, then data will be taken not from arguments, but from the request body. Json must be passed to the body, in which the keys must be the parameters described above. login and password should be sent as usual

Editing multiple entries in the directory, method: /api/directory/change/?actiontype=update

Parameters

Example:

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

№	Field	Type	Description	Required or not	Comment
1	login	string	Login in BOX system	Required field.
2	password	string	Password in md5 format	Required field.	Contact tech support and we will give you a hash for the API
3	directoryid	integer	id reference	Required field.
5	data	array	reference fields to update		Associative array of values for editing the directory. The array contains values in the format KEY = VALUE, where KEY is the identifier of the required field
6	id or recordid	integer	id directory entries	Optional field.	If you want to change a specific directory entry
7	[KEY]	string	dictionary fields		To find the required record for editing, you can send a value in the format KEY = VALUE, where KEY is the identifier of the required field
4	massivechange	json	Array in json format with data required for editing		The array should consist of associative arrays with data to insert a record into the directory. Every associative array must have this structure: id or recordid - to edit a specific directory entry (optional parameter) data - associative array with data to update other parameters for searching for a record in the directory in the format KEY = VALUE, where KEY is the identifier of the required field
5	dataFromBody	boolean	Take data not from arguments, but from body	Optional field.	If dataFromBody = 1 is passed, then data will be taken not from arguments, but from the request body. Json must be passed to the body, in which the keys must be the parameters described above. login and password should be sent as usual

Retrieve one or all directory entries, method: /api/directory/get/

Parameters

Example:

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

№	Field	Type	Description	Required or not	Comment
1	login	string	Login in BOX system	Required field.
2	password	string	Password in md5 format	Required field.	Contact tech support and we will give you a hash for the API
3	directoryid	integer	id reference	Required field.
4	recordid	integer	id directory entries	Optional field.	If you would like to get a specific directory entry

API references

Thanks for your choice.