SOAP Overview
More information on the SOAP method can be found at http://en.wikipedia.org/wiki/SOAP
Box.net's SOAP Server Endpoint
The SOAP Server Endpoint URL is https://box.net/api/1.0/soap
The WSDL for our API Web Service can be downloaded here
Data Types
SOAPUser:
| Property |
Type |
Description |
| login |
string |
The user's login name. |
| email |
string |
The user's email address. |
| access_id |
int |
If the user is a guest, the access_id will be the user_id of the guest's parent. If this is a full user, the access_id will be the same as the user_id. |
| user_id |
int |
The unique id that Box.net associates with that user. |
| space_amount |
long |
The total amount of space allocated to that account. |
| space_used |
long |
The amount of space currently utilized by the user. |
SOAPFolder:
| Property |
Type |
Description |
| folder_id |
long |
A unique id for Box.net to identify the user. This is used as an input for many folder-oriented API calls. |
| folder_name |
string |
The name of the folder that is displayed to the user. |
| folder_type_id |
long |
This can be ignored. |
| user_id |
int |
The user_id of the user who owns the folder. |
| path |
string |
The path of the folder from the root. |
| shared |
int |
This value will be 0 if the file is private, and 1 if the file is shared. |
| public_name |
string |
If the file is shared, this URL can be used to display a shared page. |
| password |
string |
If the file is shared and password protected, this is the password associated with that file. |
| parent_folder_id |
long |
The folder_id of the folder's parent. |
SOAPFileInfo:
| Property |
Type |
Description |
| file_id |
long |
A unique id for Box.net to identify the file. This is used as an input for many file-oriented API methods. |
| file_name |
string |
The name of the file that is displayed to the user. |
| folder_id |
long |
The folder_id in which the file resides. |
| shared |
int |
This value will be 0 if the file is private, and 1 if the file is shared. |
| public_name |
string |
If the file is shared, this URL can be used to display a shared page. |
| size |
long |
The size of the file in bytes. |
| description |
string |
The file's description. |
| sha1 |
string |
This is currently not in use. |
| created |
created |
A Unix-format of the time and date that this file was created. |
| updated |
updated |
A Unix-format of the time and date that this file was last updated. |
Need additional assistance? Please feel free to Contact us
