RefWorks REST Interface
Overview authentication Class newsess Method
newsess Method
Creates and returns a new session for use with other parts of the API.  This call can be made using SSL to secure the login information.
www.refworks.com/api2/?class=authentication&method=newsess&<signature related parameters>
Parameters
class
Set to authentication.
method
Set to newsess.
privileges
(Optional) If set to true returns the user access privileges.  Defaults to false.  See User::privileges method for the user access privileges details.
settings
(Optional) If set to true returns the user settings.  Defaults to false.  See User::getsettings method for the user settings details.
subscriber
(Optional) If set to true returns the subscriber information for the user's associated subscriber.  Defaults to false.  See Subscriber class for the subscriber information details.
HTTP Verbs
POST
XML to POST

XML Elements
<AcctInfo>
Must specify either the groupCode or id.
AttributesValues
id(Required if groupCode not specified) Subscriber ID.
groupCode(Required if id not specified) Subscriber group code.
loginName(Required) Login name of the user's account.
password(Required) Password of the user's account.
<LastLogin>
AttributesValues
updateSet to yes if you want to update the user's last login information; otherwise no
<LastBrowser>
(Required if <LastLogin> element's "update" attribute is yes) This is the user's browser information.
AttributesValues
httpuseragentHTTP_USER_AGENT
remoteaddrREMOTE_ADDR
httpacceptlanguageHTTP_ACCEPT_LANGUAGE
HTTP Return Status Codes
Status CodeDescription
200Success
401Invalid - groupCode, loginName or password combination
404The subscription has expired
LastBrowser element is missing
410Subscription is at a different URL such as the Toronto servers, the status message contains the correct URL
500Error updating the last login information
503This subscription is currently down for maintenance - try again later
Methods
delsess Method | newrefsharesess Method | newsess Method | newtempusersess Method | ping Method | userexists 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
Thu Apr 22 2010      Added "id" attribute to <AcctInfo> element.
Tue Jun 30 2009      Corrected spelling of "priviledges" parameter to "privileges".
Wed Apr 22 2009      Added optional "subscriber" parameter so that subscriber related information can be returned.
Mon Apr 6 2009      Added new status codes to handle account maintenance and account expiration, etc.
Wed Mar 18 2009      Made privileges optional via a query string parameter.  Also added the ability to optionally return the users custom settings.
Thu Feb 26 2009      Now returns user privileges in the response XML.
View All API Modifications


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