Changes between Version 31 and Version 32 of WebRpc


Ignore:
Timestamp:
Jan 21, 2009, 12:34:47 PM (17 years ago)
Author:
feet1st
Comment:

Replace references to "Account Key" with "authentication string"

Legend:

Unmodified
Added
Removed
Modified

  • WebRpc

    v31 v32  
    448448
    449449 '''action'''::
    450         If an account with the given email address doesn't exist, return an error. If passwd_hash is given and is correct, return the account key.
     450        If an account with the given email address doesn't exist, return an error. If passwd_hash is given and is correct, returns the authenticator. This authentication string is used for other RPC requests.
    451451
    452452{{{
    … …  
    481481</font>
    482482}}}
    483  Account key to retrieve information about.
     483 Authentication string for account to retrieve information about.
    484484   [[BR]] [[BR]]
    485485 '''examples'''::
    … …  
    542542</font>
    543543}}}
    544  Account key of user to alter settings for.    [[BR]] [[BR]]
     544 Authentication string of user account being changed.    [[BR]] [[BR]]
    545545{{{
    546546#!html
    … …  
    705705</font>
    706706}}}
    707      [[BR]] [[BR]]
     707 Authentication string of user account owning the host being changed.     [[BR]] [[BR]]
    708708{{{
    709709#!html
    … …  
    763763<font color=darkgreen face="monospace">
    764764}}}
    765         {{{id}}}:
    766 {{{
    767 #!html
    768 </font>
    769 }}}
    770  (user ID) or auth: (account key)  [[BR]] [[BR]]
    771 {{{
    772 #!html
    773 <font color=darkgreen face="monospace">
    774 }}}
    775         {{{format}}}:
    776 {{{
    777 #!html
    778 </font>
    779 }}}
    780  output formatting. 'xml' is only supported value (deafult is HTML formatting)  [[BR]] [[BR]]
     765        [ id: ]
     766{{{
     767#!html
     768</font>
     769}}}
     770 User ID to display. Either id: or auth: must be specified. [[BR]] [[BR]]
     771{{{
     772#!html
     773<font color=darkgreen face="monospace">
     774}}}
     775        [ auth: ]
     776{{{
     777#!html
     778</font>
     779}}}
     780 Authentication string of user to display. Either id: or auth: must be specified. [[BR]] [[BR]]
     781{{{
     782#!html
     783<font color=darkgreen face="monospace">
     784}}}
     785        format:
     786{{{
     787#!html
     788</font>
     789}}}
     790 output formatting. 'xml' is only supported value (default is HTML formatting)  [[BR]] [[BR]]
    781791 '''examples'''::
    782792        http://boinc.bakerlab.org/rosetta/show_user.php?userid=123&format=xml
    … …  
    835845
    836846 '''action'''::
    837         Returns info about an account.  If called with the account key, returns a list of hosts associated with the account.
     847        Returns info about an account.  If called with the authentication string, returns a list of hosts associated with the account.
    838848{{{
    839849#!html
    … …  
    876886</font>
    877887}}}
    878   [[BR]] [[BR]]
     888 Authentication string for user account to retrieve pending credit information about. [[BR]] [[BR]]
    879889 '''examples'''::
    880890        http://boinc.bakerlab.org/rosetta/pending.php?format=xml&authenticator=X
    … …  
    922932</font>
    923933}}}
    924  identifies team founder.  [[BR]] [[BR]]
     934 Authentication string of team founder's user account.  [[BR]] [[BR]]
    925935{{{
    926936#!html
    … …  
    11591169<font color=darkgreen face="monospace">
    11601170}}}
    1161         account_key:
    1162 {{{
    1163 #!html
    1164 </font>
    1165 }}}
    1166  account key of team founder (optional)   [[BR]] [[BR]]
     1171        [ account_key: ]
     1172{{{
     1173#!html
     1174</font>
     1175}}}
     1176 Authentication string of a team administrator's user account.  [[BR]] [[BR]]
    11671177{{{
    11681178#!html
    … …  
    11841194    <user>
    11851195        <id>1</id>
    1186         <email_addr>pdq@usndathoople.edu</email_addr>
    1187         <email_ok>yes|no</email_ok>
     1196        [ <email_addr>pdq@usndathoople.edu</email_addr> ]
     1197        [ <email_ok>yes|no</email_ok> ]
    11881198        <cpid>232f381c79336f0bd8df02bbce2f2217</cpid>
    11891199        <create_time>1076897105</create_time>
    … …  
    12011211
    12021212 '''action'''::
    1203         Show list of team members.     If account key is that of a team admin, show email addresses, and flags indicating whether the user opted out of getting emails.
     1213        Show list of team members.   If authentication string is that of a team administrator, show email addresses, and flag indicating whether the user opted out of getting emails.
    12041214
    12051215{{{
    … …  
    12351245</font>
    12361246}}}
    1237      [[BR]] [[BR]]
    1238 {{{
    1239 #!html
    1240 <font color=darkgreen face="monospace">
    1241 }}}
    1242         avatar_url:
     1247 Authentication string of user account to change preferences for.   [[BR]] [[BR]]
     1248{{{
     1249#!html
     1250<font color=darkgreen face="monospace">
     1251}}}
     1252        [ avatar_url: ]
    12431253{{{
    12441254#!html
    … …  
    12501260<font color=darkgreen face="monospace">
    12511261}}}
    1252         avatar_select:
    1253 {{{
    1254 #!html
    1255 </font>
    1256 }}}
    1257      [[BR]] [[BR]]
    1258 {{{
    1259 #!html
    1260 <font color=darkgreen face="monospace">
    1261 }}}
    1262         forum_images_as_links:
     1262        [ avatar_select: ]
     1263{{{
     1264#!html
     1265</font>
     1266}}}
     1267     [[BR]] [[BR]]
     1268{{{
     1269#!html
     1270<font color=darkgreen face="monospace">
     1271}}}
     1272        [ forum_images_as_links: ]
    12631273{{{
    12641274#!html
    … …  
    12701280<font color=darkgreen face="monospace">
    12711281}}}
    1272         forum_link_externally:
     1282        [ forum_link_externally: ]
    12731283{{{
    12741284#!html
    … …  
    12801290<font color=darkgreen face="monospace">
    12811291}}}
    1282         forum_hide_avatars:
    1283 {{{
    1284 #!html
    1285 </font>
    1286 }}}
    1287      [[BR]] [[BR]]
    1288 {{{
    1289 #!html
    1290 <font color=darkgreen face="monospace">
    1291 }}}
    1292         forum_hide_signatures:
    1293 {{{
    1294 #!html
    1295 </font>
    1296 }}}
    1297      [[BR]] [[BR]]
    1298 {{{
    1299 #!html
    1300 <font color=darkgreen face="monospace">
    1301 }}}
    1302         forum_jump_to_unread:
    1303 {{{
    1304 #!html
    1305 </font>
    1306 }}}
    1307      [[BR]] [[BR]]
    1308 {{{
    1309 #!html
    1310 <font color=darkgreen face="monospace">
    1311 }}}
    1312         forum_ignore_sticky_posts:
    1313 {{{
    1314 #!html
    1315 </font>
    1316 }}}
    1317      [[BR]] [[BR]]
    1318 {{{
    1319 #!html
    1320 <font color=darkgreen face="monospace">
    1321 }}}
    1322         forum_low_rating_threshold:
    1323 {{{
    1324 #!html
    1325 </font>
    1326 }}}
    1327      [[BR]] [[BR]]
    1328 {{{
    1329 #!html
    1330 <font color=darkgreen face="monospace">
    1331 }}}
    1332         forum_high_rating_threshold:
    1333 {{{
    1334 #!html
    1335 </font>
    1336 }}}
    1337      [[BR]] [[BR]]
    1338 {{{
    1339 #!html
    1340 <font color=darkgreen face="monospace">
    1341 }}}
    1342         forum_minimum_wrap_postcount:
    1343 {{{
    1344 #!html
    1345 </font>
    1346 }}}
    1347      [[BR]] [[BR]]
    1348 {{{
    1349 #!html
    1350 <font color=darkgreen face="monospace">
    1351 }}}
    1352         forum_display_wrap_postcount:
    1353 {{{
    1354 #!html
    1355 </font>
    1356 }}}
    1357      [[BR]] [[BR]]
    1358 {{{
    1359 #!html
    1360 <font color=darkgreen face="monospace">
    1361 }}}
    1362         signature_enabled:
    1363 {{{
    1364 #!html
    1365 </font>
    1366 }}}
    1367      [[BR]] [[BR]]
    1368 {{{
    1369 #!html
    1370 <font color=darkgreen face="monospace">
    1371 }}}
    1372         signature:
    1373 {{{
    1374 #!html
    1375 </font>
    1376 }}}
    1377      [[BR]] [[BR]]
    1378 {{{
    1379 #!html
    1380 <font color=darkgreen face="monospace">
    1381 }}}
    1382         forum_sort:
    1383 {{{
    1384 #!html
    1385 </font>
    1386 }}}
    1387      [[BR]] [[BR]]
    1388 {{{
    1389 #!html
    1390 <font color=darkgreen face="monospace">
    1391 }}}
    1392         thread_sort:
    1393 {{{
    1394 #!html
    1395 </font>
    1396 }}}
    1397      [[BR]] [[BR]]
    1398 {{{
    1399 #!html
    1400 <font color=darkgreen face="monospace">
    1401 }}}
    1402         faq_sort:
    1403 {{{
    1404 #!html
    1405 </font>
    1406 }}}
    1407      [[BR]] [[BR]]
    1408 {{{
    1409 #!html
    1410 <font color=darkgreen face="monospace">
    1411 }}}
    1412         answer_sort:
    1413 {{{
    1414 #!html
    1415 </font>
    1416 }}}
    1417      [[BR]] [[BR]]
    1418 {{{
    1419 #!html
    1420 <font color=darkgreen face="monospace">
    1421 }}}
    1422         forum_filter_user:
     1292        [ forum_hide_avatars: ]
     1293{{{
     1294#!html
     1295</font>
     1296}}}
     1297     [[BR]] [[BR]]
     1298{{{
     1299#!html
     1300<font color=darkgreen face="monospace">
     1301}}}
     1302        [ forum_hide_signatures: ]
     1303{{{
     1304#!html
     1305</font>
     1306}}}
     1307     [[BR]] [[BR]]
     1308{{{
     1309#!html
     1310<font color=darkgreen face="monospace">
     1311}}}
     1312        [ forum_jump_to_unread: ]
     1313{{{
     1314#!html
     1315</font>
     1316}}}
     1317     [[BR]] [[BR]]
     1318{{{
     1319#!html
     1320<font color=darkgreen face="monospace">
     1321}}}
     1322        [ forum_ignore_sticky_posts: ]
     1323{{{
     1324#!html
     1325</font>
     1326}}}
     1327     [[BR]] [[BR]]
     1328{{{
     1329#!html
     1330<font color=darkgreen face="monospace">
     1331}}}
     1332        [ forum_low_rating_threshold: ]
     1333{{{
     1334#!html
     1335</font>
     1336}}}
     1337     [[BR]] [[BR]]
     1338{{{
     1339#!html
     1340<font color=darkgreen face="monospace">
     1341}}}
     1342        [ forum_high_rating_threshold: ]
     1343{{{
     1344#!html
     1345</font>
     1346}}}
     1347     [[BR]] [[BR]]
     1348{{{
     1349#!html
     1350<font color=darkgreen face="monospace">
     1351}}}
     1352        [ forum_minimum_wrap_postcount: ]
     1353{{{
     1354#!html
     1355</font>
     1356}}}
     1357     [[BR]] [[BR]]
     1358{{{
     1359#!html
     1360<font color=darkgreen face="monospace">
     1361}}}
     1362        [ forum_display_wrap_postcount: ]
     1363{{{
     1364#!html
     1365</font>
     1366}}}
     1367     [[BR]] [[BR]]
     1368{{{
     1369#!html
     1370<font color=darkgreen face="monospace">
     1371}}}
     1372        [ signature_enabled: ]
     1373{{{
     1374#!html
     1375</font>
     1376}}}
     1377     [[BR]] [[BR]]
     1378{{{
     1379#!html
     1380<font color=darkgreen face="monospace">
     1381}}}
     1382        [ signature: ]
     1383{{{
     1384#!html
     1385</font>
     1386}}}
     1387     [[BR]] [[BR]]
     1388{{{
     1389#!html
     1390<font color=darkgreen face="monospace">
     1391}}}
     1392        [ forum_sort: ]
     1393{{{
     1394#!html
     1395</font>
     1396}}}
     1397     [[BR]] [[BR]]
     1398{{{
     1399#!html
     1400<font color=darkgreen face="monospace">
     1401}}}
     1402        [ thread_sort: ]
     1403{{{
     1404#!html
     1405</font>
     1406}}}
     1407     [[BR]] [[BR]]
     1408{{{
     1409#!html
     1410<font color=darkgreen face="monospace">
     1411}}}
     1412        [ faq_sort: ]
     1413{{{
     1414#!html
     1415</font>
     1416}}}
     1417     [[BR]] [[BR]]
     1418{{{
     1419#!html
     1420<font color=darkgreen face="monospace">
     1421}}}
     1422        [ answer_sort: ]
     1423{{{
     1424#!html
     1425</font>
     1426}}}
     1427     [[BR]] [[BR]]
     1428{{{
     1429#!html
     1430<font color=darkgreen face="monospace">
     1431}}}
     1432        [ forum_filter_user: ]
    14231433{{{
    14241434#!html
    … …  
    14801490}}}
    14811491        userid:
    1482  numeric user ID in the database[[BR]] [[BR]]
    1483 {{{
    1484 #!html
    1485 </font>
    1486 }}}
     1492{{{
     1493#!html
     1494</font>
     1495}}}
     1496 Numeric user ID you wish to see forum data about. [[BR]] [[BR]]
    14871497{{{
    14881498#!html