egroupware_official/phpgwapi/doc/xmlrpc/gw_interface.sgml

<!doctype article public "-//OASIS//DTD DocBook V3.1//EN">

<article lang="en">
<!-- DocBook file was created by LyX 1.1
  See http://www.lyx.org/ for more information -->
  <artheader>
   <title>
   Proposal for a Common Groupware Interface Standard
  </title>
  <author>
   (C) 2001-2004 Miles Lott &lt;milos@groupwhere.org&gt;
  </author>
  <date>
   September 13, 2001 and December 29, 2003
  </date>
  <para>
   <toc></toc>
  </para>
  </artheader>
  <sect1>
   <title>
   Scope
  </title>
  <para>
   As many different opensource and freesoftware groupware systems are being developed, the full realization of the dream of a connected world should be prefaced by an agreement to interoperate. There are limited ways in which cooperation with these and commercial groupware systems may be achecived, the majority if not all of which were derived via the establishment of open standards. These might include email (POP3/IMAP), contacts(LDAP,vcard), or scheduling(ical/vcal). It is felt that while these have proven themselves to be very useful, they are insufficient to satisfy the real needs of a typical business environment.
  </para>
  <para>
   This document hopes to provide a reasonable, if limited, recommendation for a set of standardized methods to be used for groupware services interaction. More specifically, it hopes to address the need for such a standard as well as to spur discussion about the common service names and methods themselves.
  </para>
  <para>
   Examples will be given for implementations in XML-RPC, since this standard is relatively fixed and open.
  </para>
  <para>
   This document does not provide recommendations for the underlying access control system which would allow or deny a particular action.
  </para>
  <para>
   Also not discussed here is login and authorization to be used for initial access to a service provider.
  </para>
  </sect1>
  <sect1>
   <title>
   The Services
  </title>
   <sect2>
    <title>
    Overview
   </title>
   <para>
    There are a few common services types that will be needed for minimum useability of a groupware server or application. They are:
   </para>
   <itemizedlist>
    <listitem>
    <para>
    Contacts
    </para>
   </listitem>
    <listitem>
    <para>
    Schedule
    </para>
   </listitem>
    <listitem>
    <para>
    Notes
    </para>
   </listitem>
    <listitem>
    <para>
    Todo
    </para>
   </listitem>
   </itemizedlist>
   <para>
    These services are represented already in places such as existing groupware client-server applications and also in the PalmOS basic-4 buttons and applications. Different systems may have different names for these services internally, e.g. Contacts - addresses, addressbook, people, Schedule - calendar, agenda, meetings.
   </para>
   <para>
    Within each of these services are some common methods that would be called to store, retreive, or update data:
   </para>
   <itemizedlist>
    <listitem>
    <para>
    read_list
    </para>
   </listitem>
    <listitem>
    <para>
    read
    </para>
   </listitem>
    <listitem>
    <para>
    save
    </para>
   </listitem>
    <listitem>
    <para>
    delete
    </para>
   </listitem>
   </itemizedlist>
   </sect2>
   <sect2>
    <title>
    Detail
   </title>
    <sect3>
     <title>
     Contacts
    </title>
    <para>
     The concept of contacts may encompass local addressbooks, LDAP, and lists stored in other media. The purpose of the contacts service is not to duplicate or attempt to replace these. In some respects, it might do just that. But its goal is more so to provide a common and shareable way for the other core services to create, edit, and read a common user and address list. All of the other services may use the contact service to obtain record owner information to be used in access control. They would also use them when it is required to share this data, as with a meeting where other local and non-local users will be invited to attend.
    </para>
    <para>
     Contacts may include the local installed user base, users on other cooperative servers, or email addresses used for limited cooperation with other groupware services that are not compliant with this service scheme or implementations thereof. It could also include individuals using web-based or local ISP email services. The scope of this document, however, is to define the service with regard to the common methods to be used for server-server and client-server communications:
    </para>
    <itemizedlist>
     <listitem>
     <para>
     read_list
     </para>
    </listitem>
    </itemizedlist>
    <para>
     This method is used to list contacts, with or without limits, filters, or search criteria. In this way it can be used for simple lists or to search for contact records and their identifiers. The optional search criteria includes:
    </para>
    <orderedlist>
     <listitem>
     <para>
     start - Start at this identifier (integer: default 0)
     </para>
    </listitem>
     <listitem>
     <para>
     limit - Limit to this number of records returned(integer: unlimited by default)
     </para>
    </listitem>
     <listitem>
     <para>
     fieldlist - limit to showing only these fields (array: default to identifier, owner identifier, possibly firstname and lastname)
     </para>
    </listitem>
     <listitem>
     <para>
     filter - Show records that are public or private only, or other system-specific filters, e.g group or company(string: default '')
     </para>
    </listitem>
     <listitem>
     <para>
     query - Search internal fieldlist for a value (string: default '')
     </para>
    </listitem>
    </orderedlist>
    <para>
     The return for this method includes:
    </para>
    <orderedlist>
     <listitem>
     <para>
     count of number of records returned(integer)
     </para>
    </listitem>
     <listitem>
     <para>
     array consisting of: array: identifier =&gt; (array: fieldlist key =&gt; value pairs)
     </para>
    </listitem>
    </orderedlist>
    <itemizedlist>
     <listitem>
     <para>
     read
     </para>
    </listitem>
    </itemizedlist>
    <para>
     Once the identifier for a single contact record is known, the contact may be read for more detail using this method. This takes two parameters:
    </para>
    <orderedlist>
     <listitem>
     <para>
     identifier - (integer: no default)
     </para>
    </listitem>
     <listitem>
     <para>
     fieldlist - limit to showing only these fields (array: default to identifier, owner identifier, possibly firstname and lastname)
     </para>
    </listitem>
    </orderedlist>
    <para>
     And returns:
    </para>
    <orderedlist>
     <listitem>
     <para>
     array consisting of: array: identifier =&gt; (array: fieldlist key =&gt; value pairs)
     </para>
    </listitem>
    </orderedlist>
    <itemizedlist>
     <listitem>
     <para>
     save
     </para>
    </listitem>
    </itemizedlist>
    <para>
     This is a method used to save an existing record or create a new one. If the identifier for an existing record is not passed, a new entry will be created.
    </para>
    <itemizedlist>
     <listitem>
     <para>
     delete
     </para>
    </listitem>
    </itemizedlist>
    <para>
     This will allow deletion of a record by passing its identifier.
    </para>
    </sect3>
    <sect3>
     <title>
     Schedule
    </title>
    </sect3>
    <sect3>
     <title>
     Notes
    </title>
    </sect3>
    <sect3>
     <title>
     Todo
    </title>
    </sect3>
   </sect2>
   <sect2>
    <title>
    Examples in XML-RPC
   </title>
   <para>
    Query the contacts service for read_list, using only start and limit to grab the first 5 records, starting with identifier 1. Additionally, return only the firstname and lastname fields n_given and n_family (firstname and lastname in pseudo vcard format):
   </para>
   <programlisting>
