Changes between Version 25 and Version 26 of WebRpc


Ignore:
Timestamp:
Jan 21, 2009, 9:26:51 AM (15 years ago)
Author:
feet1st
Comment:

Colorize RPC names and URLs in blue

Legend:

Unmodified
Added
Removed
Modified
  • WebRpc

    v25 v26  
    5050 '''-208'''::
    5151        Account creation disabled
    52 
     52{{{
     53#!html
     54<font color=blue>
     55}}}
    5356== Project configuration == #get_project_config
    54 
    55  '''URL'''::
     57{{{
     58#!html
     59</font>
     60}}}
     61 '''URL'''::
     62{{{
     63#!html
     64<font color=blue>
     65}}}
    5666        project_url/get_project_config.php
     67{{{
     68#!html
     69</font>
     70}}}
    5771 '''input'''::
    5872        none. [[BR]]
     
    252266        Each BOINC project and account manager exports it's configuration via the get_project_config web RPC.
    253267
    254 
     268{{{
     269#!html
     270<font color=blue>
     271}}}
    255272== Server status == #server_status
    256 
    257  '''URL'''::
     273{{{
     274#!html
     275</font>
     276}}}
     277 '''URL'''::
     278{{{
     279#!html
     280<font color=blue>
     281}}}
    258282        project_url/server_status.php
     283{{{
     284#!html
     285</font>
     286}}}
    259287 '''input'''::
    260288        none. [[BR]]
     
    302330  '''action'''::
    303331        XML export generally updated every 10 minutes or so - do not poll more often than that. Status is used to make web sites showing the server status of multiple BOINC projects.
    304 
     332{{{
     333#!html
     334<font color=blue>
     335}}}
    305336== Create account == #create_account
    306 
    307  '''URL'''::
     337{{{
     338#!html
     339</font>
     340}}}
     341 '''URL'''::
     342{{{
     343#!html
     344<font color=blue>
     345}}}
    308346        project_url/create_account.php
     347{{{
     348#!html
     349</font>
     350}}}
    309351 '''input'''::
    310352{{{
     
    352394  '''action'''::
    353395        If the project already has an account with that email address, and a different password, it returns an error. If an account with that email address exists and has the same password, it returns the authenticator.  Otherwise the project creates an account and returns the authenticator.
    354 
     396{{{
     397#!html
     398<font color=blue>
     399}}}
    355400== Look up account == #lookup_account
    356 
    357  '''URL'''::
     401{{{
     402#!html
     403</font>
     404}}}
     405 '''URL'''::
     406{{{
     407#!html
     408<font color=blue>
     409}}}
    358410        project_url/lookup_account.php
     411{{{
     412#!html
     413</font>
     414}}}
    359415 '''input'''::
    360416        {{{email_addr}}}: email address [[BR]]
     
    373429        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.
    374430
    375 
     431{{{
     432#!html
     433<font color=blue>
     434}}}
    376435== Get account info == #am_get_info
    377 
    378 
    379  '''URL'''::
     436{{{
     437#!html
     438</font>
     439}}}
     440
     441 '''URL'''::
     442{{{
     443#!html
     444<font color=blue>
     445}}}
    380446        project_url/am_get_info.php
     447{{{
     448#!html
     449</font>
     450}}}
    381451 '''input'''::
    382452        {{{account_key}}}:
     
    409479 '''action'''::
    410480        returns data associated with the given account
    411 
     481{{{
     482#!html
     483<font color=blue>
     484}}}
    412485== Set account info == #am_set_info
    413 
    414 
    415  '''URL'''::
     486{{{
     487#!html
     488</font>
     489}}}
     490
     491 '''URL'''::
     492{{{
     493#!html
     494<font color=blue>
     495}}}
    416496        project_url/am_set_info.php
     497{{{
     498#!html
     499</font>
     500}}}
    417501 '''input'''::
    418502        {{{account_key}}}:     [[BR]]
     
    440524 '''action'''::
    441525        Updates one or more attributes of the given account.     The password hash is MD5(password+lower_case(email_addr)).     If email address is changed, you must also change the password hash.
    442 
     526{{{
     527#!html
     528<font color=blue>
     529}}}
    443530== Set host info == #am_set_host_info
    444 
    445 
    446  '''URL'''::
     531{{{
     532#!html
     533</font>
     534}}}
     535
     536 '''URL'''::
     537{{{
     538#!html
     539<font color=blue>
     540}}}
    447541        project_url/am_set_host_info.php
     542{{{
     543#!html
     544</font>
     545}}}
    448546 '''input'''::
    449547        {{{account_key}}}:     [[BR]]
     
    461559 '''action'''::
    462560        Updates the host's venue
    463 
     561{{{
     562#!html
     563<font color=blue>
     564}}}
    464565== Get account/host credit information == #show_user
    465 
    466 
    467  '''URL'''::
     566{{{
     567#!html
     568</font>
     569}}}
     570
     571 '''URL'''::
     572{{{
     573#!html
     574<font color=blue>
     575}}}
    468576        project/show_user.php
     577{{{
     578#!html
     579</font>
     580}}}
    469581 '''input'''::
    470582        {{{id}}}: (user ID) or auth: (account key)  [[BR]]
     
    527639 '''action'''::
    528640        Returns info about an account.  If called with the account key, returns a list of hosts associated with the account.
    529 
     641{{{
     642#!html
     643<font color=blue>
     644}}}
    530645== Get result list with pending credit == #pending
    531 
    532  '''URL'''::
     646{{{
     647#!html
     648</font>
     649}}}
     650 '''URL'''::
     651{{{
     652#!html
     653<font color=blue>
     654}}}
    533655        project/pending.php
     656{{{
     657#!html
     658</font>
     659}}}
    534660 '''input'''::
    535661        {{{format}}}:   Output formatting. 'xml' is only supported value (deafult is HTML formatting)  [[BR]]
     
    550676</pending_credit>
    551677}}}
    552 
     678{{{
     679#!html
     680<font color=blue>
     681}}}
    553682== Create team == #create_team
    554 
    555  '''URL'''::
     683{{{
     684#!html
     685</font>
     686}}}
     687 '''URL'''::
     688{{{
     689#!html
     690<font color=blue>
     691}}}
    556692        project/create_team.php
     693{{{
     694#!html
     695</font>
     696}}}
    557697 '''input'''::
    558698        {{{account_key}}}: identifies team founder.  [[BR]]
     
    575715 '''action'''::
    576716        Creates a team
    577 
     717{{{
     718#!html
     719<font color=blue>
     720}}}
    578721== Look up teams by name == #team_lookup_name
    579 
    580 
    581  '''URL'''::
     722{{{
     723#!html
     724</font>
     725}}}
     726
     727 '''URL'''::
     728{{{
     729#!html
     730<font color=blue>
     731}}}
    582732        project/team_lookup.php
     733{{{
     734#!html
     735</font>
     736}}}
    583737 '''input'''::
    584738        {{{team_name}}}: Substring of team name  [[BR]]
     
    616770        Teams with names matching *string* will be returned.     A maximum of 100 teams will be returned.
    617771
    618 
     772{{{
     773#!html
     774<font color=blue>
     775}}}
    619776== Look up team by ID == #team_lookup_id
    620 
    621 
    622  '''URL'''::
     777{{{
     778#!html
     779</font>
     780}}}
     781
     782 '''URL'''::
     783{{{
     784#!html
     785<font color=blue>
     786}}}
    623787        project/team_lookup.php
     788{{{
     789#!html
     790</font>
     791}}}
    624792 '''input'''::
    625793        {{{team_id}}}:
     
    646814        Show info on team with the given ID.
    647815
    648 
     816{{{
     817#!html
     818<font color=blue>
     819}}}
    649820== Get team member list == #team_email_list
    650 
    651 
    652  '''URL'''::
     821{{{
     822#!html
     823</font>
     824}}}
     825
     826 '''URL'''::
     827{{{
     828#!html
     829<font color=blue>
     830}}}
    653831        project/team_email_list.php
     832{{{
     833#!html
     834</font>
     835}}}
    654836 '''input'''::
    655837        {{{teamid}}}: database ID of team     [[BR]]
     
    684866        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.
    685867
    686 
     868{{{
     869#!html
     870<font color=blue>
     871}}}
    687872== Set forum preferences == #edit_forum_preferences
    688 
    689 
    690  '''URL'''::
     873{{{
     874#!html
     875</font>
     876}}}
     877
     878 '''URL'''::
     879{{{
     880#!html
     881<font color=blue>
     882}}}
    691883        project/edit_forum_preferences_action.php  [[BR]]
     884{{{
     885#!html
     886</font>
     887}}}
    692888        (NOTE: this uses POST, not GET)
    693889 '''input'''::
     
    719915        Update user's forum preferences
    720916
    721 
     917{{{
     918#!html
     919<font color=blue>
     920}}}
    722921== Get user's last posts on the forum == #forum_get_data_user_posts
    723 
    724 
    725  '''URL'''::
     922{{{
     923#!html
     924</font>
     925}}}
     926
     927 '''URL'''::
     928{{{
     929#!html
     930<font color=blue>
     931}}}
    726932        project/forum_get_data.php
     933{{{
     934#!html
     935</font>
     936}}}
    727937 '''input'''::
    728938        {{{method}}}: [[BR]]
     
    776986        Get user's last posts from the forum, or get user's last threads from the forums.
    777987
    778 
     988{{{
     989#!html
     990<font color=blue>
     991}}}
    779992== Get list of application versions == #apps
    780 
    781  '''URL'''::
     993{{{
     994#!html
     995</font>
     996}}}
     997 '''URL'''::
     998{{{
     999#!html
     1000<font color=blue>
     1001}}}
    7821002        project/apps.php
     1003{{{
     1004#!html
     1005</font>
     1006}}}
    7831007 '''input'''::
    7841008        [ {{{xml}}} ]: output formatting. 0=HTML, 1=XML. (default is 0)