Changes between Version 59 and Version 60 of WebRpc


Ignore:
Timestamp:
Jun 20, 2016, 9:52:43 AM (8 years ago)
Author:
davea
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WebRpc

    v59 v60  
    6262----
    6363== Project configuration == #get_project_config
    64   '''action'''::
     64 action::
    6565        Export project or account manager configuration info.
    66  '''URL'''::
     66 URL::
    6767        project_url/get_project_config.php
    68  '''input'''::
     68 input::
    6969        none.
    70  '''examples'''::
     70 examples::
    7171http://setiathome.berkeley.edu/get_project_config.php
    72  '''output'''::
     72 output::
    7373
    7474{{{
    … …  
    134134----
    135135== Server status == #server_status
    136   '''action'''::
     136  action::
    137137    Get project status.
    138138        Can be used used to make web sites showing the server status
    139139        of multiple BOINC projects.
    140140        Do not poll more often than 10 minutes.
    141  '''URL'''::
     141 URL::
    142142        project_url/server_status.php
    143  '''input'''::
     143 input::
    144144        [ xml ] :: output formatting. 0=HTML (default), 1=XML.
    145  '''examples'''::
     145 examples::
    146146        http://lhcathome.cern.ch/lhcathome/server_status.php?xml=1
    147147
    148  '''output'''::
     148 output::
    149149{{{
    150150<server_status>
    … …  
    187187== Create account == #create_account
    188188
    189  '''action'''::
     189 action::
    190190
    191191 Create an account.
    … …  
    200200 must supply the given string as well as the authenticator.
    201201
    202  '''URL'''::
     202 URL::
    203203  project_url/create_account.php
    204204
    205  '''input'''::
     205 input::
    206206
    207207 email_addr:: email address.
    … …  
    213213 [ team_name ]:: optional name of a team to put user in.
    214214
    215 '''example'''::
     215 example::
    216216        http://ralph.bakerlab.org/create_account.php?email_addr=user@example.com&passwd_hash=2ab548fae3162ccfa1a2d41a55557a92&user_name=CrunchAll
    217217
    218 '''output'''
     218 output::
    219219       
    220220{{{
    … …  
    225225----
    226226== Look up account == #lookup_account
    227  '''action'''::
     227 action::
    228228        If passwd_hash is given and is correct, the user's authentication string is returned. This authentication string is required for many of the other RPCs.
    229229        If no paswd_hash is given and the account exists, a success message is returned.
    … …  
    232232        If ldap_auth is non-zero and ldap_uid and passwd are given, authenticate using the LDAP_HOST specified in project.inc. If no account with the EMail address of the ldap_uid exists, a new one is created and the authenticator returned.
    233233
    234  '''URL'''::
     234 URL::
    235235        project_url/lookup_account.php
    236  '''input'''::
     236 input::
    237237
    238238 [ email_addr ]:: email address of account (ignored when ldap_auth is non-zero)
    … …  
    247247  The password authenticating the LDAP userid.
    248248
    249  '''examples'''::
     249 examples::
    250250        http://ralph.bakerlab.org/lookup_account.php?email_addr=user@example.com&passwd_hash=2ab598faf3160ccfa1a2d41a95557a92&get_opaque_auth=1
    251  '''output'''::
     251 output::
    252252       
    253253{{{
    … …  
    261261== Get account info == #am_get_info
    262262
    263  '''action'''::
     263 action::
    264264        returns data associated with the given account
    265  '''URL'''::
     265 URL::
    266266        project_url/am_get_info.php
    267  '''input'''::
     267 input::
    268268 account_key::
    269269  Authentication string for account to retrieve information about.
    … …  
    272272        opaque_auth:: opaque authenticator, if present.
    273273
    274  '''output'''::
     274 output::
    275275
    276276{{{
    … …  
    300300== Set account info == #am_set_info
    301301
    302  '''action'''::
     302 action::
    303303        Updates one or more attributes of the given account.
    304304        If email address is changed,
    … …  
    306306        If the project uses opaque_auth,
    307307        then it will be returned on the reply.
    308  '''URL'''::
     308 URL::
    309309        project_url/am_set_info.php
    310  '''input'''::
     310 input::
    311311        account_key:: Authentication string of user account being changed.
    312312         See [#create_account create account RPC] or [#lookup_account lookup account RPC]
    … …  
    324324        [ email_addr ]::
    325325        [ password_hash ]:: The password hash is MD5(password+lower_case(email_addr)).
    326  '''output'''::
     326 output::
    327327       
    328328{{{
    … …  
    339339== Set host info == #am_set_host_info
    340340
    341  '''action'''::
     341 action::
    342342        Updates the host's venue
    343  '''URL'''::
     343 URL::
    344344        project_url/am_set_host_info.php
    345  '''input'''::
     345 input::
    346346        account_key:: Authentication string of user account owning the
    347347         host being changed.
    … …  
    351351        hostid::
    352352        venue::
    353  '''output'''::
     353 output::
    354354       
    355355{{{
    … …  
    362362== Get account/host credit information == #show_user
    363363
    364  '''action'''::
     364 action::
    365365        Returns info about an account.
    366366        If called with the authentication string,
    367367        returns a list of hosts associated with the account.
    368  '''URL'''::
     368 URL::
    369369        project/show_user.php
    370  '''input'''::
     370 input::
    371371        [ userid ]:: User ID to display. Either id or auth must be specified.
    372372        [ auth ]:: Authentication string of user to display.
    … …  
    379379         'xml' is only supported value (default is HTML formatting)
    380380
    381  '''examples'''::
     381 examples::
    382382        http://boinc.bakerlab.org/rosetta/show_user.php?userid=123&format=xml
    383383        http://boinc.bakerlab.org/rosetta/show_user.php?auth=X&format=xml
    384  '''output'''::
     384 output::
    385385       
    386386{{{
    … …  
    436436----
    437437== Get status of result(s) == #result_status
    438  '''URL'''::
     438 URL::
    439439        project/result_status.php
    440  '''input'''::
    441         ids:: comma-separate list of result IDs
    442  '''output'''::
     440 input::
     441 * '''ids''': comma-separated list of result IDs
     442 * or '''names''': comma-separated list of result names
     443 output::
    443444        Descriptions of those result, including most of the DB fields
    444445        such as server status, granted credit, etc.
    445  '''examples'''::
     446 examples::
    446447        http://boinc.berkeley.edu/test/result_status.php?ids=5575279
    447  '''output'''::
     448 output::
    448449{{{
    449450<results>
    … …  
    479480== Get result list with pending credit == #pending
    480481DEPRECATED - BOINC NO LONGER HAS A NOTION OF PENDING CREDIT
    481  '''URL'''::
     482 URL::
    482483        project/pending.php
    483  '''input'''::
     484 input::
    484485        format:: Output formatting.
    485486         'xml' is only supported value (deafult is HTML formatting)
    … …  
    489490        opaque_auth:: opaque authenticator, if present.
    490491
    491  '''examples'''::
     492 examples::
    492493        http://boinc.bakerlab.org/rosetta/pending.php?format=xml&authenticator=X
    493  '''output'''::
     494 output::
    494495{{{
    495496<pending_credit>
    … …  
    506507----
    507508== Create team == #create_team
    508  '''action'''::
     509 action::
    509510        Creates a team
    510  '''URL'''::
     511 URL::
    511512        project/create_team.php
    512  '''input'''::
     513 input::
    513514        account_key:: Authentication string of team founder's user account. See [#create_account create account RPC] or [#lookup_account lookup account RPC]
    514515        opaque_auth:: opaque authenticator, if present.
    … …  
    519520        [ description ]:: text describing team.
    520521        [ country ]:: team country (if present, must be one of [//countries.php these countries]).
    521  '''output'''::
     522 output::
    522523       
    523524{{{
    … …  
    531532== Look up teams by name == #team_lookup_name
    532533
    533  '''action'''::
     534 action::
    534535        Teams with names matching *string* will be returned.
    535536        A maximum of 100 teams will be returned.
    536  '''URL'''::
     537 URL::
    537538        project/team_lookup.php
    538  '''input'''::
     539 input::
    539540        team_name:: Substring of team name
    540541        [ format ]:: Output formatting. 'xml' is only supported value (deafult is HTML formatting)
    541  '''examples'''::
     542 examples::
    542543        http://boinc.bakerlab.org/team_lookup.php?team_name=BOINC&format=xml
    543  '''output'''::
     544 output::
    544545       
    545546{{{
    … …  
    572573== Look up team by ID == #team_lookup_id
    573574
    574  '''action'''::
     575 action::
    575576        Show info on team with the given ID.
    576  '''URL'''::
     577 URL::
    577578        project/team_lookup.php
    578  '''input'''::
     579 input::
    579580        team_id:: Team number of the team to lookup.
    580  '''examples'''::
     581 examples::
    581582        http://boinc.bakerlab.org/rosetta/team_lookup.php?team_id=111
    582  '''output'''::
     583 output::
    583584       
    584585{{{
    … …  
    600601== Get team member list == #team_email_list
    601602
    602  '''action'''::
     603 action::
    603604        Show list of team members.
    604605        If authentication string is that of a team administrator,
    605606        show email addresses,
    606607        and flag indicating whether the user opted out of getting emails.
    607  '''URL'''::
     608 URL::
    608609        project/team_email_list.php
    609  '''input'''::
     610 input::
    610611        teamid:: database ID of team
    611612        [ account_key ]:: Authentication string of a team administrator's user account. See [#create_account create account RPC] or [#lookup_account lookup account RPC]
    612613        opaque_auth:: opaque authenticator, if present.
    613614        xml:: output formatting. 0=HTML, 1=XML. (default is 0)
    614  '''examples'''::
     615 examples::
    615616        http://boinc.bakerlab.org/rosetta/team_email_list.php?teamid=2241&account_key=Y&xml=1
    616617
    617  '''output'''::
     618 output::
    618619       
    619620{{{
    … …  
    641642== Set forum preferences == #edit_forum_preferences
    642643
    643  '''action'''::
     644 action::
    644645        Update user's forum preferences
    645  '''URL'''::
     646 URL::
    646647        project/edit_forum_preferences_action.php
    647648        (NOTE: this uses POST, not GET)
    648  '''input'''::
     649 input::
    649650        account_key:: Authentication string of user account to change preferences for. See [#create_account create account RPC] or [#lookup_account lookup account RPC]
    650651        [ opaque_auth ]:: opaque authenticator, if present.
    … …  
    669670        [ forum_filter_user ]::
    670671        [ removeID ... ]::
    671  '''output'''::
     672 output::
    672673        A lot of HTML (not XML)
    673674
    … …  
    675676== Get user's last posts on the forum == #forum_get_data_user_posts
    676677
    677  '''action'''::
     678 action::
    678679        Get user's last posts from the forum, or get user's last threads from the forums.
    679  '''URL'''::
     680 URL::
    680681        project/forum_get_data.php
    681  '''input'''::
     682 input::
    682683        method:: "user_posts" to retrieve post details,
    683684                "user_threads" to retrieve thread details.
    … …  
    685686        [ count ]:: number of entries to return. Maximum 50, default 10.
    686687        [ contentlength ]:: number of characters to return from post content. Default returns whole post. Only used when method=user_posts.
    687  '''examples'''::
     688 examples::
    688689        http://setiathome.berkeley.edu/forum_get_data.php?method=user_posts&userid=18&count=20&contentlength=256
    689690        http://setiathome.berkeley.edu/forum_get_data.php?method=user_threads&userid=182&count=20
    690  '''output'''::
     691 output::
    691692{{{
    692693<rpc_response>
    … …  
    727728----
    728729== Get list of application versions == #apps
    729  '''URL'''::
     730 URL::
    730731        project/apps.php
    731  '''input'''::
     732 input::
    732733        [ xml ]:: output formatting. 0=HTML, 1=XML. (default is 0)
    733  '''examples'''::
     734 examples::
    734735        http://setiathome.berkeley.edu/apps.php?xml=1
    735  '''output'''::
     736 output::
    736737        List of applications and application versions. For example:
    737738{{{