Changes between Version 10 and Version 11 of GuiRpcProtocol

Timestamp:

May 15, 2008, 7:30:38 PM (16 years ago)

Author:

Nicolas

Comment:

"Common XML elements" intro

GuiRpcProtocol

@@ -75 +75 @@
 
 If the client hasn't authenticated yet, and it is connecting remotely (ie. not via localhost), {{{<auth1/>}}} is the only command that can be sent, and all the rest will return <unauthorized/>.
+
+== Common XML elements ==
+There are some XML elements (like {{{<project>}}}, {{{<result>}}}, {{{<workunit>}}}, and {{{<app>}}}) that are common to many command replies. Such elements are documented in this section.
+
+The XML responses are relatively flat, and are parsed in one pass. The relationship between XML elements is determined by what was parsed before it, instead of based on the tree hierarchy like other XML formats do. For example, {{{<result>}}} elements that come ''after'' a particular {{{<project>}}} element are results that belong to that project; instead of those results being ''inside'' the {{{<project>}}} element.