private_share

 

Description REST SOAP XML

---

Description

 

This method privately shares a file or folder with another user(s).

 

 

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 shared.  This can be set as 'file' or 'folder'.
target_id	long	The id of the item you wish to share.  If the target is a folder, this will be the folder_id.  If the target is a file, this will be the file_id.
message	string	An message to be included in a notification email.
emails	ArrayOfString	An array of emails for which to notify users about the newly shared file or folder.
notify	string	If this parameter is true, then a notification email will be sent to users.

 

Output parameters:

 

Name	Type	Description
status	string	If the operation was successful, the status parameter will be 'private_share_ok'. If the operation was not successful, the status field can be: 'not_logged_in' - The user is not logged into your application.  Your authentication_token is not valid. 'application_restricted'- You provided an invalid api_key, or the api_key is restricted from calling this function. 'wrong_node' - The item_id may be invalid.  Verify that the item_id is a valid id for an item in the user's account. 'private_share_error' - For all other errors.  Verify that your target is 'file' or 'folder', and that the new name contains valid characters.

 

 

REST

 

Request

 

https://www.box.net/api/1.0/rest?action=private_share&api_key=rrc1d3ntb53tt6b2vhail6rdtrsxov3v&auth_token=7pdreq6aqtq7udn986mxnp8lpq1ol0ec&target=folder&target_id=4935&emails[]=email@example.com&message=hey&notify=true

 

 

Response

 

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

<response>

<status>private_share_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:private_share>

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

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

<target xsi:type="xsd:string">file</target>

<target_id xsi:type="xsd:long">3687</target_id>

<emails href="#id1" />

<message xsi:type="xsd:string">message here</message>

<notify xsi:type="xsd:boolean">true</notify>

</tns:private_share>

<soapenc:Array id="id1" soapenc:arrayType="xsd:string[1]">

<Item>some@email.com</Item>

</soapenc:Array>

</soap:Body>

</soap:Envelope>

 

Response

 

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

<SOAP-ENV:Envelope  xmlns:SOAP-ENV="http://sch'mas.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:private_shareResponse>

<status xsi:type="xsd:string">private_share_ok</status>

</ns4:private_shareResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

XML

 

Request

 

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

<request>

<action>private_share</action>

<api_key>rrc1d3ntb53tt6b2vhail6rdtrsxov3v</api_key>

<auth_token>7pdreq6aqtq7udn986mxnp8lpq1ol0ec</auth_token>

<target>file</target>

<target_id>4935</target_id>

<emails>

<item>email@example.com</item>

</emails>

<message>hey</message>

<notify>true</notify>

</request>

Response

 

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

<response>

<status>private_share_ok</status>

</response>

 

---

 

Need additional assistance? Please feel free to Contact us