add_to_tag

 

Description REST SOAP XML

---

Description

 

This method applies a tag or tags to a designated file or folder.

 

 

Input parameters:

 

Name	Type	Description
api_key	string	The API key obtained when registering a project with OpenBox.
auth_token	string	The authentication token obtained when a user authenticates your application with Box.
target	string	The type of item to be tagged.  Can be 'file' or 'folder'.
target_id	long	The id of the item you wish to tag.  If the target is a folder, this will be the folder_id.  If the target is a file, this will be the file_id.
tags	ArrayOfString	A List of tags to apply to the file when copied into the user's own folder.

 

 

Output parameters:

 

Name	Type	Description
status	string	If the operation was successful, the status will be 'addtotag_ok' If the operation was not successful, the status field can be: 'not_logged_in' 'application_restricted' 'addtotag_error'

 

 

REST

 

Request

 

https://www.box.net/api/1.0/rest?action=add_to_tag&api_key=p6eu1n2tblaeebnfkyby4gfkg6mrz0xp&auth_token=qydz66sfc6pqb2mnk565izn5m870ghs2&tags[]=test_tag&tags[]=test_tag1&target=file&target_id=6343

 

 

Response

 

<?xml version='1.0' encoding='UTF-8' ?>

<response>

<status>addtotag_ok</status>

</response>

SOAP

 

Request

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:tns="urn:boxnet"

xmlns:types="urn:boxnet/encodedTypes"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

>

<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<tns:add_to_tag>

<api_key xsi:type="xsd:string">rrc1d3ntb53tt6b2vhail6rdtrsxov3v</api_key>

<sid xsi:type="xsd:string">f3704d9358146e51f5819ea4d755b1c5</sid>

<tags xsi:type="xsd:ArrayOfString">
<item xsi:type="xsd:string">test_tag</item>
<item xsi:type="xsd:string">test_tag1</item>
</tags>
<target xsi:type="xsd:string">folder</target>
<target_id xsi:type="xsd:long">6343</target_id>

</tns:add_to_tag>

</soap:Body>

</soap:Envelope>

 

Response

 

<SOAP-ENV:Envelope  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:ns4="urn:boxnet"

SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<SOAP-ENV:Body>

<ns4:add_to_tagResponse>

<status xsi:type="xsd:string">addtotag_ok</status>
</ns4:add_to_tagResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

XML

 

Request

 

<?xml version='1.0' encoding='UTF-8' ?>

<request>

<action>add_to_tag</action>

<api_key>p6eu1n2tblaeebnfkyby4gfkg6mrz0xp</api_key>

<auth_token>8bp4l5h28pkyfrdz40v5mdru8k59d6d9</auth_token>

<tags><item>test_tag</item><item>test_tag1</item></tags>

<target>file</target>

<target_id>6334</target_id>

</request>

 

Response

 

<?xml version='1.0' encoding='UTF-8' ?>

<response>

<status>addtotag_ok</status>

</response>

 

---

 

Need additional assistance? Please feel free to Contact us