summaryrefslogtreecommitdiff
path: root/Architecture_and_Design
diff options
context:
space:
mode:
authorJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2012-02-22 10:02:08 (GMT)
committerJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2012-02-22 10:02:08 (GMT)
commit68a6c1614ea26b7307ffa1317d240398276f60d3 (patch)
tree04471e3596aa38fb9df69a84329bafb59142b7fa /Architecture_and_Design
parentde2a5b783fb28c7ef3dee8c6fb74e13c652284cd (diff)
downloadkolab-docs-68a6c1614ea26b7307ffa1317d240398276f60d3.tar.gz
Update Administration Panel chapter
Diffstat (limited to 'Architecture_and_Design')
-rw-r--r--Architecture_and_Design/en-US/Administration_Panel.xml64
1 files changed, 60 insertions, 4 deletions
diff --git a/Architecture_and_Design/en-US/Administration_Panel.xml b/Architecture_and_Design/en-US/Administration_Panel.xml
index 8791392..6446dbc 100644
--- a/Architecture_and_Design/en-US/Administration_Panel.xml
+++ b/Architecture_and_Design/en-US/Administration_Panel.xml
@@ -6,10 +6,30 @@
<chapter id="chap-Architecture_and_Design-Administration_Panel">
<title>Administration Panel</title>
<para>
- TODO
+ The Kolab Groupware administration panel, a web interface to Kolab Groupware available for administrative purposes, will provide the functionality listed in this chapter.
</para>
<para>
- The Kolab Groupware administration panel, a web interface to Kolab Groupware available for administrative purposes, will provide the functionality listed in this chapter.
+ The Kolab Groupware Web Administration Panel is split in two parts;
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ A web client interface,
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ An API backend interface.
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <para>
+ The web client interface is nothing but a graphical representation of the API backend capabilities, allowing a user to navigate an interface to the administrative tasks the API backend exposes.
+ </para>
+ <para>
+ This design allows other system management and corporate products to trigger Kolab Groupware administration tasks on an equal footing, and without the need to (re-)implement all of the Kolab Groupware logic.
</para>
<section id="sect-Architecture_and_Design-Administration_Panel-Configuration">
<title>Configuration</title>
@@ -1600,11 +1620,47 @@ if response_data.has_key('result'):
<formalpara id="form-Architecture_and_Design-users.list_Method-Response">
<title>Response</title>
<para>
- para
+ The response consists of the following two toplevel keys, contained within a JSON dictionary:
</para>
</formalpara>
-
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ <literal>status</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>result</literal>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <para>
+ The <literal>result</literal> JSON dictionary contains the following two primary keys:
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ <literal>list</literal>
+ </para>
+ <para>
+ The value represents the list of results. Languages in use today allow the counting of the list's keys, which should get a client application to be able to estimate the number of results contained within the list.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>count</literal>
+ </para>
+ <para>
+ The value represents the total number of results, to allow for pagination on the client.
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
</section>
<section id="sect-Architecture_and_Design-The_users_Service-users.search_Method">