author,descriptor,periodical Method
Returns References that contain the specific Author,Descriptor or Periodical. An exact(case insenstive) match of the search parameter is performed. For wildcard searching use the advance search method
<baseurl>/?class=retrieve&method=author&search=beutler,E.B.&pgnum=1&pgsize=25&sort=3&<signature related and sess parameters>
The results are sorted by Reference ID by default.
Important RefShare information-Sessions created with authentication::newrefsharesess can limit the results that are returned by this method.Parameters
- class
- Set to
retrieve - method
- Set to value depending on the method
| Value | Method |
|---|
author | Search author |
descriptor | Search descriptor |
periodical | Search periodical |
- search
- Should contain the Author, Descriptor or periodical on which to conduct the search.
- folder
- Optional - To limit a search to within a specific folder, pass a limiting folder in the parameter. Default is to perform the search accross intire user account.
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:
| Value | Field |
|---|
0 | Authors, Primary |
1 | Pub Year, descending |
2 | Pub Year, ascending |
3 | Ref ID |
4 | Ref Type |
5 | Title, Primary |
6 | Periodical, Full |
7 | Periodical, Abbreviated |
8 | Creation Date Time, descending |
9 | Last Modified Date Time, descending |
10 | (Used only for a Retrieve::quick method) Relevancy |
11 | (Used only for a Retrieve::dup method) Duplicate |
12 | Last 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. | Value | Description |
|---|
| <Output style ID> | ID of desired output style. See the OutputStyle class for IDs. |
0 | RefWorks XML format (unformatted). |
-1 | Reference IDs in XML format. |
-2 | RefWorks 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. | Value | Description |
|---|
html | HTML |
text | UTF-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 Code | Description |
|---|
| 200 | OK |
| 404 | not found |
| 400 | Bad request |
| 401 | Unauthorized request |
Methods
See Also
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
