Changes between Initial Version and Version 1 of WebRpc

Timestamp:

Apr 25, 2007, 1:03:59 PM (17 years ago)

Author:

Nicolas

Comment:

Converted by an automatic script

WebRpc

@@ +1 @@
+= Web Remote Procedure Calls (RPCs) =
+
+
+=== Contents ===
+
+ * [http://boinc.berkeley.edu/#overview Overview]
+ * [http://boinc.berkeley.edu/#project_config# Project configuration]
+ * [http://boinc.berkeley.edu/#create_account Create account]
+ * [http://boinc.berkeley.edu/#lookup_account Lookup account]
+ * [http://boinc.berkeley.edu/#am_get_info Get account info]
+ * [http://boinc.berkeley.edu/#am_set_info Set account info]
+ * [http://boinc.berkeley.edu/#am_set_host_info Set host info]
+ * [http://boinc.berkeley.edu/#show_user Get account/host credit info]
+ * [http://boinc.berkeley.edu/#create_team Create team]
+ * [http://boinc.berkeley.edu/#team_lookup Lookup teams by name]
+ * [http://boinc.berkeley.edu/#team_lookup_id Lookup team by ID]
+ * [http://boinc.berkeley.edu/#team_email_list Get team member list]
+ * [http://boinc.berkeley.edu/#edit_forum_preferences_action Set forum preferences]
+ * [http://boinc.berkeley.edu/#forum_get_user_posts Get last user's posts from the forum]
+ * [http://boinc.berkeley.edu/#forum_get_user_threads Get last user's threads from the forum]
+ * [http://boinc.berkeley.edu/#apps Get list of applications and versions]
+
+
+=== Overview ===
+ BOINC projects export a number of Web RPCs for creating, querying and updating accounts and host records, and miscellaneous other purposes. These can be used for [AccountManagement account management systems] and credit statistics web sites.
+
+BOINC's RPC mechanisms have the following conventions:
+
+
+ * Each RPC is an HTTP GET transaction.
+ * The input is the GET arguments, i.e. a string of the form
+{{{
+param1=val1&param2=val2&...&paramn=valn
+}}}
+      where param1 ... paramN are the parameter names, and val1 ... valn are the values. Parameter values must be URL-encoded (for example, using PHP's `urlencode` function).
+ * If an RPC fails, the returned XML document is
+{{{<error>
+    <error_num>N</error_num>
+    <error_string>xxx</error_string>
+</error>}}}
+      where N is a BOINC error number and xxx is a textual description. BOINC error numbers are in lib/error_numbers.h; common errors are:
+
+ '''-1'''::
+        Generic error (error_string may have more info)
+ '''-112'''::
+        Invalid XML (e.g., the preferences passed to am_set_info.php are invalid)
+ '''-136'''::
+        Item not found in database     (bad ID of any sort, or ID refers to an item not owned by the caller)
+ '''-137'''::
+        Name is not unique (Can't create account because     email address already in use,     or can't create team because name is in use)
+ '''-138'''::
+        Can't access database (treat same as -183)
+ '''-161'''::
+        Item not found (deprecated; treat same as -136)
+ '''-183'''::
+        Project is temporarily down
+ '''-205'''::
+        Email address has invalid syntax
+ '''-206'''::
+        Wrong password
+ '''-207'''::
+        Non-unique email address (treat same as -137)
+ '''-208'''::
+        Account creation disabled
+ * The output is XML.
+ * If the project's [ProjectConfigRpc get_project_config.php] file includes a `<rpc_prefix>` element, its content should be used as the URL prefix; otherwise use the project's master URL.
+
+
+=== Project configuration ===
+ Each BOINC project exports some configuration items relevant to attaching and creating accounts. This RPC is documented [ProjectConfigRpc here].
+=== Create account ===
+
+
+ '''Create account''':: '''URL'''::
+        project_url/create_account.php
+ '''input'''::
+        email_addr: email address         passwd_hash: the MD5 hash of the concatenation         of the user's password and the email address.                  user_name: the user name
+ '''output'''::
+        
+{{{<account_out>
+    <authenticator>XXX</authenticator>
+</account_out>}}}
+
+ '''action'''::
+        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.
+
+
+
+=== Look up account ===
+
+
+ '''URL'''::
+        project_url/lookup_account.php
+ '''input'''::
+        email_addr: email address                  [ passwd_hash ]: the MD5 hash of the concatenation         of the user's password and the email address.
+ '''output'''::
+        
+{{{<account_out>
+    [ <authenticator>XXX</authenticator> ]
+</account_out>
+    }}}
+
+ '''action'''::
+        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.
+
+
+
+=== Get account info ===
+
+
+ '''URL'''::
+        project_url/am_get_info.php
+ '''input'''::
+        account_key
+ '''output'''::
+        
+{{{<am_get_info_reply>
+    <success/>
+    <id>ID</id>
+    <name>NAME</name>
+    <country>COUNTRY</country>
+    <postal_code>POSTAL_CODE</postal_code>
+    <global_prefs>
+        GLOBAL_PREFS
+    </global_prefs>
+    <project_prefs>
+        PROJECT_PREFS
+    </project_prefs>
+    <url>URL</url>
+    <send_email>SEND_EMAIL</send_email>
+    <show_hosts>SHOW_HOSTS</show_hosts>
+    <teamid>N</teamid>
+    [ <teamfounder/> ]
+    <venue>X</venue>
+</am_get_info_reply>
+    }}}
+
+ '''action'''::
+        returns data associated with the given account
+
+
+
+=== Set account info ===
+
+
+ '''URL'''::
+        project_url/am_set_info.php
+ '''input'''::
+        account_key     [ name ]     [ country ]     [ postal_code ]     [ global_prefs ]     [ project_prefs ]     [ url ]     [ send_email ]     [ show_hosts ]     [ teamid ]  ''zero means quit current team, if any''     [ venue ]     [ email_addr ]     [ password_hash ]
+ '''output'''::
+        
+{{{<am_set_info_reply>
+    <success/>
+</am_set_info_reply>}}}
+
+ '''action'''::
+        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.
+
+
+
+=== Set host info ===
+
+
+ '''URL'''::
+        project_url/am_set_host_info.php
+ '''input'''::
+        account_key     hostid     venue
+ '''output'''::
+        
+{{{<am_set_host_info_reply>
+    <success/>
+</am_set_host_info_reply>}}}
+
+ '''action'''::
+        Updates the host's venue
+
+
+
+=== Get account/host credit information ===
+
+
+ '''URL'''::
+        project/show_user.php?userid=X&format=xml or     project/show_user.php?auth=X&format=xml
+ '''input'''::
+        id (user ID) or auth (account key)
+ '''output'''::
+        
+{{{<user>
+    <id>123</id>
+    <cpid>fe0b2753a355b17864ec061eb1b9e8de</cpid>
+    <create_time>918948493</create_time>
+    <name>Joe Smith</name>
+    <country>United States</country>
+    <total_credit>3806.869739</total_credit>
+    <expavg_credit>200</expavg_credit>
+    <expavg_time>1110833427.64028</expavg_time>
+    <teamid>114322</teamid>
+    <url>example.com</url>
+    <has_profile>1</has_profile>
+</user>
+
+or
+
+<user>
+    <id>123</id>
+    <cpid>fe0b2753a355b17864ec061eb1b9e8de</cpid>
+    <create_time>1101918807</create_time>
+    <name>David</name>
+    <country>United States</country>
+    <total_credit>0.293197</total_credit>
+    <expavg_credit>0.000883</expavg_credit>
+    <expavg_time>1116963330.83107</expavg_time>
+    <teamid>0</teamid>
+    <url>example.com</url>
+    <has_profile>1</has_profile>
+    <host>
+        <id>123</id>
+        <create_time>1287339128</create_time>
+        <rpc_seqno>123</rpc_seqno>
+        <host_cpid>fe0b2753a355b17864ec061eb1b9e8de</host_cpid>
+        <total_credit>0</total_credit>
+        <expavg_credit>0</expavg_credit>
+        <expavg_time>0</expavg_time>
+        <domain_name>Sorabji</domain_name>
+        <p_ncpus>1</p_ncpus>
+        <p_vendor>Mobile Intel(R) Pentium(R) 4 - M CPU 2.20GHz</p_vendor>
+        <p_model>Pentium</p_model>
+        <p_fpops>330806175.78458</p_fpops>
+        <p_iops>409200165.535107</p_iops>
+        <os_name>Microsoft Windows XP</os_name>
+        <os_version>Professional Edition, Service Pack 2, (05.01.2600.00)</os_version>
+    </host>
+    ...
+</user>
+}}}
+
+ '''action'''::
+        Returns info about an account.     If called with the account key,     returns a list of hosts associated with the account.
+
+
+
+=== Create team ===
+
+
+ '''URL'''::
+        project/create_team.php
+ '''input'''::
+        account_key: identifies team founder name: name of team url: team URL (optional) type: one of the types listed [http://boinc.berkeley.edu/team_types.php here]. name_html: team name, HTML (optional) description: text describing team (optional) country: team country (optional; if present, must be one of the countries listed [http://boinc.berkeley.edu/countries.php here].
+ '''output'''::
+        
+{{{<create_team_reply>
+    <success/>
+    <teamid>N</teamid>
+</create_team_reply>
+}}}
+
+ '''action'''::
+        Creates a team
+
+
+
+=== Look up teams by name ===
+
+
+ '''URL'''::
+        project/team_lookup.php?team_name=string&format=xml
+ '''input'''::
+        Substring of team name
+ '''output'''::
+        
+{{{<teams>
+    <team>
+        <id>5</id>
+        <name>BOINC@AUSTRALIA</name>
+        <country>Australia</country>
+    </team>
+    <team>
+        <id>9</id>
+        <name>BOINC Synergy</name>
+        <country>International</country>
+    </team>
+    <team>
+        <id>16</id>
+        <name>BOINC.BE</name>
+        <country>Belgium</country>
+    </team>
+    <team>
+        <id>23</id>
+        <name>HispaSeti & BOINC</name>
+        <country>International</country>
+    </team>
+</teams
+}}}
+
+ '''action'''::
+        Teams with names matching *string* will be returned.     A maximum of 100 teams will be returned.
+
+
+
+=== Look up team by ID ===
+
+
+ '''URL'''::
+        project/team_lookup.php?team_id=N
+ '''input'''::
+        Team ID
+ '''output'''::
+        
+{{{<team>
+    <id>5</id>
+    <name>BOINC@AUSTRALIA</name>
+    <country>Australia</country>
+</team>
+}}}
+
+ '''action'''::
+        Show info on team with the given ID.
+
+
+
+=== Get team member list ===
+
+
+ '''URL'''::
+        project/team_email_list.php?teamid=X&account_key=Y&xml=1
+ '''input'''::
+        teamid: database ID of team     account_key: account key of team founder (optional)
+ '''output'''::
+        
+{{{<users>
+    <user>
+        <id>1</id>
+        <email_addr>pdq@usndathoople.edu</email_addr>
+        <cpid>232f381c79336f0bd8df02bbce2f2217</cpid>
+        <create_time>1076897105</create_time>
+        <name>David</name>
+        <country>United States</country>
+        <total_credit>9.907264</total_credit>
+        <expavg_credit>0.023264</expavg_credit>
+        <expavg_time>1142628426.48937</expavg_time>
+        <url>usndathoople.edu/~pdq</url>
+        <has_profile>1</has_profile>
+    </user>
+    [ ... ]
+</users>}}}
+
+ '''action'''::
+        Show list of team members.     If account key is that of team founder, show email addresses.
+
+
+
+=== Set forum preferences ===
+
+
+ '''URL'''::
+        project/edit_forum_preferences_action.php          NOTE: this uses POST, not GET
+ '''input'''::
+        account_key     avatar_url ''Note: the image will be downloaded and stored locally. Only JPG and PNG accepted.''     avatar_select     forum_images_as_links     forum_link_externally     forum_hide_avatars     forum_hide_signatures     forum_jump_to_unread     forum_ignore_sticky_posts     forum_low_rating_threshold     forum_high_rating_threshold     forum_minimum_wrap_postcount     forum_display_wrap_postcount     signature_enabled     signature     forum_sort     thread_sort     faq_sort     answer_sort     forum_filter_user     [ removeID ... ]
+ '''output'''::
+        A lot of HTML (not XML)
+ '''action'''::
+        Update user's forum preferences
+
+
+
+=== Get last user's posts from the forum ===
+
+
+ '''URL'''::
+        project/forum_get_data.php?method=user_posts&userid=N&count=N
+ '''input'''::
+        userid: numeric user ID in the database     count ''(optional)'': number of entries to return. Maximum 50, default 10.
+ '''output'''::
+        
+{{{<rpc_response>
+    <count>1</count>
+    <posts>
+        <post>
+        <id>4157</id>
+        <threadid>76</threadid>
+        <timestamp>1162847905</timestamp>
+        <content><![CDATA[Example post content (truncated to 100 characters).]]></content>
+        </post>
+        [ ... ]
+    </posts>
+</rpc_response>}}}
+
+ '''action'''::
+        Get last user's posts from the forum.
+
+
+
+=== Get last user's threads from the forum ===
+
+
+ '''URL'''::
+        project/forum_get_data.php?method=user_threads&userid=N&count=N
+ '''input'''::
+        userid: numeric user ID in the database     count ''(optional)'': number of entries to return. Maximum 50, default 10.
+ '''output'''::
+        
+{{{<rpc_response>
+    <count>1</count>
+    <threads>
+        <thread>
+            <id>356</id>
+            <forumid>2</forumid>
+            <replies>11</replies>
+            <views>612</views>
+            <timestamp>1159062318</timestamp>
+            <title><![CDATA[Example forum thread title]]></title>
+        </thread>
+        [...]
+    </threads>
+</rpc_response>}}}
+
+ '''action'''::
+        Get last user's threads from the forums.
+
+
+
+=== Get list of application versions ===
+
+
+ '''URL'''::
+        project/apps.php
+ '''output'''::
+        List of applications and application versions;     this shows what platforms are supported by the project.
+
+