RefWorks API - Reference Guide

class: Set to user
method: Set to getsettings

GET

<numRefsPerPage>

Number of references to display in the reference list. Must be a number between 1-500.

<defaultRefListView>

Default display view of references in the reference list.

Value	Description
0	Standard View
1	One-line Cite View
2	Full View
3	Output Style View

<defaultRefListViewOSID>

(Only used if "defaultRefListView" element is 3, Output Style View) ID of output style. Note: This output style ID should also be in a "refViewOSID" element.

<refViewOSID>

There may be more then one of these elements. These are output styles the user has selected to be available for displaying references in references lists and view reference pages. See the Output Style class for information on how to get output style IDs.

<showFoldersInRefList>

true if folder names are to be displayed next to references in reference lists.

<authorResolverSetting>

Value of 0 to 5 indicating the minimum Author Resolver bars to be displayed.

<MarkDupsInDupSearch>

If true, candidate duplicates are automatically marked for deletion after a duplicate check.

<startupfolder>

Contains the name of a folder whose references is displayed when the application starts up. If not set, all references are displayed.

<defaultReflistSort>

Default sort order of the reference list displayed when the application starts up.

Value	Description
0	Primary Author ASC
1	Pub Year DESC
2	Pub Year ASC
3	Ref ID ASC
4	Ref Type ASC
5	Title Primary ASC
6	Periodical Full ASC
7	Periodical Abrev ASC
8	Date Created DESC
9	Date Last Modified DESC

<sortCollationID>

ID of the sort collation selected by the user. See the sortlocales method in the Properties class.

<startupScreenReaderMode>

If true, the user interface should default to screen reader mode.

<defaultImportSourceType>

Default value for the Source Type field in a reference when adding a new reference or importing a reference.

Value	Description
0	Print
1	Electronic

<pubMedLinks>

If true, the user has selected to provide links back to PubMed for references that contain PMIDs. Note that the "enabledForUser" attribute must be true for this link back to PubMed option is available to the user. Administrators have the rights to set the "enabledForUser" attribute.

<scopusLinks>

Similar to <pubmedLinks> element, only for Scopus. If the reference contains Scoups IDs, then links back to Scopus show in the reference. Note that the "enabledForUser" attribute must be true for this link back to Scopus option is available to the user. Administrators have the rights to set the "enabledForUser" attribute.

<enableTermAssistant>

If true, when users are entering authors, descriptors, periodical names, a popup box appears with a list of existing terms which the user can choose from or they can continue to enter the term in manually.

<defaultOutputLanguage>

Contains the default output language ID to assign to references as they are entered and imported. The output language effects how a specific reference is formated. See outputlanguage method of the Properties class for available IDs.

<accuciteOSID>

ID of the output style to use for the Accucite feature.

<customUserFieldLabel>

Contains the custom label assigned to a specific user definable field.

Attribute	Value
fieldNum	Number between 1 and 15 corresponding to the user definable field.

<lastUISelected>

The last user interface the user selected.

Value	Description
`0`	None
`1`	RW Classic
`2`	RW 2

Status Code	Description
200	Success
500	Internal server error

Wed Jan 27 2010		Added "lastUISelected" element.
Mon Aug 3 2009		Added "defaultRefListView" and "defaultRefListViewOSID" elements.
Tue May 5 2009		Renamed from settings to getsettings.

View All API Modifications