Changes between Version 26 and Version 27 of WebRpc


Ignore:
Timestamp:
Jan 21, 2009, 10:26:30 AM (16 years ago)
Author:
feet1st
Comment:

Completed green coloration of all input parm names.

Legend:

Unmodified
Added
Removed
Modified

  • WebRpc

    v26 v27  
    414414}}}
    415415 '''input'''::
    416         {{{email_addr}}}: email address [[BR]]
    417         [ {{{passwd_hash}}}: ] the MD5 hash of the concatenation of the user's password and the email address.  [[BR]]
     416{{{
     417#!html
     418<font color=darkgreen face="monospace">
     419}}}
     420        email_addr:
     421{{{
     422#!html
     423</font>
     424}}}
     425 email address [[BR]] [[BR]]
     426{{{
     427#!html
     428<font color=darkgreen face="monospace">
     429}}}
     430        [ passwd_hash: ]
     431{{{
     432#!html
     433</font>
     434}}}
     435 the MD5 hash of the concatenation of the user's password and the email address.  [[BR]] [[BR]]
    418436 '''examples'''::
    419437        http://ralph.bakerlab.org/lookup_account.php?email_addr=feet1st@noyaspamhoo.com&passwd_hash=2ab598faf3160ccfa1a2d41a95557a92
    … …  
    450468}}}
    451469 '''input'''::
    452         {{{account_key}}}:
     470{{{
     471#!html
     472<font color=darkgreen face="monospace">
     473}}}
     474        account_key:
     475{{{
     476#!html
     477</font>
     478}}}
     479 Account key to retrieve information about.
     480   [[BR]] [[BR]]
    453481 '''examples'''::
    454482 '''output'''::
    … …  
    500528}}}
    501529 '''input'''::
    502         {{{account_key}}}:     [[BR]]
    503         [ {{{name}}}: ]     [[BR]]
    504         [ {{{country}}}: ]     [[BR]]
    505         [ {{{postal_code}}}: ]     [[BR]]
    506         [ {{{global_prefs}}}: ]     [[BR]]
    507         [ {{{project_prefs}}}: ]     [[BR]]
    508         [ {{{url}}}: ]     [[BR]]
    509         [ {{{send_email}}}: ]    [[BR]]
    510         [ {{{show_hosts}}}: ]     [[BR]]
    511         [ {{{teamid}}}: ]  ''zero means quit current team, if any''     [[BR]]
    512         [ {{{venue}}}: ]     [[BR]]
    513         [ {{{email_addr}}}: ]     [[BR]]
    514         [ {{{password_hash}}}: ]  [[BR]]
     530{{{
     531#!html
     532<font color=darkgreen face="monospace">
     533}}}
     534        account_key:
     535{{{
     536#!html
     537</font>
     538}}}
     539 Account key of user to alter settings for.    [[BR]] [[BR]]
     540{{{
     541#!html
     542<font color=darkgreen face="monospace">
     543}}}
     544        [ name: ]
     545{{{
     546#!html
     547</font>
     548}}}
     549     [[BR]] [[BR]]
     550{{{
     551#!html
     552<font color=darkgreen face="monospace">
     553}}}
     554        [ country: ]
     555{{{
     556#!html
     557</font>
     558}}}
     559     [[BR]] [[BR]]
     560{{{
     561#!html
     562<font color=darkgreen face="monospace">
     563}}}
     564        [ postal_code: ]
     565{{{
     566#!html
     567</font>
     568}}}
     569     [[BR]] [[BR]]
     570{{{
     571#!html
     572<font color=darkgreen face="monospace">
     573}}}
     574        [ global_prefs: ]
     575{{{
     576#!html
     577</font>
     578}}}
     579     [[BR]] [[BR]]
     580{{{
     581#!html
     582<font color=darkgreen face="monospace">
     583}}}
     584        [ project_prefs: ]
     585{{{
     586#!html
     587</font>
     588}}}
     589     [[BR]] [[BR]]
     590{{{
     591#!html
     592<font color=darkgreen face="monospace">
     593}}}
     594        [ url: ]
     595{{{
     596#!html
     597</font>
     598}}}
     599     [[BR]] [[BR]]
     600{{{
     601#!html
     602<font color=darkgreen face="monospace">
     603}}}
     604        [ send_email: ]
     605{{{
     606#!html
     607</font>
     608}}}
     609    [[BR]]  [[BR]]
     610{{{
     611#!html
     612<font color=darkgreen face="monospace">
     613}}}
     614        [ show_hosts: ]
     615{{{
     616#!html
     617</font>
     618}}}
     619     [[BR]] [[BR]]
     620{{{
     621#!html
     622<font color=darkgreen face="monospace">
     623}}}
     624        [ teamid: ]
     625{{{
     626#!html
     627</font>
     628}}}
     629  ''zero means quit current team, if any''     [[BR]] [[BR]]
     630{{{
     631#!html
     632<font color=darkgreen face="monospace">
     633}}}
     634        [ venue: ]
     635{{{
     636#!html
     637</font>
     638}}}
     639     [[BR]] [[BR]]
     640{{{
     641#!html
     642<font color=darkgreen face="monospace">
     643}}}
     644        [ email_addr: ]
     645{{{
     646#!html
     647</font>
     648}}}
     649     [[BR]] [[BR]]
     650{{{
     651#!html
     652<font color=darkgreen face="monospace">
     653}}}
     654        [ password_hash: ]
     655{{{
     656#!html
     657</font>
     658}}}
     659  [[BR]] [[BR]]
    515660 '''examples'''::
    516661 '''output'''::
    … …  
    545690}}}
    546691 '''input'''::
    547         {{{account_key}}}:     [[BR]]
    548         {{{hostid}}}:     [[BR]]
    549         {{{venue}}}:   [[BR]]
     692{{{
     693#!html
     694<font color=darkgreen face="monospace">
     695}}}
     696        account_key:
     697{{{
     698#!html
     699</font>
     700}}}
     701     [[BR]] [[BR]]
     702{{{
     703#!html
     704<font color=darkgreen face="monospace">
     705}}}
     706        hostid:
     707{{{
     708#!html
     709</font>
     710}}}
     711     [[BR]] [[BR]]
     712{{{
     713#!html
     714<font color=darkgreen face="monospace">
     715}}}
     716        venue:
     717{{{
     718#!html
     719</font>
     720}}}
     721   [[BR]] [[BR]]
    550722 '''examples'''::
    551723 '''output'''::
    … …  
    580752}}}
    581753 '''input'''::
    582         {{{id}}}: (user ID) or auth: (account key)  [[BR]]
    583         {{{format}}}: output formatting. 'xml' is only supported value (deafult is HTML formatting)  [[BR]]
     754{{{
     755#!html
     756<font color=darkgreen face="monospace">
     757}}}
     758        {{{id}}}:
     759{{{
     760#!html
     761</font>
     762}}}
     763 (user ID) or auth: (account key)  [[BR]] [[BR]]
     764{{{
     765#!html
     766<font color=darkgreen face="monospace">
     767}}}
     768        {{{format}}}:
     769{{{
     770#!html
     771</font>
     772}}}
     773 output formatting. 'xml' is only supported value (deafult is HTML formatting)  [[BR]] [[BR]]
    584774 '''examples'''::
    585775        http://boinc.bakerlab.org/rosetta/show_user.php?userid=123&format=xml
    … …  
    659849}}}
    660850 '''input'''::
    661         {{{format}}}:   Output formatting. 'xml' is only supported value (deafult is HTML formatting)  [[BR]]
    662         {{{authenticator}}}:  [[BR]]
     851{{{
     852#!html
     853<font color=darkgreen face="monospace">
     854}}}
     855        format:
     856{{{
     857#!html
     858</font>
     859}}}
     860 Output formatting. 'xml' is only supported value (deafult is HTML formatting)  [[BR]] [[BR]]
     861{{{
     862#!html
     863<font color=darkgreen face="monospace">
     864}}}
     865        authenticator:
     866{{{
     867#!html
     868</font>
     869}}}
     870  [[BR]] [[BR]]
    663871 '''examples'''::
    664872        http://boinc.bakerlab.org/rosetta/pending.php?format=xml&authenticator=X
    … …  
    696904}}}
    697905 '''input'''::
    698         {{{account_key}}}: identifies team founder.  [[BR]]
    699         {{{name}}}: name of team.   [[BR]]
    700         [ {{{url}}} ]: team URL.  [[BR]]
    701         {{{type}}}: one of [/team_types.php these types].   [[BR]]
    702         [ {{{name_html}}} ]: team name, with HTML formatting.  [[BR]]
    703         [ {{{description}}} ]: text describing team.  [[BR]]
    704         [ {{{country}}} ]: team country (if present, must be one of [/countries.php these countries]).  [[BR]]
     906{{{
     907#!html
     908<font color=darkgreen face="monospace">
     909}}}
     910        account_key:
     911{{{
     912#!html
     913</font>
     914}}}
     915 identifies team founder.  [[BR]] [[BR]]
     916{{{
     917#!html
     918<font color=darkgreen face="monospace">
     919}}}
     920        name:
     921{{{
     922#!html
     923</font>
     924}}}
     925 name of team.   [[BR]] [[BR]]
     926{{{
     927#!html
     928<font color=darkgreen face="monospace">
     929}}}
     930        [ url ]:
     931{{{
     932#!html
     933</font>
     934}}}
     935 team URL.  [[BR]] [[BR]]
     936{{{
     937#!html
     938<font color=darkgreen face="monospace">
     939}}}
     940        type:
     941{{{
     942#!html
     943</font>
     944}}}
     945 one of [/team_types.php these types].   [[BR]] [[BR]]
     946{{{
     947#!html
     948<font color=darkgreen face="monospace">
     949}}}
     950        [ name_html ]:
     951{{{
     952#!html
     953</font>
     954}}}
     955 team name, with HTML formatting.  [[BR]] [[BR]]
     956{{{
     957#!html
     958<font color=darkgreen face="monospace">
     959}}}
     960        [ description ]:
     961{{{
     962#!html
     963</font>
     964}}}
     965 text describing team.  [[BR]] [[BR]]
     966{{{
     967#!html
     968<font color=darkgreen face="monospace">
     969}}}
     970        [ country ]:
     971{{{
     972#!html
     973</font>
     974}}}
     975 team country (if present, must be one of [/countries.php these countries]).  [[BR]] [[BR]]
    705976 '''examples'''::
    706977 '''output'''::
    … …  
    7361007}}}
    7371008 '''input'''::
    738         {{{team_name}}}: Substring of team name  [[BR]]
    739         [ {{{format}}} ]:  Output formatting. 'xml' is only supported value (deafult is HTML formatting)  [[BR]]
     1009{{{
     1010#!html
     1011<font color=darkgreen face="monospace">
     1012}}}
     1013        team_name:
     1014{{{
     1015#!html
     1016</font>
     1017}}}
     1018 Substring of team name  [[BR]] [[BR]]
     1019{{{
     1020#!html
     1021<font color=darkgreen face="monospace">
     1022}}}
     1023        [ format ]:
     1024{{{
     1025#!html
     1026</font>
     1027}}}
     1028 Output formatting. 'xml' is only supported value (deafult is HTML formatting)  [[BR]] [[BR]]
    7401029 '''examples'''::
    7411030        http://boinc.bakerlab.org/team_lookup.php?team_name=BOINC&format=xml
    … …  
    7911080}}}
    7921081 '''input'''::
    793         {{{team_id}}}:
     1082{{{
     1083#!html
     1084<font color=darkgreen face="monospace">
     1085}}}
     1086        team_id:
     1087{{{
     1088#!html
     1089</font>
     1090}}}
     1091 Team number of the team to lookup. [[BR]] [[BR]]
    7941092 '''examples'''::
    7951093        http://boinc.bakerlab.org/rosetta/team_lookup.php?team_id=111
    … …  
    8351133}}}
    8361134 '''input'''::
    837         {{{teamid}}}: database ID of team     [[BR]]
    838         {{{account_key}}}: account key of team founder (optional)   [[BR]]
    839         {{{xml}}}: output formatting. 0=HTML, 1=XML. (default is 0)   [[BR]]
     1135{{{
     1136#!html
     1137<font color=darkgreen face="monospace">
     1138}}}
     1139        teamid:
     1140{{{
     1141#!html
     1142</font>
     1143}}}
     1144 database ID of team     [[BR]] [[BR]]
     1145{{{
     1146#!html
     1147<font color=darkgreen face="monospace">
     1148}}}
     1149        account_key:
     1150{{{
     1151#!html
     1152</font>
     1153}}}
     1154 account key of team founder (optional)   [[BR]] [[BR]]
     1155{{{
     1156#!html
     1157<font color=darkgreen face="monospace">
     1158}}}
     1159        xml:
     1160{{{
     1161#!html
     1162</font>
     1163}}}
     1164 output formatting. 0=HTML, 1=XML. (default is 0)   [[BR]] [[BR]]
    8401165 '''examples'''::
    8411166        http://boinc.bakerlab.org/rosetta/team_email_list.php?teamid=2241&account_key=Y&xml=1
    … …  
    8881213        (NOTE: this uses POST, not GET)
    8891214 '''input'''::
    890         {{{account_key}}}:     [[BR]]
    891         {{{avatar_url}}}: ''Note: the image will be downloaded and stored locally. Only JPG and PNG accepted.''     [[BR]]
    892         {{{avatar_select}}}:     [[BR]]
    893         {{{forum_images_as_links}}}:   [[BR]] 
    894         {{{forum_link_externally}}}:     [[BR]]
    895         {{{forum_hide_avatars}}}:     [[BR]]
    896         {{{forum_hide_signatures}}}:     [[BR]]
    897         {{{forum_jump_to_unread}}}:     [[BR]]
    898         {{{forum_ignore_sticky_posts}}}:     [[BR]]
    899         {{{forum_low_rating_threshold}}}:     [[BR]]
    900         {{{forum_high_rating_threshold}}}:     [[BR]]
    901         {{{forum_minimum_wrap_postcount}}}:     [[BR]]
    902         {{{forum_display_wrap_postcount}}}:     [[BR]]
    903         {{{signature_enabled}}}:     [[BR]]
    904         {{{signature}}}:     [[BR]]
    905         {{{forum_sort}}}:     [[BR]]
    906         {{{thread_sort}}}:     [[BR]]
    907         {{{faq_sort}}}:     [[BR]]
    908         {{{answer_sort}}}:     [[BR]]
    909         {{{forum_filter_user}}}:  [[BR]]   
    910         [ {{{removeID}}}: ... ]   [[BR]]
     1215{{{
     1216#!html
     1217<font color=darkgreen face="monospace">
     1218}}}
     1219        account_key:
     1220{{{
     1221#!html
     1222</font>
     1223}}}
     1224     [[BR]] [[BR]]
     1225{{{
     1226#!html
     1227<font color=darkgreen face="monospace">
     1228}}}
     1229        avatar_url:
     1230{{{
     1231#!html
     1232</font>
     1233}}}
     1234 ''Note: the image will be downloaded and stored locally. Only JPG and PNG accepted.''     [[BR]] [[BR]]
     1235{{{
     1236#!html
     1237<font color=darkgreen face="monospace">
     1238}}}
     1239        avatar_select:
     1240{{{
     1241#!html
     1242</font>
     1243}}}
     1244     [[BR]] [[BR]]
     1245{{{
     1246#!html
     1247<font color=darkgreen face="monospace">
     1248}}}
     1249        forum_images_as_links:
     1250{{{
     1251#!html
     1252</font>
     1253}}}
     1254   [[BR]]   [[BR]]
     1255{{{
     1256#!html
     1257<font color=darkgreen face="monospace">
     1258}}}
     1259        forum_link_externally:
     1260{{{
     1261#!html
     1262</font>
     1263}}}
     1264  [[BR]] [[BR]]
     1265{{{
     1266#!html
     1267<font color=darkgreen face="monospace">
     1268}}}
     1269        forum_hide_avatars:
     1270{{{
     1271#!html
     1272</font>
     1273}}}
     1274     [[BR]] [[BR]]
     1275{{{
     1276#!html
     1277<font color=darkgreen face="monospace">
     1278}}}
     1279        forum_hide_signatures:
     1280{{{
     1281#!html
     1282</font>
     1283}}}
     1284     [[BR]] [[BR]]
     1285{{{
     1286#!html
     1287<font color=darkgreen face="monospace">
     1288}}}
     1289        forum_jump_to_unread:
     1290{{{
     1291#!html
     1292</font>
     1293}}}
     1294     [[BR]] [[BR]]
     1295{{{
     1296#!html
     1297<font color=darkgreen face="monospace">
     1298}}}
     1299        forum_ignore_sticky_posts:
     1300{{{
     1301#!html
     1302</font>
     1303}}}
     1304     [[BR]] [[BR]]
     1305{{{
     1306#!html
     1307<font color=darkgreen face="monospace">
     1308}}}
     1309        forum_low_rating_threshold:
     1310{{{
     1311#!html
     1312</font>
     1313}}}
     1314     [[BR]] [[BR]]
     1315{{{
     1316#!html
     1317<font color=darkgreen face="monospace">
     1318}}}
     1319        forum_high_rating_threshold:
     1320{{{
     1321#!html
     1322</font>
     1323}}}
     1324     [[BR]] [[BR]]
     1325{{{
     1326#!html
     1327<font color=darkgreen face="monospace">
     1328}}}
     1329        forum_minimum_wrap_postcount:
     1330{{{
     1331#!html
     1332</font>
     1333}}}
     1334     [[BR]] [[BR]]
     1335{{{
     1336#!html
     1337<font color=darkgreen face="monospace">
     1338}}}
     1339        forum_display_wrap_postcount:
     1340{{{
     1341#!html
     1342</font>
     1343}}}
     1344     [[BR]] [[BR]]
     1345{{{
     1346#!html
     1347<font color=darkgreen face="monospace">
     1348}}}
     1349        signature_enabled:
     1350{{{
     1351#!html
     1352</font>
     1353}}}
     1354     [[BR]] [[BR]]
     1355{{{
     1356#!html
     1357<font color=darkgreen face="monospace">
     1358}}}
     1359        signature:
     1360{{{
     1361#!html
     1362</font>
     1363}}}
     1364     [[BR]] [[BR]]
     1365{{{
     1366#!html
     1367<font color=darkgreen face="monospace">
     1368}}}
     1369        forum_sort:
     1370{{{
     1371#!html
     1372</font>
     1373}}}
     1374     [[BR]] [[BR]]
     1375{{{
     1376#!html
     1377<font color=darkgreen face="monospace">
     1378}}}
     1379        thread_sort:
     1380{{{
     1381#!html
     1382</font>
     1383}}}
     1384     [[BR]] [[BR]]
     1385{{{
     1386#!html
     1387<font color=darkgreen face="monospace">
     1388}}}
     1389        faq_sort:
     1390{{{
     1391#!html
     1392</font>
     1393}}}
     1394     [[BR]] [[BR]]
     1395{{{
     1396#!html
     1397<font color=darkgreen face="monospace">
     1398}}}
     1399        answer_sort:
     1400{{{
     1401#!html
     1402</font>
     1403}}}
     1404     [[BR]] [[BR]]
     1405{{{
     1406#!html
     1407<font color=darkgreen face="monospace">
     1408}}}
     1409        forum_filter_user:
     1410{{{
     1411#!html
     1412</font>
     1413}}}
     1414  [[BR]]    [[BR]]
     1415{{{
     1416#!html
     1417<font color=darkgreen face="monospace">
     1418}}}
     1419        [ removeID: ... ]
     1420{{{
     1421#!html
     1422</font>
     1423}}}
     1424   [[BR]] [[BR]]
    9111425 '''examples'''::
    9121426 '''output'''::
    … …  
    9361450}}}
    9371451 '''input'''::
    938         {{{method}}}: [[BR]]
    939                 "user_posts" to retrieve post details, [[BR]]
    940                 "user_threads" to retrieve thread details.[[BR]]
    941         {{{userid}}}: numeric user ID in the database[[BR]]
    942         [ {{{count}}} ]: number of entries to return. Maximum 50, default 10.[[BR]]
    943         [ {{{contentlength}}} ]: number of characters to return from post content. Default returns whole post. Only used when method=user_posts.
     1452{{{
     1453#!html
     1454<font color=darkgreen face="monospace">
     1455}}}
     1456        method:
     1457{{{
     1458#!html
     1459</font>
     1460}}}
     1461                "user_posts" to retrieve post details, [[BR]]
     1462                "user_threads" to retrieve thread details.[[BR]] [[BR]]
     1463{{{
     1464#!html
     1465<font color=darkgreen face="monospace">
     1466}}}
     1467        userid:
     1468 numeric user ID in the database[[BR]] [[BR]]
     1469{{{
     1470#!html
     1471</font>
     1472}}}
     1473{{{
     1474#!html
     1475<font color=darkgreen face="monospace">
     1476}}}
     1477        [ count ]:
     1478{{{
     1479#!html
     1480</font>
     1481}}}
     1482 number of entries to return. Maximum 50, default 10.[[BR]] [[BR]]
     1483{{{
     1484#!html
     1485<font color=darkgreen face="monospace">
     1486}}}
     1487        [ contentlength ]:
     1488{{{
     1489#!html
     1490</font>
     1491}}}
     1492 number of characters to return from post content. Default returns whole post. Only used when method=user_posts. [[BR]]
    9441493 '''examples'''::
    9451494        http://setiathome.berkeley.edu/forum_get_data.php?method=user_posts&userid=18&count=20&contentlength=256
    … …  
    10061555}}}
    10071556 '''input'''::
    1008         [ {{{xml}}} ]: output formatting. 0=HTML, 1=XML. (default is 0)
     1557{{{
     1558#!html
     1559<font color=darkgreen face="monospace">
     1560}}}
     1561        [ xml ]:
     1562{{{
     1563#!html
     1564</font>
     1565}}}
     1566 output formatting. 0=HTML, 1=XML. (default is 0)  [[BR]] [[BR]]
    10091567 '''examples'''::
    10101568        http://setiathome.berkeley.edu/apps.php?xml=1