<![ CDATA [<methodCall>
]]><![ CDATA [<methodName>service.contacts.read_list</methodName>
]]><![ CDATA [<params>
]]><![ CDATA [<param>
]]><![ CDATA [<value><struct>
]]><![ CDATA [<member><name>start</name>
]]><![ CDATA [<value><string>1</string></value>
]]><![ CDATA [</member>
]]><![ CDATA [<member><name>limit</name>
]]><![ CDATA [<value><string>5</string></value>
]]><![ CDATA [</member>
]]><![ CDATA [<member><name>fields</name>
]]><![ CDATA [<value><struct>
]]><![ CDATA [<member><name>n_given</name>
]]><![ CDATA [<value><string>n_given</string></value>
]]><![ CDATA [</member>
]]><![ CDATA [<member><name>n_family</name>
]]><![ CDATA [<value><string>n_family</string></value>
]]><![ CDATA [</member>
]]><![ CDATA [</struct></value>
]]><![ CDATA [</member>
]]><![ CDATA [<member><name>query</name>
]]><![ CDATA [<value><string></string></value>
]]><![ CDATA [</member>
]]><![ CDATA [<member><name>filter</name>
]]><![ CDATA [<value><string></string></value>
]]><![ CDATA [</member>
]]><![ CDATA [</struct></value>
]]><![ CDATA [</param>
]]><![ CDATA [</params>
]]><![ CDATA [</methodCall>
]]>   </programlisting>
   </sect2>
  </sect1>
  <sect1>
   <title>
   Conclusion
  </title>
  <para>
   This document outlined the following services and methods:
  </para>
   <sect2>
    <title>
    Contacts:
   </title>
   <itemizedlist>
    <listitem>
    <para>
    service.contacts.read_list(&lsqb;search criteria&rsqb;)
    </para>
   </listitem>
    <listitem>
    <para>
    service.contacts.read(identifier,&lsqb;fieldlist&rsqb;)
    </para>
   </listitem>
    <listitem>
    <para>
    service.contacts.save(fields)
    </para>
   </listitem>
    <listitem>
    <para>
    service.contacts.delete(identifier)
    </para>
   </listitem>
   </itemizedlist>
   </sect2>
   <sect2>
    <title>
    Schedule:
   </title>
   <itemizedlist>
    <listitem>
    <para>
    service.schedule.read_list(&lsqb;search criteria&rsqb;)
    </para>
   </listitem>
    <listitem>
    <para>
    service.schedule.read(identifier,&lsqb;fieldlist&rsqb;)
    </para>
   </listitem>
    <listitem>
    <para>
    service.schedule.save(fields)
    </para>
   </listitem>
    <listitem>
    <para>
    service.schedule.delete(identifier)
    </para>
   </listitem>
   </itemizedlist>
   </sect2>
   <sect2>
    <title>
    Notes:
   </title>
   <itemizedlist>
    <listitem>
    <para>
    service.notes.read_list(&lsqb;search criteria&rsqb;)
    </para>
   </listitem>
    <listitem>
    <para>
    service.notes.read(identifier,&lsqb;fieldlist&rsqb;)
    </para>
   </listitem>
    <listitem>
    <para>
    service.notes.save(fields)
    </para>
   </listitem>
    <listitem>
    <para>
    service.notes.delete(identifier)
    </para>
   </listitem>
   </itemizedlist>
   </sect2>
   <sect2>
    <title>
    Todo:
   </title>
   <itemizedlist>
    <listitem>
    <para>
    service.todo.read_list(search criteria)
    </para>
   </listitem>
    <listitem>
    <para>
    service.todo.read(identifer,&lsqb;fieldlist&rsqb;)
    </para>
   </listitem>
    <listitem>
    <para>
    service.todo.save(fields)
    </para>
   </listitem>
    <listitem>
    <para>
    service.todo.delete(identifier)
    </para>
   </listitem>
   </itemizedlist>
   </sect2>
  </sect1>


</article>