Zimbra REST API Reference:Get Briefcase: Difference between revisions
Line 41: | Line 41: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/Briefcase?fmt=xml | http://localhost:7070/home/john.doe/Briefcase?fmt=xml | ||
</pre> | |||
Retrieve the list of items in the "Briefcase" folder in RSS format: | |||
<pre> | |||
http://localhost:7070/home/john.doe/Briefcase?fmt=rss | |||
</pre> | </pre> | ||
Revision as of 22:45, 20 January 2010
<< Back to Zimbra REST API Reference
REST API Method: Get Briefcase
Gets the list of items in the briefcase folder. The default folder is "Briefcase" but user-defined folders are also supported.
URL
http://localhost:7070/home/john.doe/Briefcase?{params}
HTTP Method
GET
Formats
xml,json,rss,zip,tar,tgz
(Go to Response Formats)
Note: When using the zip,tar,tgz
formats, the items in the briefcase folder are packaged in the archive.
Requires Authentication
true
(Go to Authentication)
Parameters
fmt
. Required. The response format.
Usage Examples
Retrieve the list of items in the "Briefcase" folder in JSON format:
http://localhost:7070/home/john.doe/Briefcase?fmt=json
Retrieve the list of items in the "Briefcase" folder in XML format:
http://localhost:7070/home/john.doe/Briefcase?fmt=xml
Retrieve the list of items in the "Briefcase" folder in RSS format:
http://localhost:7070/home/john.doe/Briefcase?fmt=rss
Download all items in the "Briefcase" folder in a ZIP archive:
http://localhost:7070/home/john.doe/Briefcase?fmt=zip
Retrieve the user-defined folder "MyBriefcaseFolder", in JSON format:
http://localhost:7070/home/john.doe/MyBriefcaseFolder?fmt=json