summaryrefslogtreecommitdiff
path: root/Architecture_and_Design/en-US/Administration_Panel.xml
diff options
context:
space:
mode:
Diffstat (limited to 'Architecture_and_Design/en-US/Administration_Panel.xml')
-rw-r--r--Architecture_and_Design/en-US/Administration_Panel.xml192
1 files changed, 169 insertions, 23 deletions
diff --git a/Architecture_and_Design/en-US/Administration_Panel.xml b/Architecture_and_Design/en-US/Administration_Panel.xml
index 6446dbc..fba3ed3 100644
--- a/Architecture_and_Design/en-US/Administration_Panel.xml
+++ b/Architecture_and_Design/en-US/Administration_Panel.xml
@@ -17,13 +17,17 @@
<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.
@@ -236,20 +240,34 @@
<para>
<screen language="Python">{
- "status":"OK",
+ "status": "OK",
"result": (...)
}</screen>
</para>
<para>
+ A successful result that is expected to return a list of zero, one or more items, such as <literal>list</literal> and <literal>search</literal> methods, includes a result layout as follows:
+ </para>
+ <para>
+
+<screen language="Python">{
+ "status": "OK",
+ "result": {
+ "list": (...),
+ "count": &lt;integer&gt;
+ }
+}</screen>
+
+ </para>
+ <para>
A failed result however looks like:
</para>
<para>
<screen language="Python">{
- "status":"ERROR",
- "code":&lt;integer&gt;,
- "reason":"&lt;string&gt;"
+ "status": "ERROR",
+ "code": &lt;integer&gt;,
+ "reason": "&lt;string&gt;"
}</screen>
</para>
@@ -679,10 +697,55 @@ domain_dn="dc=${domain_dn}"
<formalpara id="form-Architecture_and_Design-domains.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>
@@ -805,26 +868,55 @@ domain_dn="dc=${domain_dn}"
<formalpara id="form-Architecture_and_Design-group.members_list_Method-Response">
<title>Response</title>
<para>
-
-<screen language="Python">{
- "status":"OK",
- "result": [
- "uid=vanmeeuwen,ou=People,dc=klab,dc=cc",
- "uid=greve,ou=People,dc=klab,dc=cc",
- "uid=adams,ou=People,dc=klab,dc=cc",
- "uid=wickert,ou=People,dc=klab,dc=cc",
- "uid=machniak,ou=People,dc=klab,dc=cc",
- "uid=bruederli,ou=People,dc=klab,dc=cc",
- "uid=mollekopf,ou=People,dc=klab,dc=cc",
- "uid=beecher,ou=People,dc=klab,dc=cc",
- "uid=ayres,ou=People,dc=klab,dc=cc",
- (...snip...)
- ]
-}</screen>
-
+ 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>
@@ -1576,10 +1668,55 @@ if response_data.has_key('result'):
<formalpara id="form-Architecture_and_Design-user_types.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>
@@ -1630,13 +1767,17 @@ if response_data.has_key('result'):
<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:
@@ -1650,6 +1791,7 @@ if response_data.has_key('result'):
<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>
@@ -1658,9 +1800,13 @@ if response_data.has_key('result'):
<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">