RefWorks REST Interface
Overview retrieve Class folder Method
folder Method
Returns all the references associated with a folder. To return references from "Last Imported" or "deleted" folders use the specialfolder method.
<baseurl>/?class=retrieve&method=folder&search=RefsIWrote&pgnum=1&pgsize=25&<signature related and sess parameters>

Important RefShare information-Sessions created with authentication::newrefsharesess can limit the results that are returned by this method.
The results are sorted by Reference ID number by default.
Parameters
class
Set to retrieve
method
Set to folder
search
folder to search for
retrieve
pgnum
Indicates which page of references to return.  First page is 1.
pgsize
Indicates how many references are on a page.  Passing a value of 0 results in no references being returned.
sort
(Optional; Not used in Z39.50 class methods) Indicates how to sort the references returned.   Defaults differ depending on method called.  Supported values are:
ValueField
0Authors, Primary
1Pub Year, descending
2Pub Year, ascending
3Ref ID
4Ref Type
5Title, Primary
6Periodical, Full
7Periodical, Abbreviated
8Creation Date Time, descending
9Last Modified Date Time, descending
10(Used only for a Retrieve::quick method)  Relevancy
11(Used only for a Retrieve::dup method)  Duplicate
12Last Modified Date Time, ascending
style
(Optional) Indicates the output style used to format the references.   Default is 0 which is the RefWorks XML format (unformatted).   NOTE:  There can be more than one style parameter passed to allow for getting multiple styles.
ValueDescription
<Output style ID>ID of desired output style.  See the OutputStyle class for IDs.
0RefWorks XML format (unformatted).
-1Reference IDs in XML format.
-2RefWorks XML format with a modified <lv> element.   This modified <lv> element contains <item> elements with the vendor information.  For example,
   <lv>
      <item vendor="PUBMED" id="PMID" value="16249332" />
      <item vendor="PUBMED" id="PMCID" value="PMC1276082" />
   </lv>
language
(Optional and only used if the "style" parameter passed is an output style ID) 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.
format
(Optional) Indicates the file type to format the references.  Default is html.
ValueDescription
htmlHTML
textUTF-8 text
biblist
(Optional; Used only if an output style ID is specified in the style parameter)   If true, all references are returned as a bibliography list in the output style specified.   If false, each reference is separated into its own <reference> element in the output style specified.  Default is false.
HTTP Verbs
GET
Performs the search and returns results
HTTP Return Status Codes
Status CodeDescription
200OK
404no refs found
400Bad request
401Unauthorized request
Methods
advancesearch Method | all Method | author,descriptor,periodical Method | byid (GET) Method | byid (POST) Method | count Method | dup Method | folder Method | modsince Method | nofolder Method | openurl (GET) Method | openurl (POST) Method | quick Method | saved Method | specialfolder 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.
Tue Sep 22 2009      Added "biblist" parameter and allow multiple "style" parameters.
View All API Modifications


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