www.refworks.com/api2/?class=authentication&method=newsess&<signature related parameters>
authentication
.newsess
.true
returns the user access privileges. Defaults to false
. See User::privileges method for the user access privileges details.true
returns the user settings. Defaults to false
. See User::getsettings method for the user settings details.true
returns the subscriber information for the user's associated subscriber. Defaults to false
. See Subscriber class for the subscriber information details.<AcctInfo>
groupCode
or id
.Attributes | Values |
---|---|
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>
Attributes | Values |
---|---|
update | Set to yes if you want to update the user's last login information; otherwise no |
<LastBrowser>
<LastLogin>
element's "update" attribute is yes
) This is the user's browser information.Attributes | Values |
---|---|
httpuseragent | HTTP_USER_AGENT |
remoteaddr | REMOTE_ADDR |
httpacceptlanguage | HTTP_ACCEPT_LANGUAGE |
Status Code | Description |
---|---|
200 | Success |
401 | Invalid - groupCode, loginName or password combination |
404 | The subscription has expired LastBrowser element is missing |
410 | Subscription is at a different URL such as the Toronto servers, the status message contains the correct URL |
500 | Error updating the last login information |
503 | This subscription is currently down for maintenance - try again later |
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. |