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>
authentication
.newrefsharesess
.<shareurlpath>
element returned in ShareProperties class' methods.y
if the folder name in the "site" parameter is encoded.true
to return the share properties from this RefShare. Default is false
. See ShareProperties::all method for the share properties details.true
to return the user access privileges. Default is false
. See User::privileges method for the user access privileges details.true
to return the user settings. Default is false
. See User::getsettings method for the user settings details.true
to return the subscriber information for the user's associated subscriber. Default is false
. See Subscriber class for the subscriber information details.Status Code | Description |
---|---|
200 | Success |
400 | RefShare not allowed for this subscriber Invalid IP address for access to this RefShare Unknown error related to this IP address |
401 | Specified user is not authorized to share data No site information passed |
404 | Specified user was not found Subscriber site information was not found in our database |
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. |