Changes between Version 54 and Version 55 of WebRpc

Timestamp:

Mar 27, 2013, 11:36:37 AM (12 years ago)

Author:

davea

Comment:

--

WebRpc

@@ -17 +17 @@
 ?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).
+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).
  * The output is XML.
- * If the project's [#get_project_config 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.
+ * If the project's [#get_project_config 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.
  * Optional values are shown enclosed in square brackets.
  * If an RPC fails, the returned XML document is
@@ -30 +33 @@
 }}}
 
-where N is a BOINC error number and xxx is a textual description. BOINC error numbers are in [source:boinc/lib/error_numbers.h lib/error_numbers.h]; common errors are:
+where N is a BOINC error number and xxx is a textual description.
+BOINC error numbers are in [source:boinc/lib/error_numbers.h lib/error_numbers.h];
+common errors are:
 
  '''-1''': Generic error (error_string may have more info)
@@ -71 +76 @@
     <name>Project name</name>
     <master_url>URL</master_url>
+    [ <account_creation_disabled/> ]
+    [ <account_manager/> ]
+    [ <client_account_creation_disabled/> ]
+    [ <error_num>N</error_num> ]
     [ <local_revision>12345</local_revision> ]
-    [ <web_stopped>0|1</web_stopped> ]
-    [ <account_creation_disabled/> ]
-    [ <client_account_creation_disabled/> ]
     [ <min_passwd_length>N</min_passwd_length> ]
-    [ <account_manager/> ]
-    [ <uses_username/> ]
-    [ <rpc_prefix>URL</rpc_prefix> ]
-    [ <error_num>N</error_num> ]
     [
       <platforms>
@@ -93 +95 @@
       </platforms>
     ]
+    [ <rpc_prefix>URL</rpc_prefix> ]
     [ <sched_stopped>0|1</sched_stopped> ]
     [
@@ -106 +109 @@
       </system_requirements>
     ]
+    [ <terms_of_use>TEXT</terms_of_use> ]
+    [ <uses_username/> ]
+    [ <web_stopped>0|1</web_stopped> ]
 </project_config>
 }}}
@@ -111 +117 @@
  name:: Project name
  master_url:: Master URL
+ account_creation_disabled:: If present, this project is not allowing creation of new accounts
+ account_manager:: If present, this is an account manager, not a BOINC project
+ client_account_creation_disabled:: If present, new accounts can be created only via the web (not via the client software).
+ error_num:: The project is currently down. A BOINC error number is returned.
  local_revision:: The SVN changeset number of the project's server software.
- web_stopped:: Nonzero if the project's database is down, which means the data-driven web pages are turned off.
- account_creation_disabled:: If present, this project is not allowing creation of new accounts
  min_passwd_length:: Minimum password length (for new account creation)
- account_manager:: If present, this is an account manager, not a BOINC project
- uses_username:: If present, this project uses names (rather than email addresses) as the primary account identifier
- client_account_creation_disabled:: If present, new accounts can be created only via the web (not via the client software).
+ platforms:: A list of platforms for which the project has application versions.
  rpc_prefix:: Prefix to use for web RPCs, instead of the master URL.
- error_num:: The project is currently down. A BOINC error number is returned.
- platforms:: A list of platforms for which the project has application versions.
  sched_stopped:: Nonzero if the project's scheduler server is down, which means you can't get new work or report completed work.
  system_requirements:: Hardware requirements for participating in this project. If a computer doesn't meet these requirements it may not get sent any work by the project. All requirements are 'net'; e.g. the CPU requirements are after factors like [ClientSched on-fraction, active-fraction], and resource share have been taken into consideration. NOT IMPLEMENTED YET. [[BR]]
+ terms_of_use:: If present, client GUIs should display this text and require that the user click Accept before attaching to this project.
+ uses_username:: If present, this project uses names (rather than email addresses) as the primary account identifier
+ web_stopped:: Nonzero if the project's database is down, which means the data-driven web pages are turned off.
 
 
@@ -711 +718 @@
 }}}
 
-