RefWorks REST Interface
Overview retrieve Class advancesearch Method
advancesearch Method
Implements the advance search functionality of RefWorks.  See the RefWorks User documentation for details.

The search parameters are passed via a POST in an XML format as specified below.   the results are sorted by relevancy by default.

IMPORTANT REFSHARE INFORMATION: Sessions created with Authentication::newrefsharesess can limit the results that are returned by this method.

<baseurl>/?class=retrieve&method=advancesearch&classic=true&pgnum=1&pgsize=25&<signature related and sess parameters>
Parameters
class
Set to retrieve.
method
Set to advancesearch.
classic
Set to true to do a sequential search or false to a faster indexed search.   Default is true.
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
POST
POST the search parameters, perform the search and return results.
XML to POST

XML Elements
<AdvancedSearchStrategy>
Contains the advanced search parameters and folders to search.
AttributesValues
nameName of the Saved Search. Required only for SavedSearch::add and SavedSearch::edit.
<ParameterList>
Contains the list of "Parameter" elements.  Four "Parameter" elements maximum.
<Parameter>
Value to search for in the field.
AttributeValue
connectorNote: This attribute is ignored in the first "Parameter" element only.
and
or
not
field
<two-letter field tag>Specify field to search.
ALLSearch all fields.
ALLAUSearch all author fields.
ALLJOSearch all periodical fields.
searchempty
falseSearch for the value in the field.
trueSearch for an empty field; Ignores the value passed.
<FolderList>
Contains the list of "Folder" elements.
<Folder>
Name of folder to search.
HTTP Return Status Codes
Status CodeDescription
200Success.
400Bad request
401Unauthorized request
404No references found.
Response XML

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
Fri Jul 16 2010      Fixed bug when called in a batch process.retrieve
Tue Jul 13 2010      Added "language" parameter.
Mon Feb 1 2010      Added ability to search by "LV" field.
Tue Sep 22 2009      Added "biblist" parameter and allow multiple "style" parameters.
Mon Jul 27 2009      Added "classic" parameter.
Fri May 8 2009      Modified to limit results for RefShare.
Mon Apr 20 2009      Added.
View All API Modifications


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