RefWorks REST Interface
Overview authentication Class newrefsharesess Method
newrefsharesess Method
Creates a new RefShare session.  This method takes the site parameter passed on the query string and creates a special RefShare session.  This session provides read only access and limits reference access to those contained in the RefShare.  In other words, calls to Retrieve::quick, Retrieve::all, Retrieve::advancesearch automatically limits the results to the RefShare folder.
www.refworks.com/api2/?class=authentication&method=newrefsharesess&site=asdasdasdasdasdasdasdasd&ip=232.23.2.22&<signature related parameters>
Parameters
class
Set to authentication.
method
Set to newrefsharesess.
site
Set to the value of the <shareurlpath> element returned in ShareProperties class' methods.
enc
Pass y if the folder name in the "site" parameter is encoded.
ip
Set to the IP that the user's browser.  This is needed to restrict access for shares that are restricted by IP.
shareproperties
(Optional) Set to true to return the share properties from this RefShare.  Default is false.  See ShareProperties::all method for the share properties details.
privileges
(Optional) Set to true to return the user access privileges.  Default is false.  See User::privileges method for the user access privileges details.
settings
(Optional) Set to true to return the user settings.  Default is false.  See User::getsettings method for the user settings details.
subscriber
(Optional) Set to true to return the subscriber information for the user's associated subscriber.  Default is false.  See Subscriber class for the subscriber information details.
HTTP Verbs
GET
HTTP Return Status Codes
Status CodeDescription
200Success
400RefShare not allowed for this subscriber
Invalid IP address for access to this RefShare
Unknown error related to this IP address
401Specified user is not authorized to share data
No site information passed
404Specified user was not found
Subscriber site information was not found in our database
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
Tue Apr 13 2010      Added documentation for "enc" parameter.
Tue Jun 30 2009      Corrected spelling of "priviledges" parameter to "privileges".
Thu May 7 2009      Created.
View All API Modifications


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