RefWorks REST Interface
Overview Utility Class backup Method
backup Method
Returns a backup file of a user's account that can be used to restore the user's account.

Note:  This call is not allowed in Batch::call method.

www.refworks.com/api2/?class=utility&method=backup&includerefs=true&includerss=true&includeattachments=true&id=<ID of output style to backup>&<signature related and sess parameters>
Parameters
class
Set to utility.
method
Set to backup.
includerefs
Set to true to include references in backup; otherwise set to false to not back up references.
includerss
Set to true to include RSS Feeds in the backup; otherwise set to false to not back up RSS Feeds.
includeattachments
Set to true to include attachments in the backup; otherwise set to false to not back up attachments.
id
ID of the output style that you would like included in the backup.  More than one id parameter can be passed if backing up multiple output styles.
language
(Optional) Default is en for English.  Set to the first value in the HTTP_ACCEPT_LANGUAGE return by the browser or set to a value from Properties::languages method.
HTTP Verbs
GET
HTTP Return Status Codes
This status code is only returned in the Response XML if an error occurred during backup.
Status CodeDescription
500An error occurred
Response XML
The backup file is returned in the Response stream.  If an error occurred, the Response is XML with the status code.
Methods
backup Method | restore Method | sendemail Method
See Also
Overview | Attachments Class | Authentication Class | Authors,Descriptors,Periodicals,Folders Class | Batch Class | Deleted Class | ImportFilter Class | Manuscript Class | MyList Class | OutputStyle Class | Properties Class | PubMed Class | Reference Class | Retrieve Class | RSS Class | SavedSearch Class | ShareProperties Class | Subscriber Class | SubscriberPrefs Class | User Class | Utility Class | Z39 Class
Modifications
Tue Jul 13 2010      Added "language" parameter.
Fri Jan 15 2010      This call is not allowed in Batch::call.
Fri May 1 2009      Added.
View All API Modifications


C O N F I D E N T I A L