<?xml version="1.0"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en">
	<id>https://wiki.open-xchange.com/wiki/api.php?action=feedcontributions&amp;feedformat=atom&amp;user=Stefan.preuss</id>
	<title>Open-Xchange - User contributions [en]</title>
	<link rel="self" type="application/atom+xml" href="https://wiki.open-xchange.com/wiki/api.php?action=feedcontributions&amp;feedformat=atom&amp;user=Stefan.preuss"/>
	<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=Special:Contributions/Stefan.preuss"/>
	<updated>2026-11-17T11:45:05Z</updated>
	<subtitle>User contributions</subtitle>
	<generator>MediaWiki 1.39.7</generator>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Client_Onoarding&amp;diff=23134</id>
		<title>AppSuite:Client Onoarding</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Client_Onoarding&amp;diff=23134"/>
		<updated>2017-03-20T09:52:41Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Redirected page to AppSuite:Client Onboarding&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[AppSuite:Client_Onboarding]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Main_Page_Advanced&amp;diff=21368</id>
		<title>AppSuite:Main Page Advanced</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Main_Page_Advanced&amp;diff=21368"/>
		<updated>2016-02-02T12:02:57Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Programming Interfaces */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;__NOTOC__&lt;br /&gt;
= Overview =&lt;br /&gt;
*[[AppSuite:Architecture_Overview|Architecture Overview]]&lt;br /&gt;
&lt;br /&gt;
= OX App Suite UI Development =&lt;br /&gt;
This page contains all the information you need to get started with UI development.&lt;br /&gt;
&lt;br /&gt;
This covers how-to articles including server communication, extension points and how to write widgets, applications and plugins:&lt;br /&gt;
&lt;br /&gt;
[[AppSuite:UI | Frontend development articles]]&lt;br /&gt;
&lt;br /&gt;
= Groupware Server customization =&lt;br /&gt;
* [[Automatic_Delete_OXObjects_Per_User|Automatically delete users OX-Objects and OX-Folders]]&lt;br /&gt;
* [[Login_variations|Background Information about Login Variation]]&lt;br /&gt;
* Auto login, session handling, single sign on&lt;br /&gt;
** [http://www.open-xchange.com/fileadmin/user_upload/open-xchange/document/presentation/OX-HE-Authentication-Sessionhandling-en-6.18.pdf Authentication and Sessionhandling white paper (EasyLogin)]&lt;br /&gt;
** [[AppSuite:SAML_SSO_Integration|SAML SSO Integration]]&lt;br /&gt;
** Custom login masks&lt;br /&gt;
*** [[Open-Xchange servlet for external login masks]]&lt;br /&gt;
&lt;br /&gt;
= Advanced Configuration =&lt;br /&gt;
* [[AppSuite:CalDAVClients | Configuration CalDAV with Open-Xchange]]&lt;br /&gt;
* [[AppSuite:CardDAVClients | Configuration CardDAV with Open-Xchange]]&lt;br /&gt;
* [[AppSuite:Caldav_carddav_Bundles| Installation CardDAV/CalDAV with Open-Xchange]]&lt;br /&gt;
* [[AppSuite:Running_a_cluster| Configuration Cluster-Setup]]&lt;br /&gt;
* [[AppSuite:Grizzly| Configuration Connector based on Grizzly]]&lt;br /&gt;
* [[ContactStorageLDAP| LDAP Contact Storage]]&lt;br /&gt;
* [[AppSuite:Sharing_and_Guest_Mode |Sharing and Guest Mode]]&lt;br /&gt;
* [[AppSuite:Metrics | Metrics ]]&lt;br /&gt;
* [[AppSuite:Upsell |Upsell ]]&lt;br /&gt;
* [[AppSuite:OAuth_2_0_Provider_Operator_Guide |OAuth 2.0 - Provider/Operator Guide ]]&lt;br /&gt;
* [[AppSuite:OAuth_2_0_Client_Developer_Guide |OAuth 2.0 - Client Developer Guide ]]&lt;br /&gt;
* [[AppSuite:File_Storages_per_User |File Storage per User ]]&lt;br /&gt;
* [[AppSuite:Paste_inline_images |Pasting External Images into Mail Compose ]]&lt;br /&gt;
* [[AppSuite:Create_custom_folderview_entries_in_settings_app |Custom Folder View Entries in Settings ]]&lt;br /&gt;
* [[AppSuite:DB_user_privileges | Database User Privileges]]&lt;br /&gt;
* [[AppSuite:CrossContextDatabase |GlobalDB/Cross-Context Database ]]&lt;br /&gt;
* [[AppSuite:Filestorages |Setup external File Stores ]]&lt;br /&gt;
&lt;br /&gt;
= Programming Interfaces =&lt;br /&gt;
* The [[AppSuite:HTTP_API|HTTP API]] is used by the Open-Xchange GUI and various 3rd party applications. It consists mainly of messages in JavaScript Object Notation ([http://json.org JSON]) sent over HTTP. Here is a general [[AppSuite:Introduction to the HTTP API|Introduction to the HTTP API]].&lt;br /&gt;
* Provisioning API to access the Open-Xchange Admin Daemon&lt;br /&gt;
** The [http://java.sun.com/javase/technologies/core/basic/rmi/index.jsp RMI] API is used for data provisioning of Contexts, Users, Groups and Resources as well as for configuring Databases, Filestores and OX Servers. It is currently split into two parts,&lt;br /&gt;
*** a {{DocLink|docpath=RMI/admin-core/|name=core}} and&lt;br /&gt;
*** a {{DocLink|docpath=RMI/admin-hosting/|name=hosting}} component.&lt;br /&gt;
** The {{DocLink|docpath=OX6-Provisioning/|name=Open-Xchange CLT}} are shell scripts that simplify groupware and service administration&lt;br /&gt;
** Create contexts/users with with [[Csv_import]]&lt;br /&gt;
** [[Open-Xchange-SOAP|Provisioning using SOAP]]&lt;br /&gt;
* The [[Oxmapi|Oxmapi]] is a windows library for programmers needed to communicate with the OX server&lt;br /&gt;
* {{DocLink|docpath=mal/|name=Open-Xchange Mail Abstraction Layer}}&lt;br /&gt;
* [[UDPPush]] Open-Xchange PUSH Interface for Groupware Objects&lt;br /&gt;
&lt;br /&gt;
= Testing and QA =&lt;br /&gt;
* [[Automated GUI Tests]]&lt;br /&gt;
* [[Jmeter profile for performance tests|JMeter profile for performance tests]]&lt;br /&gt;
* [[Gatling Performance Tests]]&lt;br /&gt;
&lt;br /&gt;
= Statistics =&lt;br /&gt;
&lt;br /&gt;
* [[AppSuite:Logincounter|logincounter]]&lt;br /&gt;
&lt;br /&gt;
= Translations =&lt;br /&gt;
* [[AppSuite:Available_Translations| Available Language Translations]]&lt;br /&gt;
* [[GUI Translation|Translate Open-Xchange to your community language]]&lt;br /&gt;
* [[AppSuite:Translate_Open-Xchange_to_supported_language|Translate Open-Xchange to supported language]]&lt;br /&gt;
&lt;br /&gt;
= Installation based on source code =&lt;br /&gt;
* [[SourceCodeAccess|Download the sourcecode]]&lt;br /&gt;
&lt;br /&gt;
= Integration =&lt;br /&gt;
* {{DocLink|docpath=whitepaper/OX-Directory-Integration-Whitepaper-English.pdf|name=Directory Integration Whitepaper}}&lt;br /&gt;
&lt;br /&gt;
= Additional =&lt;br /&gt;
* [[AppSuite:ISV_Mockups_Wireframes|Create Open-Xchange AppSuite Mockups / Wireframes]]&lt;br /&gt;
* [[AppSuite:Cross_folder_fulltext_search_with_Dovecot|Cross folder fulltext search with Dovecot]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Getting_started_developing_the_UI&amp;diff=19316</id>
		<title>AppSuite:Getting started developing the UI</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Getting_started_developing_the_UI&amp;diff=19316"/>
		<updated>2015-04-09T12:02:19Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: corrected the GIT link&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{Stability-unstable}}&lt;br /&gt;
&lt;br /&gt;
== Getting started ==&lt;br /&gt;
&lt;br /&gt;
Hello and welcome to OX app suite development. This document will get you started to develop your own plugins and apps for OX app suite. We will look at the steps necessary but will also tempt you to learn more by linking you to some more in-depth documentation about these topics. Depending on how you wound up reading this page, you will probably have already completed some of the steps below.&lt;br /&gt;
&lt;br /&gt;
== Prerequisites ==&lt;br /&gt;
&lt;br /&gt;
Before we begin, here are a few things that you need to have set up before going on: - An OX Backend. We will not cover how to set up one of these. Either have it running locally on your development machine, if you are also developing backend functionality, or install an OX server on another machine as a normal set up. Either one is fine. - To follow this guide, on your development machine you will need git, node (0.4 or later), an apache web server and a text editor, for the actual development.&lt;br /&gt;
&lt;br /&gt;
== Check out the source ==&lt;br /&gt;
&lt;br /&gt;
Firstly you will need to check out our source code. This also includes the most up to date version of this documentation. The source code for the frontend is hosted at code.open-xchange.com/wd/frontend/web. Since we&#039;re living on the edge here, we will use the branch where the actual development is going on, called develop. Depending on your needs and taste, the stable master branch might also be a good choice. In a shell navigate to where you want to work on the app suite and type:&lt;br /&gt;
&lt;br /&gt;
    git clone -b develop https://code.open-xchange.com/git/wd/frontend/web&lt;br /&gt;
&lt;br /&gt;
and wait for the checkout to complete. This will create the directory web with the source code of the frontend in it.&lt;br /&gt;
Building the ui and documentation&lt;br /&gt;
&lt;br /&gt;
For this I will refer you to the file readme.txt you&#039;ve just checked out. It will include the steps you need to do to build the frontend and the most current version of the documentation. Briefly though, here is what you want to do: - create a new file local.conf in the source folder you have just checked out. Enter in it:&lt;br /&gt;
&lt;br /&gt;
    export builddir=&amp;quot;/var/www/appsuite&amp;quot;&lt;br /&gt;
    &lt;br /&gt;
(I am assuming debian here. For other systems you might have to point this elsewhere, a folder called &amp;quot;appsuite&amp;quot; below apaches document root, to be precise. When in doubt, refer to the readme.txt) - run the build:&lt;br /&gt;
&lt;br /&gt;
    ./build.sh &amp;amp;&amp;amp; ./build.sh docs&lt;br /&gt;
    &lt;br /&gt;
- start the app loading server&lt;br /&gt;
&lt;br /&gt;
    ./appserver.sh&lt;br /&gt;
    &lt;br /&gt;
This command will not return, since there is now a server running. If it is silent, then everything is running fine. You can then continue reading the documentation at http://localhost/appsuite/doc/gettingStarted.html&lt;br /&gt;
Set up Apache&lt;br /&gt;
&lt;br /&gt;
For this step, I will refer you to this page. You will notice two ProxyPass directives. The first one points at the app loading server you started in the previous step, the second one points at the backend, either running locally (then 127.0.0.1 is fine as the target) or remotely (in which case you have to point it to the IP of the backend system). If port 8009 is not reachable due to some firewall restrictions, you can also use http by substituting the second ProxyPass with this:&lt;br /&gt;
&lt;br /&gt;
    ProxyPass /appsuite/api http://remote-host/ajax timeout=600&lt;br /&gt;
    &lt;br /&gt;
Getting ready to develop your own plugins / apps&lt;br /&gt;
&lt;br /&gt;
Next, create a new directory in which you will develop your plugin(s) / app/(s). Let us call it myplugin for now. Depending on where you want to keep your projects, do something like this:&lt;br /&gt;
&lt;br /&gt;
    cd ~/projects/appsuite&lt;br /&gt;
    mkdir myplugin&lt;br /&gt;
    cd myplugin&lt;br /&gt;
    mkdir apps&lt;br /&gt;
    /path/to/appsuite/frontend/web/ui/bin/build-appsuite init-packaging package=myplugin&lt;br /&gt;
    &lt;br /&gt;
And answer the questions. Bonus points for putting the build-appsuite program into your PATH (see buildsystem for how to do that). We&#039;ll assume from now on, that it is in the PATH.&lt;br /&gt;
Now you will have to decide on a namespace for your code. Let us for now choose com.example. In your plugins directory (&amp;quot;myplugin&amp;quot;) under apps create a directory:&lt;br /&gt;
&lt;br /&gt;
    cd apps&lt;br /&gt;
    mkdir com.example&lt;br /&gt;
    touch com.example/main.js&lt;br /&gt;
    &lt;br /&gt;
In order to use short commands, add the binary path to the environment variable containing all paths from which binaries should be executed directly:&lt;br /&gt;
&lt;br /&gt;
    export PATH=$PATH:/path/to/appsuite/frontend/web/ui/bin&lt;br /&gt;
&lt;br /&gt;
and run the buildscript once:&lt;br /&gt;
&lt;br /&gt;
    cd ..&lt;br /&gt;
    build-appsuite app&lt;br /&gt;
    &lt;br /&gt;
For the rest of this exercise follow the steps outlined here. Don&#039;t worry about the manifest.json if you do not have a locally running backend, just skip those steps. You can manually launch the app by typing&lt;br /&gt;
&lt;br /&gt;
    ox.launch(&amp;quot;com.example/main&amp;quot;)&lt;br /&gt;
&lt;br /&gt;
in the javascript console of your browser. For more information on the buildsystem, read the entire description available in this documentation.&lt;br /&gt;
Apps, plugins and manifests&lt;br /&gt;
&lt;br /&gt;
In order for an app to show up in the launcher grid, it has to be declared in a manifest file, so the UI can find out about the app. As in the example in the buildsystem documentation, create a file myplugin/apps/com.example/manifest.json:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre class=&amp;quot;language-javacript&amp;quot;&amp;gt;&lt;br /&gt;
    {&lt;br /&gt;
        title: &#039;Hello World App&#039;&lt;br /&gt;
    }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The buildsystem will automatically add the path to the main.js file to this entry, so when compiled it winds up looking like this:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre class=&amp;quot;language-javacript&amp;quot;&amp;gt;&lt;br /&gt;
    {&lt;br /&gt;
        path: &amp;quot;com.example/main&amp;quot;,&lt;br /&gt;
        title: &#039;Hello World App&#039;&lt;br /&gt;
    }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
If you are using a local backend you can use the trick described in the buildsystem documentation to have the app show up. You will have to restart your backend every time the manifests change, though. If, on the other hand you are working with a remote backend, you can inject your own manifest definitions this way: - Create the file myplugin/src/manifests.js in your app:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre class=&amp;quot;language-javacript&amp;quot;&amp;gt;&lt;br /&gt;
    define(function () {&lt;br /&gt;
        return [&lt;br /&gt;
            {&lt;br /&gt;
                path: &amp;quot;com.example/main&amp;quot;,&lt;br /&gt;
                title: &#039;Hello World App&#039;&lt;br /&gt;
            }&lt;br /&gt;
        ];&lt;br /&gt;
    });&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
In case you&#039;re rebuilding the base ui you might have to repeat the above step. To activate the extra manifests in src/manifests.js, reload the UI with the &amp;quot;customManifests&amp;quot; switch in the url set to true. So for example: /appsuite/#!&amp;amp;customManifests=true and when you click the app grid icon (left most icon on the top), your custom app will be listed as well.&lt;br /&gt;
&lt;br /&gt;
The second way – apart from your own apps – your plugin code can interact with the app suite is by way of extension points and extensions. Stated briefly an extension point is an invitation to contributing an implementation to a part of the UI. For example the contact detail view consists of an extension point that receives contributions in the form of renderers, that render different parts of the contact. Say, one for rendering the display name, one for the mail addresses, one for the postal addresses and so on. All these, in turn then, make up the contacts detail view. It is easy for plugins to affect this set of extensions. A plugin can contribute its own extension to an extension point, thereby rendering a different part of a contact or contributing a new button to work on a contact. A plugin can also disable existing extensions, thereby removing parts of the UI.&lt;br /&gt;
&lt;br /&gt;
As an example, let&#039;s add a new renderer to the contact detail view. Let&#039;s create a new file myplugin/apps/com.example/contacts/register.js:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre class=&amp;quot;language-javacript&amp;quot;&amp;gt;&lt;br /&gt;
        define(&#039;com.example/contacts/register&#039;, [&#039;io.ox/core/extensions&#039;], function (ext) {&lt;br /&gt;
            &#039;use strict&#039;;&lt;br /&gt;
&lt;br /&gt;
            ext.point(&#039;io.ox/contacts/detail&#039;).extend({&lt;br /&gt;
                id: &#039;com-example-contact-reversename&#039;,&lt;br /&gt;
                after: &#039;contact-details&#039;,&lt;br /&gt;
                draw: function (baton) {&lt;br /&gt;
&lt;br /&gt;
                    var name = baton.data.display_name;&lt;br /&gt;
                    var rev = name.split(&amp;quot;&amp;quot;).reverse().join(&amp;quot;&amp;quot;);&lt;br /&gt;
&lt;br /&gt;
                    this.append(&lt;br /&gt;
                        $(&amp;quot;&amp;lt;h1&amp;gt;&amp;quot;).text(rev)&lt;br /&gt;
                    ));&lt;br /&gt;
                }&lt;br /&gt;
            });&lt;br /&gt;
        });&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
How can you find out which extension points exist and what you have to implement to extend them? App Suite contains an ever increasing set of examples in the lessons app, that you can open by typing&lt;br /&gt;
&lt;br /&gt;
    ox.launch(&amp;quot;io.ox/lessons/main&amp;quot;)&lt;br /&gt;
&lt;br /&gt;
in the console. If you do not find a suitable example here, your next best bet is to inspect the DOM structure. It may contain hints as to the extension points and extensions used. You might then still have to look up its current use in the frontend source code. Failing that, look for other identifying marks in the DOM structure, like a certain css class being set and just search for that in the frontend code base. Of course you can always just as us. This documentation is a work in progress, so for now, these are your best choices.&lt;br /&gt;
&lt;br /&gt;
Next we have to make sure our code is actually loaded by the UI at the right moment. The right moment in our case is right before it loads the file apps/io.ox/contacts/view-detail, where the extension point is processed. For this, we need another manifest file at myplugin/apps/com.example/contacts/manifest.json:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre class=&amp;quot;language-javacript&amp;quot;&amp;gt;&lt;br /&gt;
    {&lt;br /&gt;
        namespace: &amp;quot;io.ox/contacts/view-detail&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
the namespace denoting when a plugin should be loaded. Rebuild your plugin by issuing the&lt;br /&gt;
&lt;br /&gt;
     build-appsuite app&lt;br /&gt;
    &lt;br /&gt;
command in the root directory of your plugin, and if using a local backend, restart it to pick up on the changed manifest, or, for a remote backend, edit myplugin/src/manifests.js again so it reads:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre class=&amp;quot;language-javacript&amp;quot;&amp;gt;&lt;br /&gt;
    define(function () {&lt;br /&gt;
        return [&lt;br /&gt;
            {&lt;br /&gt;
                path: &amp;quot;com.example/main&amp;quot;,&lt;br /&gt;
                title: &#039;Hello World App&#039;&lt;br /&gt;
            },&lt;br /&gt;
            {&lt;br /&gt;
                path: &amp;quot;com.example/contacts/register&amp;quot;,&lt;br /&gt;
                namespace: &amp;quot;io.ox/contacts/view-detail&amp;quot;&lt;br /&gt;
            }&lt;br /&gt;
        ];&lt;br /&gt;
    });&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
reload the UI and navigate to a contact. It should contain the new section with the display name in reverse.&lt;br /&gt;
&lt;br /&gt;
== Further reading ==&lt;br /&gt;
&lt;br /&gt;
Every article in this documentation is certainly worth your time, in particular, though, have a look at:&lt;br /&gt;
&lt;br /&gt;
* Buildsystem&lt;br /&gt;
* Manifests&lt;br /&gt;
&lt;br /&gt;
Also, for (interactive) examples, have a look at the lessons app by logging into app suite and typing:&lt;br /&gt;
&lt;br /&gt;
    ox.launch(&amp;quot;io.ox/lessons/main&amp;quot;)&lt;br /&gt;
in the Javascript console.&lt;br /&gt;
&lt;br /&gt;
[[Category:AppSuite]]&lt;br /&gt;
[[Category:UI]]&lt;br /&gt;
[[Category:Development process]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:GettingStartedWithGrunt&amp;diff=17254</id>
		<title>AppSuite:GettingStartedWithGrunt</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:GettingStartedWithGrunt&amp;diff=17254"/>
		<updated>2014-03-12T13:15:49Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Linux */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;&amp;lt;div class=&amp;quot;title&amp;quot;&amp;gt;Getting started with grunt&amp;lt;/div&amp;gt;&lt;br /&gt;
__TOC__&lt;br /&gt;
== Node ==&lt;br /&gt;
&lt;br /&gt;
=== Linux ===&lt;br /&gt;
&lt;br /&gt;
Install the default nodejs of your distribution via your favourite package/ports manager and you are good to go.&lt;br /&gt;
&lt;br /&gt;
If you are having problems or your package manager does not provide at least nodejs in version 0.10.x please have at https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager&lt;br /&gt;
&lt;br /&gt;
=== Windows ===&lt;br /&gt;
&lt;br /&gt;
Head to the node.js [http://nodejs.org/ site] and download and install the latest version.&lt;br /&gt;
It is recommended to restart after the installation, as paths may not be up-to-date.&lt;br /&gt;
&lt;br /&gt;
Please also make sure git is installed and in your PATH.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;This is sometimes a problem on windows, make sure to activate the option to put git into your path during msys-git installation.&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
=== Mac OS X ===&lt;br /&gt;
&lt;br /&gt;
We strongly encourage you to use [http://brew.sh/ homebrew]. Actually, we won&#039;t support you if you don&#039;t. It&#039;s that bad.&lt;br /&gt;
&lt;br /&gt;
Make sure you have an up-to-date homebrew installation.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
brew update&lt;br /&gt;
brew upgrade&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Check your homebrew installation with &amp;lt;tt&amp;gt;brew doctor&amp;lt;/tt&amp;gt; and resolve any issues and repeat this step until homebrews output says &amp;quot;Your system is ready to brew.&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
brew doctor&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Install node via &amp;lt;tt&amp;gt;brew install node&amp;lt;/tt&amp;gt; if is not yet installed.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
brew install node&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Make sure you &#039;&#039;&#039;never &amp;lt;tt&amp;gt;sudo&amp;lt;/tt&amp;gt; anything related to node or its package manager npm&#039;&#039;&#039;. If you think you have to, you are doing something wrong and are probably dealing with a broken homebrew/macports installation! If this is the case, the easiest way of resolving this is completely deleting the homebrew (and if present macports) directories and (re)installing homebrew.&lt;br /&gt;
&lt;br /&gt;
The default system&#039;s max opened file limit in mac os x is very low (256), in order to use grunt watch, it needs to be increased.&lt;br /&gt;
&lt;br /&gt;
You can either set this in your shell via &amp;lt;tt&amp;gt;ulimit -n 8192&amp;lt;/tt&amp;gt; to a sensible value.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
ulimit -n 8192&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
or you can set&lt;br /&gt;
it permanently by adding &amp;lt;tt&amp;gt;limit maxfiles 8192 20480&amp;lt;/tt&amp;gt; to &amp;lt;tt&amp;gt;/etc/launchd.conf&amp;lt;/tt&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
echo &amp;quot;limit maxfiles 8192 20480&amp;quot; | sudo tee -a /etc/launchd.conf&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;Note that you will have to restart your system for the setting to be active.&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Grunt &amp;amp; Bower ==&lt;br /&gt;
&lt;br /&gt;
With &amp;lt;tt&amp;gt;npm install -g bower grunt-cli&amp;lt;/tt&amp;gt; you can install the global npm dependencies needed for grunt and bower.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
npm install -g bower grunt-cli&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Cleaning development environment ==&lt;br /&gt;
&lt;br /&gt;
Sometimes it is needed to completely wipe all old and ignored (by git) files. You can also do this using git by running &amp;lt;tt&amp;gt;git clean -ndx&amp;lt;/tt&amp;gt; this will print a lot of files, but _not_ delete any. Check the list if you really want to remove these files. Then run &amp;lt;tt&amp;gt;git clean -fdx&amp;lt;/tt&amp;gt; to really do the cleanup.&lt;br /&gt;
&lt;br /&gt;
== Installing node dependencies for OX Appsuite Frontend development ==&lt;br /&gt;
&lt;br /&gt;
Change to the ui directory of your git workdirectory and run &amp;lt;tt&amp;gt;npm install&amp;lt;/tt&amp;gt;.&lt;br /&gt;
Make sure, you have got the git binary in your path. (This is sometimes a problem on windows,&lt;br /&gt;
make sure to activate the option to put git into your path during msys-git installation. TODO: more detail)&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
npm install&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Building the UI ==&lt;br /&gt;
&lt;br /&gt;
Just run the default grunt task &amp;lt;tt&amp;gt;grunt&amp;lt;/tt&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
grunt&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Local configuration ==&lt;br /&gt;
&lt;br /&gt;
You can override some options on your local build environment by creating the file &amp;lt;tt&amp;gt;grunt/local.conf.json&amp;lt;/tt&amp;gt;. See &amp;lt;tt&amp;gt;grunt/local.conf.default.json&amp;lt;/tt&amp;gt; as a template.&lt;br /&gt;
&lt;br /&gt;
Hint: copy the default file to &amp;lt;tt&amp;gt;grunt/local.conf.json&amp;lt;/tt&amp;gt; to get started.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
cp grunt/local.conf.default.json grunt/local.conf.json&lt;br /&gt;
vi grunt/local.conf.json&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
If you want to use the proxy function of the appserver, at least the server-variable needs to be configured.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
    &amp;quot;appserver&amp;quot;: {&lt;br /&gt;
        &amp;quot;server&amp;quot;: &amp;quot;http://url.to.your.ser/appsuite/&amp;quot;,&lt;br /&gt;
        &amp;quot;verbose&amp;quot;: [&amp;quot;local:error&amp;quot;]&lt;br /&gt;
    }&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Accessing the UI ==&lt;br /&gt;
&lt;br /&gt;
You can run the appserver with the connect grunt task:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
grunt connect:server:keepalive&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
or in combination with the watch task:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
grunt connect watch&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
You can now access the ui via &amp;lt;tt&amp;gt;http://localhost:8337/appsuite/&amp;lt;/tt&amp;gt;.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_path&amp;diff=16407</id>
		<title>OX6:Gui path</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_path&amp;diff=16407"/>
		<updated>2013-11-14T09:00:18Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Minot text changes. Also add a limitation note for AppSuite&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;==== OX6 GUI settings ====&lt;br /&gt;
This table shows a partial list of OX6 GUI settings. These settings are stored in a javascript object notation (JSON) which is directly computed by the GUI. Information about the used format can be found in the [[HTTP_API]]. By default, this object does not existent upon user creation and is stored by the GUI after the first logout of the user. This object however can be manipulated through the RMI interface (as well as on the command line). It is not necessary to define all settings (inner objects), missing ones will be added by the GUI automatically. Please be very careful if you change the settings after it has been initialized and stored by the GUI, all existing settings will be lost because they will be overwritten! Please also take care the you use the correct format of that object, otherwise the user might not be able to login (e.g. on a missing comma or bracket). This article refers to the OX6 frontend settings, if your are looking for the AppSuite UI documentation please take a look here http://oxpedia.org/index.php?title=AppSuite:UI&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;gui_path&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;Gui settings&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! value !! comment&lt;br /&gt;
|-&lt;br /&gt;
|  infostore     || Object   || [[#infostore object|infostore object]]      || infostore settings&lt;br /&gt;
|-&lt;br /&gt;
| mail      || Object  || [[#mail object|mail object]]    || mail settings&lt;br /&gt;
|-&lt;br /&gt;
| portal || Object  || [[#portal object|portal object]]  || portal layout and content&lt;br /&gt;
|- &lt;br /&gt;
| global || Object || [[#global object|global object]] || timestamp settings and global settings&lt;br /&gt;
|-&lt;br /&gt;
| menu || Object || [[#menue object|menue object]] || menu iteration&lt;br /&gt;
|-&lt;br /&gt;
| theme || Object || [[#theme object|theme object]] || default theme and path&lt;br /&gt;
|- &lt;br /&gt;
| effects || Object || [[#effects object|effects object]] || hover and global effects&lt;br /&gt;
|- &lt;br /&gt;
| tasks || Object || [[#tasks objects|tasks objects]] || tasks settings &lt;br /&gt;
|- &lt;br /&gt;
| FolderTreeState || Object || [[#foldertree object|foldertree object]] || holds the folder tree state&lt;br /&gt;
|-&lt;br /&gt;
| contacts || Object || [[#contacts object|contacts object]] || contacts settings  &lt;br /&gt;
|-&lt;br /&gt;
| calendar || Object || [[#calendar object|calendar object]] || calendar settings &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
====Settings for the infostore module====&lt;br /&gt;
This table contains the settings for the GUI&#039;s infostore&lt;br /&gt;
{| id=&amp;quot;infostore object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot; &lt;br /&gt;
|+&#039;&#039;&#039;infostore object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| view || value || infostore/(list,split) || infostore view&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
====Settings for the E-Mail module====&lt;br /&gt;
This tables contains the settings for the E-Mail module.&lt;br /&gt;
{| id=&amp;quot;mail object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;mail object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| auto_save_drafts || Number || 0,1,3,5,10,15,30|| time in minutes, 0 for disabled&lt;br /&gt;
|-&lt;br /&gt;
| htmlmessage || Boolean|| true,false || show email as html or plain text&lt;br /&gt;
|-&lt;br /&gt;
| signatures || Array || [[#signature objects|signature objects]] || array of signature objects&lt;br /&gt;
|-&lt;br /&gt;
| view || String || mail/(list,hsplit,vsplit)/unthreaded  || mail view&lt;br /&gt;
|-&lt;br /&gt;
| view spam || String || mail/(list,hsplit,vsplit)/unthreaded  || mail view for spam folder&lt;br /&gt;
|-&lt;br /&gt;
| autocomplete || Boolean || true,false || autocomplete functions&lt;br /&gt;
|-&lt;br /&gt;
| fullmailheader || Boolean || true,false || show complete mail header&lt;br /&gt;
|-&lt;br /&gt;
| notifyacknoledge ||Boolean  || true,false || notify on read acknowledgment&lt;br /&gt;
|-&lt;br /&gt;
| newmail_options || Object || [[#newmail_options objects|newmail_options objects]] || object for the new email window settings&lt;br /&gt;
|-&lt;br /&gt;
| formatmessage || String || ALTERNATIVE,TEXT/HTML,TEXT/PLAIN || email format&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;newmail_options objects&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;newmail_options objects&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| cc || Boolean || true,false || show cc input field&lt;br /&gt;
|-&lt;br /&gt;
| bcc || Boolean || true,false || show bcc input field&lt;br /&gt;
|-&lt;br /&gt;
| from || Boolean || true,false || show from input field&lt;br /&gt;
|-&lt;br /&gt;
| options || Boolean || true,false || show options field&lt;br /&gt;
|- &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;signature objects&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;signature objects&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| signature_name || String || name  || signature name&lt;br /&gt;
|-&lt;br /&gt;
| position || String || below,above || where to show the signature in the mail text&lt;br /&gt;
|-&lt;br /&gt;
| signature_text || String || text || signature text&lt;br /&gt;
|-&lt;br /&gt;
| signature_default || Boolean || true,false || true only for the default signature&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
====Start page settings====&lt;br /&gt;
This table contains the possible settings for the start page.&lt;br /&gt;
{| id=&amp;quot;portal object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;portal object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| externalcontents || Array || [[#externalcontents objects|externalcontents objects]] ||   array of external content objects (UWA widgeds)&lt;br /&gt;
|-&lt;br /&gt;
| minicalendar ||Boolean || true,false|| show minicalendar&lt;br /&gt;
|-&lt;br /&gt;
| internalcontents || Array || [[#internalcontens objects|internalcontents objects]] ||  array of internal content objects (groupware modules)&lt;br /&gt;
|-&lt;br /&gt;
| infobox || Boolean || true,false|| show infobox&lt;br /&gt;
|-&lt;br /&gt;
| tooltip ||Boolean ||true,false || show tooltip&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;externalcontents objects&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;externalcontents objects&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| autorefresh || Boolean || true,false || enable autorefresh for the widget&lt;br /&gt;
|-&lt;br /&gt;
| title || String || name || widget title&lt;br /&gt;
|-&lt;br /&gt;
| standalone || Boolean || true,false || widget is standalone&lt;br /&gt;
|-&lt;br /&gt;
| visible || Boolean || true,false || widget is visible on the portal page&lt;br /&gt;
|-&lt;br /&gt;
| adj || Object || [[#adj object|adj object]] || position setting of the widget&lt;br /&gt;
|-&lt;br /&gt;
| url || String || url || widget url&lt;br /&gt;
|-&lt;br /&gt;
| parameter || Object || parameter object || widget parameters in an object&lt;br /&gt;
|-&lt;br /&gt;
| id || String || unique id || unique id for the widget&lt;br /&gt;
|- &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;internalcontens objects&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;internalcontens objects&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| params || Object || [[#params object|params object]] || widget parameter&lt;br /&gt;
|-&lt;br /&gt;
| header || Sting || E-Mail,Calendar,InfoStore,Tasks || header name&lt;br /&gt;
|-&lt;br /&gt;
| visible || Boolean || true,false || show module on the portal&lt;br /&gt;
|-&lt;br /&gt;
| adj || Object || [[#adj object|adj object]] || position setting of the widget&lt;br /&gt;
|- &lt;br /&gt;
| external || Boolean || false || only false is implemented&lt;br /&gt;
|-&lt;br /&gt;
| module || String || mail,calendar,infostore,tasks || internal module name&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;adj object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;adj object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| hw || Number || 0... || widget height relative to others, 0 for auto&lt;br /&gt;
|-&lt;br /&gt;
| ww || Number || 0... || widget width relative to others, 0 for auto&lt;br /&gt;
|-columns&lt;br /&gt;
| y || Number || 0... || vertical position on the start page in rows, 0 for auto&lt;br /&gt;
|-&lt;br /&gt;
| x || Number || 0... || horizontal position on the start page in columns, 0 for auto&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;params object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;params object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| limit || Number || 5,10,15,20 || number of shown items in the module&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
====global settings====&lt;br /&gt;
This table contains the global settings options&lt;br /&gt;
{| id=&amp;quot;global object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;global object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! comment&lt;br /&gt;
|-&lt;br /&gt;
| confirmtimestamp ||Number || Timestamp || timestamp for the last confirmed/declined appointment&lt;br /&gt;
|-&lt;br /&gt;
| confirmpopup || Boolean || true,false|| confirmation pop-up for new appointments&lt;br /&gt;
|-&lt;br /&gt;
| save || Number || 0,1,2 || save layout on logout: 0 no, 1 yes, 2 ask&lt;br /&gt;
|-&lt;br /&gt;
| autorefresh || Number || 0,5,10,15,30 || time in minutes for GUI autorefresh, 0 for never&lt;br /&gt;
|-&lt;br /&gt;
| region || Object || [[#region object|region object]] || region settings for time and date formats&lt;br /&gt;
|-&lt;br /&gt;
| private_categories || String || tag,tag,.. || comma separated list of user defined tags &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;region object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;region object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| time || Object || [[#time object|time object]] || object for time defaults&lt;br /&gt;
|-&lt;br /&gt;
| date || Object || [[#date object|date object]] || object for date defaults&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;time object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;time object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| predefined || Number || 0,1 || 0 user defined, 1 language depending&lt;br /&gt;
|-&lt;br /&gt;
| format || String || HH:mm,&amp;quot;hh:mm a&amp;quot; || a stands for suffix which needs to be true then, too. m is 0-59, mm is 00-59, H is 1-24, HH is 01-24, h is 1-12, hh is 01-12, a is AM/PM.&lt;br /&gt;
|-&lt;br /&gt;
| format_hour || String || &amp;quot;hh a&amp;quot;,HH || a stands for suffix which needs to be true then, too. H is 1-24, HH is 01-24, h is 1-12, hh is 01-12, a is AM/PM.&lt;br /&gt;
|-&lt;br /&gt;
| format_suffix || Boolean || true,false || add suffix&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;date object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;date object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| format_selected_index || Number || id from [[#index|index]] || preselection for the user time format drop down&lt;br /&gt;
|-&lt;br /&gt;
| separator || String || /,.,- || date separator&lt;br /&gt;
|-&lt;br /&gt;
| predifined || Number || 0,1 || 0 user defined, 1 language depending&lt;br /&gt;
|-&lt;br /&gt;
| format || String || value from [[#index|index]] || date format &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;index&amp;quot; style=&amp;quot;width:50%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;date index&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! id    !! value&lt;br /&gt;
|-&lt;br /&gt;
| 0  || M/d/yyyy&lt;br /&gt;
|-&lt;br /&gt;
| 1 || M/d/yy&lt;br /&gt;
|-&lt;br /&gt;
| 2 || MM/dd/yy&lt;br /&gt;
|-&lt;br /&gt;
| 3 || MM/dd/yyyy&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yy/MM/dd&lt;br /&gt;
|-&lt;br /&gt;
| 5 || dd/MM/yyyy&lt;br /&gt;
|-&lt;br /&gt;
| 6 || dd/MM/yy&lt;br /&gt;
|-&lt;br /&gt;
| 7 || dd.MM.yyyy&lt;br /&gt;
|-&lt;br /&gt;
| 8 || dd.MM.yy&lt;br /&gt;
|-&lt;br /&gt;
| 9 || d.MM.yy&lt;br /&gt;
|-&lt;br /&gt;
| 10 || d.M.yy&lt;br /&gt;
|-&lt;br /&gt;
| 11 || d.M.yyyy&lt;br /&gt;
|-&lt;br /&gt;
| 12 || yyyy-MM-dd&lt;br /&gt;
|-&lt;br /&gt;
| 13 || dd-MMM-yy&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
===menuiteration===&lt;br /&gt;
This object holds the setting of the pannel &lt;br /&gt;
{| id=&amp;quot;menue object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;menue object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| menuiteration || Number || 1,2,3,4,5,6 || highs of the GUI pannel in rows &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
===theme settings===&lt;br /&gt;
This table shows the setting for the default theme&lt;br /&gt;
{| id=&amp;quot;theme object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;theme object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| name || String || &amp;lt;theme name&amp;gt; || name of the default theme &lt;br /&gt;
|-&lt;br /&gt;
| path ||String || &amp;lt;theme path&amp;gt; || path to the default theme&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
===effects object===&lt;br /&gt;
the effects object holds the settings for GUI effects like hovers and fading.&lt;br /&gt;
{| id=&amp;quot;effects object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;effects object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| global || Boolean || true,false || enable effects&lt;br /&gt;
|-&lt;br /&gt;
| hover || Object || [[#hover object|hover object]]  || includes hover settings for the modules&lt;br /&gt;
|-&lt;br /&gt;
|  fading|| Boolean || true,false || fading&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;hover object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;hover object&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| speed || Number || 1,2,3 || hover delay, 1 short, 2 normal, 3 long&lt;br /&gt;
|-&lt;br /&gt;
| calendar || Boolean || true,false || hover for calendar&lt;br /&gt;
|-&lt;br /&gt;
| contacts || Boolean || true,false || hover for contacts&lt;br /&gt;
|-&lt;br /&gt;
| portal || Boolean || true,false || hovers on the portal page&lt;br /&gt;
|- &lt;br /&gt;
| infostore ||  Boolean || true,false || hover for infostore&lt;br /&gt;
|-&lt;br /&gt;
| mail || Boolean || true,false || hover for mail &lt;br /&gt;
|-&lt;br /&gt;
| tasks || Boolean || true,false || hover for tasks&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
===setting for tasks===&lt;br /&gt;
This objects holds the settings for tasks&lt;br /&gt;
{| id=&amp;quot;tasks objects&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;tasks objects&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| interval || Number || 5,10,15,20,30,60 || interval for reminder&lt;br /&gt;
|-&lt;br /&gt;
| gridsort || String || asc || how tasks get sorted&lt;br /&gt;
|-&lt;br /&gt;
| view || String || tasks/(split,list) || task view&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
===foldertree object===&lt;br /&gt;
this is an internal gui object to store the folder tree on logout. This&lt;br /&gt;
object should not be modified.&lt;br /&gt;
{| id=&amp;quot;foldertree object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;foldertree object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| FolderTreeState || Object || foldertree object || folder tree state on GUI logout, you should not touch &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
===Settings for contacts===&lt;br /&gt;
the contacts object holds the settings for the contacts.&lt;br /&gt;
{| id=&amp;quot;contacts object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;contacts object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| gridsort ||String || asc || Sorting of contacts&lt;br /&gt;
|-&lt;br /&gt;
| cardsToViewPerColumn || String || auto,4,5,6,7|| displayed cards per column &lt;br /&gt;
|-&lt;br /&gt;
| view || String || contacts/(cards,phonelist) || card view&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
===settings for the calendar===&lt;br /&gt;
The calendar object stores the settings for the calendar.&lt;br /&gt;
{| id=&amp;quot;calendar object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot; &lt;br /&gt;
|+&#039;&#039;&#039;calendar object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| workweek ||Object || [[#workweek object|workweek object]] || settings for the workweek &lt;br /&gt;
|-&lt;br /&gt;
| endtime || Number || 0..23 || calendar display end time in hours&lt;br /&gt;
|-&lt;br /&gt;
| teams || Array || [[#teams object|teams object]] || Array of teams&lt;br /&gt;
|-&lt;br /&gt;
| allfolders ||Boolean || true,false || activate &amp;quot;Show all my appointments from all calendars&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| starttime || Number || 0..23 || calendar display end time in hours&lt;br /&gt;
|-&lt;br /&gt;
| interval || Number || 5,10,15,20,30,60 || calendar resolution&lt;br /&gt;
|-&lt;br /&gt;
| day || Object || [[#day object|day object]] || settings for day view &lt;br /&gt;
|-&lt;br /&gt;
| view || String || calendar/(calendar,team,list)/(day,workweek,month,week,custom,) || Calendar view, for team, groupware functionality must be available. &#039;&#039;&#039;Deprecated&#039;&#039;&#039;, see views.&lt;br /&gt;
|-&lt;br /&gt;
| views || Object || [[#views object|views object]] || default calendar views&lt;br /&gt;
|-&lt;br /&gt;
| custom || Object || [[#custom object|custom object]] || setting for the custom view&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;workweek object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot; &lt;br /&gt;
|+&#039;&#039;&#039;workweek object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| countdays || Number || 1,2,3,4,5,6,7 || Number of days in work week&lt;br /&gt;
|-&lt;br /&gt;
| numberofappointments || Number || 1,2,3,4,5,6,7,8 || Number of concurrent appointments shown in workweek view&lt;br /&gt;
|-&lt;br /&gt;
| startday || Number || 0,1,2,3,4,5,6 || 0 Sunday,...,6 Saturday  &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;day object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot; &lt;br /&gt;
|+&#039;&#039;&#039;day object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| numberofappointments || Number || 1,2,3,4,5,6,7,8 || Number of concurrent appointments shown in day view&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;views object&amp;quot; style=&amp;quot;width: 100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot;&lt;br /&gt;
|+&#039;&#039;&#039;views object&#039;&#039;&#039;&lt;br /&gt;
! name !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| shared || Boolean || true, false || Whether all views share the same default time range or not.&lt;br /&gt;
|-&lt;br /&gt;
| view || String || &amp;quot;calendar&amp;quot;, &amp;quot;team&amp;quot;, &amp;quot;list&amp;quot; || Default view.&lt;br /&gt;
|-&lt;br /&gt;
| calendar || String || &amp;quot;day&amp;quot;, &amp;quot;workweek&amp;quot;, &amp;quot;month&amp;quot;, &amp;quot;week&amp;quot;, &amp;quot;custom&amp;quot; || Default time range for the calendar view.&lt;br /&gt;
|-&lt;br /&gt;
| team || String || &amp;quot;day&amp;quot;, &amp;quot;workweek&amp;quot;, &amp;quot;month&amp;quot;, &amp;quot;week&amp;quot;, &amp;quot;custom&amp;quot; || Default time range for the team view.&lt;br /&gt;
|-&lt;br /&gt;
| list || String || &amp;quot;day&amp;quot;, &amp;quot;workweek&amp;quot;, &amp;quot;month&amp;quot;, &amp;quot;week&amp;quot;, &amp;quot;custom&amp;quot; || Default time range for the list view.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;custom object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot; &lt;br /&gt;
|+&#039;&#039;&#039;custom object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| numberofappointments || Number || 1,2,3,4,5,6,7,8 || Number of concurrent appointments shown in day view&lt;br /&gt;
|-&lt;br /&gt;
| countdays || Number || 1,2,3,4,5,6,7 || Number of days in work week&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;teams object&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot; &lt;br /&gt;
|+&#039;&#039;&#039;teams object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| team_default || Boolean || true,false || true for the default team&lt;br /&gt;
|-&lt;br /&gt;
| name || string || name || name for the team&lt;br /&gt;
|-&lt;br /&gt;
| children || Array || [[#children objects|children objects]] || Array of children objects, childrens are users that belong to the team&lt;br /&gt;
|- &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;children objects&amp;quot; style=&amp;quot;width:100%&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot; align=&amp;quot;bottom&amp;quot; &lt;br /&gt;
|+&#039;&#039;&#039;children object&#039;&#039;&#039;&lt;br /&gt;
! name      !! type !! values !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || userid || user id of the team member&lt;br /&gt;
|-&lt;br /&gt;
| display _name || String || display name || display name of the team member&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || 1 || only 1 implemented&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
===example /path, saved from a fresh user directly after the first login/logout===&lt;br /&gt;
 /path={&amp;quot;calendar&amp;quot;:{&amp;quot;view&amp;quot;:&amp;quot;calendar/calendar/day&amp;quot;,&amp;quot;day&amp;quot;:{&amp;quot;numberofappointments&amp;quot;:4},&amp;quot;workweek&amp;quot;:{&amp;quot;countdays&amp;quot;:5,&amp;quot;startday&amp;quot;:1,&amp;quot;numberofappointments&amp;quot;:2},&amp;quot;starttime&amp;quot;:8,&amp;quot;allfolders&amp;quot;:true,&amp;quot;custom&amp;quot;:{&amp;quot;countdays&amp;quot;:3,&amp;quot;numberofappointments&amp;quot;:3},&amp;quot;endtime&amp;quot;:18,&amp;quot;interval&amp;quot;:30},&amp;quot;FolderTreeState&amp;quot;:{&amp;quot;folder_tree$1&amp;quot;:{&amp;quot;folder_tree$default&amp;quot;:{&amp;quot;folder_tree$default.INBOX&amp;quot;:{}},&amp;quot;folder_tree$25&amp;quot;:{}},&amp;quot;folder_tree$9&amp;quot;:{&amp;quot;folder_tree$10&amp;quot;:{&amp;quot;folder_tree$28&amp;quot;:{}}}},&amp;quot;contacts&amp;quot;:{&amp;quot;view&amp;quot;:&amp;quot;contacts/cards&amp;quot;,&amp;quot;cardsToViewPerColumn&amp;quot;:&amp;quot;auto&amp;quot;,&amp;quot;gridsort&amp;quot;:&amp;quot;asc&amp;quot;},&amp;quot;theme&amp;quot;:{&amp;quot;path&amp;quot;:&amp;quot;default&amp;quot;,&amp;quot;name&amp;quot;:&amp;quot;Default&amp;quot;},&amp;quot;portal&amp;quot;:{&amp;quot;infobox&amp;quot;:true,&amp;quot;internalcontents&amp;quot;:[{&amp;quot;params&amp;quot;:{&amp;quot;limit&amp;quot;:5},&amp;quot;header&amp;quot;:&amp;quot;E-Mail&amp;quot;,&amp;quot;visible&amp;quot;:true,&amp;quot;adj&amp;quot;:{&amp;quot;hw&amp;quot;:1,&amp;quot;ww&amp;quot;:1,&amp;quot;y&amp;quot;:0,&amp;quot;x&amp;quot;:1},&amp;quot;external&amp;quot;:false,&amp;quot;module&amp;quot;:&amp;quot;mail&amp;quot;},{&amp;quot;params&amp;quot;:{&amp;quot;limit&amp;quot;:5},&amp;quot;header&amp;quot;:&amp;quot;Calendar&amp;quot;,&amp;quot;visible&amp;quot;:true,&amp;quot;adj&amp;quot;:{&amp;quot;hw&amp;quot;:1,&amp;quot;ww&amp;quot;:1,&amp;quot;y&amp;quot;:0,&amp;quot;x&amp;quot;:0},&amp;quot;external&amp;quot;:false,&amp;quot;module&amp;quot;:&amp;quot;calendar&amp;quot;},{&amp;quot;params&amp;quot;:{&amp;quot;limit&amp;quot;:5},&amp;quot;header&amp;quot;:&amp;quot;InfoStore&amp;quot;,&amp;quot;visible&amp;quot;:true,&amp;quot;adj&amp;quot;:{&amp;quot;hw&amp;quot;:1,&amp;quot;ww&amp;quot;:1,&amp;quot;y&amp;quot;:1,&amp;quot;x&amp;quot;:0},&amp;quot;external&amp;quot;:false,&amp;quot;module&amp;quot;:&amp;quot;infostore&amp;quot;},{&amp;quot;params&amp;quot;:{&amp;quot;limit&amp;quot;:5},&amp;quot;header&amp;quot;:&amp;quot;Tasks&amp;quot;,&amp;quot;visible&amp;quot;:true,&amp;quot;adj&amp;quot;:{&amp;quot;hw&amp;quot;:1,&amp;quot;ww&amp;quot;:1,&amp;quot;y&amp;quot;:1,&amp;quot;x&amp;quot;:1},&amp;quot;external&amp;quot;:false,&amp;quot;module&amp;quot;:&amp;quot;tasks&amp;quot;}],&amp;quot;tooltip&amp;quot;:false,&amp;quot;externalcontents&amp;quot;:[],&amp;quot;minicalendar&amp;quot;:true},&amp;quot;infostore&amp;quot;:{&amp;quot;view&amp;quot;:&amp;quot;infostore/split&amp;quot;},&amp;quot;effects&amp;quot;:{&amp;quot;hover&amp;quot;:{&amp;quot;calendar&amp;quot;:true,&amp;quot;speed&amp;quot;:2,&amp;quot;contacts&amp;quot;:true,&amp;quot;portal&amp;quot;:true,&amp;quot;infostore&amp;quot;:true,&amp;quot;mail&amp;quot;:true,&amp;quot;tasks&amp;quot;:true},&amp;quot;global&amp;quot;:false,&amp;quot;fading&amp;quot;:false},&amp;quot;mail&amp;quot;:{&amp;quot;newmail_options&amp;quot;:{&amp;quot;cc&amp;quot;:true,&amp;quot;bcc&amp;quot;:false,&amp;quot;from&amp;quot;:true,&amp;quot;options&amp;quot;:false},&amp;quot;view&amp;quot;:&amp;quot;mail/hsplit/unthreaded&amp;quot;,&amp;quot;formatmessage&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;notifyacknoledge&amp;quot;:true,&amp;quot;autocomplete&amp;quot;:true,&amp;quot;auto_save_drafts&amp;quot;:3,&amp;quot;signatures&amp;quot;:[],&amp;quot;fullmailheader&amp;quot;:true,&amp;quot;htmlmessage&amp;quot;:true},&amp;quot;tasks&amp;quot;:{&amp;quot;view&amp;quot;:&amp;quot;tasks/split&amp;quot;,&amp;quot;gridsort&amp;quot;:&amp;quot;asc&amp;quot;,&amp;quot;interval&amp;quot;:30},&amp;quot;menu&amp;quot;:{&amp;quot;menuiteration&amp;quot;:4},&amp;quot;private_categories&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;global&amp;quot;:{&amp;quot;autorefresh&amp;quot;:10,&amp;quot;save&amp;quot;:1,&amp;quot;confirmtimestamp&amp;quot;:1216928454103,&amp;quot;confirmpopup&amp;quot;:true}}&lt;br /&gt;
&lt;br /&gt;
for example, here is how it would work on the command line:&lt;br /&gt;
 /opt/open-xchangen/sbin/changeuser -c 71 -i 5 --addguipreferences \&lt;br /&gt;
 &#039;/gui={&amp;quot;calendar&amp;quot;:{&amp;quot;view&amp;quot;:&amp;quot;calendar/calendar/day&amp;quot;,&amp;quot;day&amp;quot;:{&amp;quot;numberofappointments&amp;quot;:4},\&lt;br /&gt;
  &amp;quot;workweek&amp;quot;:{&amp;quot;countdays&amp;quot;:5,&amp;quot;startday&amp;quot;:1,&amp;quot;numberofappointments&amp;quot;:2},&amp;quot;starttime&amp;quot;:8,&amp;quot;allfolders&amp;quot;:true,\ &lt;br /&gt;
 &amp;quot;custom&amp;quot;:{&amp;quot;countdays&amp;quot;:3,&amp;quot;numberofappointments&amp;quot;:3},&amp;quot;endtime&amp;quot;:18,&amp;quot;interval&amp;quot;:30},\ &lt;br /&gt;
 &amp;quot;FolderTreeState&amp;quot;:{&amp;quot;folder_tree$1&amp;quot;:{&amp;quot;folder_tree$default&amp;quot;:{&amp;quot;folder_tree$default.INBOX&amp;quot;:{}},\ &lt;br /&gt;
 &amp;quot;folder_tree$25&amp;quot;:{}},&amp;quot;folder_tree$9&amp;quot;:{&amp;quot;folder_tree$10&amp;quot;:{&amp;quot;folder_tree$28&amp;quot;:{}}}},\ &lt;br /&gt;
 &amp;quot;contacts&amp;quot;:{&amp;quot;view&amp;quot;:&amp;quot;contacts/cards&amp;quot;,&amp;quot;cardsToViewPerColumn&amp;quot;:&amp;quot;auto&amp;quot;,&amp;quot;gridsort&amp;quot;:&amp;quot;asc&amp;quot;},\ &lt;br /&gt;
 &amp;quot;theme&amp;quot;:{&amp;quot;path&amp;quot;:&amp;quot;default&amp;quot;,&amp;quot;name&amp;quot;:&amp;quot;Default&amp;quot;},\ &amp;quot;portal&amp;quot;:{&amp;quot;infobox&amp;quot;:true,\ &lt;br /&gt;
 &amp;quot;internalcontents&amp;quot;:[{&amp;quot;params&amp;quot;:{&amp;quot;limit&amp;quot;:5},&amp;quot;header&amp;quot;:&amp;quot;E-Mail&amp;quot;,&amp;quot;visible&amp;quot;:true,\ &lt;br /&gt;
 &amp;quot;adj&amp;quot;:{&amp;quot;hw&amp;quot;:1,&amp;quot;ww&amp;quot;:1,&amp;quot;y&amp;quot;:0,&amp;quot;x&amp;quot;:1},&amp;quot;external&amp;quot;:false,&amp;quot;module&amp;quot;:&amp;quot;mail&amp;quot;},\ &lt;br /&gt;
 {&amp;quot;params&amp;quot;:{&amp;quot;limit&amp;quot;:5},&amp;quot;header&amp;quot;:&amp;quot;Calendar&amp;quot;,&amp;quot;visible&amp;quot;:true,\ &lt;br /&gt;
 &amp;quot;adj&amp;quot;:{&amp;quot;hw&amp;quot;:1,&amp;quot;ww&amp;quot;:1,&amp;quot;y&amp;quot;:0,&amp;quot;x&amp;quot;:0},\ &amp;quot;external&amp;quot;:false,&amp;quot;module&amp;quot;:&amp;quot;calendar&amp;quot;},\ &lt;br /&gt;
 {&amp;quot;params&amp;quot;:{&amp;quot;limit&amp;quot;:5},&amp;quot;header&amp;quot;:&amp;quot;InfoStore&amp;quot;,&amp;quot;visible&amp;quot;:true,\ &lt;br /&gt;
 &amp;quot;adj&amp;quot;:{&amp;quot;hw&amp;quot;:1,&amp;quot;ww&amp;quot;:1,&amp;quot;y&amp;quot;:1,&amp;quot;x&amp;quot;:0},&amp;quot;external&amp;quot;:false,&amp;quot;module&amp;quot;:&amp;quot;infostore&amp;quot;},\ &lt;br /&gt;
 {&amp;quot;params&amp;quot;:{&amp;quot;limit&amp;quot;:5},&amp;quot;header&amp;quot;:&amp;quot;Tasks&amp;quot;,&amp;quot;visible&amp;quot;:true,\ &lt;br /&gt;
 &amp;quot;adj&amp;quot;:{&amp;quot;hw&amp;quot;:1,&amp;quot;ww&amp;quot;:1,&amp;quot;y&amp;quot;:1,&amp;quot;x&amp;quot;:1},&amp;quot;external&amp;quot;:false,&amp;quot;module&amp;quot;:&amp;quot;tasks&amp;quot;}],\ &lt;br /&gt;
 &amp;quot;tooltip&amp;quot;:false,&amp;quot;externalcontents&amp;quot;:[],&amp;quot;minicalendar&amp;quot;:true},\ &lt;br /&gt;
 &amp;quot;infostore&amp;quot;:{&amp;quot;view&amp;quot;:&amp;quot;infostore/split&amp;quot;},\ &lt;br /&gt;
 &amp;quot;effects&amp;quot;:{&amp;quot;hover&amp;quot;:{&amp;quot;calendar&amp;quot;:true,&amp;quot;speed&amp;quot;:2,&amp;quot;contacts&amp;quot;:true,\ &lt;br /&gt;
 &amp;quot;portal&amp;quot;:true,&amp;quot;infostore&amp;quot;:true,&amp;quot;mail&amp;quot;:true,&amp;quot;tasks&amp;quot;:true},\ &lt;br /&gt;
 &amp;quot;global&amp;quot;:false,&amp;quot;fading&amp;quot;:false},\ &lt;br /&gt;
 &amp;quot;mail&amp;quot;:{&amp;quot;newmail_options&amp;quot;:{&amp;quot;cc&amp;quot;:true,&amp;quot;bcc&amp;quot;:false,&amp;quot;from&amp;quot;:true,&amp;quot;options&amp;quot;:false},\ &lt;br /&gt;
 &amp;quot;view&amp;quot;:&amp;quot;mail/hsplit/unthreaded&amp;quot;,&amp;quot;formatmessage&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,\ &lt;br /&gt;
 &amp;quot;notifyacknoledge&amp;quot;:true,&amp;quot;autocomplete&amp;quot;:true,&amp;quot;auto_save_drafts&amp;quot;:3,\ &lt;br /&gt;
 &amp;quot;signatures&amp;quot;:[],&amp;quot;fullmailheader&amp;quot;:true,&amp;quot;htmlmessage&amp;quot;:true},\ &lt;br /&gt;
 &amp;quot;tasks&amp;quot;:{&amp;quot;view&amp;quot;:&amp;quot;tasks/split&amp;quot;,&amp;quot;gridsort&amp;quot;:&amp;quot;asc&amp;quot;,&amp;quot;interval&amp;quot;:30},\ &lt;br /&gt;
 &amp;quot;menu&amp;quot;:{&amp;quot;menuiteration&amp;quot;:4},&amp;quot;private_categories&amp;quot;:&amp;quot;&amp;quot;,\ &lt;br /&gt;
 &amp;quot;global&amp;quot;:{&amp;quot;autorefresh&amp;quot;:10,&amp;quot;save&amp;quot;:1,&amp;quot;confirmtimestamp&amp;quot;:1216928454103,\ &lt;br /&gt;
 &amp;quot;confirmpopup&amp;quot;:true}}&#039;&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=16406</id>
		<title>OX6:Gui Plugin Development</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=16406"/>
		<updated>2013-11-14T08:45:35Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Added note that this documentation refers to the OX6 UI&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction OX6-GUI Plugin development=&lt;br /&gt;
&lt;br /&gt;
With Open-Xchange you will be able to add your own JavaScript code for existing events. The following examples show how you can add your own About page, your own Window Title, and your own message for not activated/bought components of OX (Upsell Message). Please note, this development guide has been written exclusively for the OX6 web-frontend, if you are looking for the AppSuite UI development documentation please have a look here http://oxpedia.org/index.php?title=AppSuite:UI&lt;br /&gt;
&lt;br /&gt;
= Setup and file description =&lt;br /&gt;
&lt;br /&gt;
Two things have to be done to register your own JavaScript code within the server:&lt;br /&gt;
&lt;br /&gt;
1. You have to create the property file in /opt/open-xchange/etc/groupware/settings/, for example myjscode.properties. The file should have the following value:&lt;br /&gt;
&lt;br /&gt;
 modules/$NAME/enabled=true&lt;br /&gt;
&lt;br /&gt;
$NAME is equal to the file name of the property file, in our case it would be:&lt;br /&gt;
&lt;br /&gt;
 modules/myjscode/enabled=true&lt;br /&gt;
&lt;br /&gt;
This will enable the JS code located in $WEBSRV/ox6/plugins/$NAME (for example /var/www/ox6/plugins/myjscode/).&lt;br /&gt;
&lt;br /&gt;
2. Next we have to create the folder that we configured, in our example we would have to create:&lt;br /&gt;
&lt;br /&gt;
 mkdir /var/www/ox6/plugins/myjscode/&lt;br /&gt;
&lt;br /&gt;
The server now will have a look at this directory and searches for the register.js file in this directory. All your JS enhancements should be written to that file.&lt;br /&gt;
&lt;br /&gt;
3. Afterwards you have to restart the groupware server with:&lt;br /&gt;
&lt;br /&gt;
 /etc/init.d/open-xchange-groupware restart&lt;br /&gt;
&lt;br /&gt;
= Examples =&lt;br /&gt;
&lt;br /&gt;
== Customized About page ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/productinfo.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/productinfo/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/productinfo/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.vendor_address = &amp;quot;&amp;lt;b&amp;gt;Open-Xchange GmbH&amp;lt;/b&amp;gt;\nMartinstrasse 41\n57462 Olpe\nE-Mail: info@open-xchange.com\n&amp;lt;a href=\&amp;quot;http://www.open-xchange.com\&amp;quot; target=\&amp;quot;_blank\&amp;quot;&amp;gt;www.open-xchange.com&amp;lt;/a&amp;gt;&amp;quot;&lt;br /&gt;
&lt;br /&gt;
== Customized Window Title ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/windowtitle.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/windowtitle/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/windowtitle/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.product_name = &amp;quot;This is the fabulous Open-Xchange Server&amp;quot;; &lt;br /&gt;
 &lt;br /&gt;
 try {&lt;br /&gt;
     window.document.title = oxProductInfo.product_name;&lt;br /&gt;
 } catch (e) { }&lt;br /&gt;
&lt;br /&gt;
If you want to change the window title on the login page:&lt;br /&gt;
&lt;br /&gt;
 vi /var/www/ox6/plugins/static.conf&lt;br /&gt;
&lt;br /&gt;
insert:&lt;br /&gt;
&lt;br /&gt;
 login.title&lt;br /&gt;
&lt;br /&gt;
create the directory and edit the file:&lt;br /&gt;
&lt;br /&gt;
 mkdir /var/www/ox6/plugins/login.title/  &lt;br /&gt;
 vi /var/www/ox6/plugins/login.title/register.js&lt;br /&gt;
&lt;br /&gt;
 try {&lt;br /&gt;
    window.document.title = &amp;quot;This is the fabulous Open-Xchange Server&amp;quot;;&lt;br /&gt;
 } catch (e) { }&lt;br /&gt;
&lt;br /&gt;
== Customized Upsell Message ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/upsell.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com&lt;br /&gt;
 # &lt;br /&gt;
 # Author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 # The following property enables the Upsell-Layer Plugin for the OX6 AJAX GUI&lt;br /&gt;
 modules/upsell/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/upsell/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 /*&lt;br /&gt;
  * Example for an Upsell-Layer&lt;br /&gt;
  * The OX GUI triggers a special event if a user clicks on disabled features.&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
  /*&lt;br /&gt;
   * Register to Upsell-Event&lt;br /&gt;
   */&lt;br /&gt;
  register(&amp;quot;Feature_Not_Available&amp;quot;, showUpsellLayer);&lt;br /&gt;
 &lt;br /&gt;
  /**&lt;br /&gt;
   * Function to display an Upsell-Alert dialog&lt;br /&gt;
   * @param feature String (optional) - Module description&lt;br /&gt;
   * @param win Window (optional) - Only needed/given if we trigger the event from the new object windows &lt;br /&gt;
   */&lt;br /&gt;
  function showUpsellLayer(feature, win) {&lt;br /&gt;
     // setting corewindow to default if win is not defined&lt;br /&gt;
     win = win || corewindow; &lt;br /&gt;
     &lt;br /&gt;
     /*&lt;br /&gt;
      * Build up the dialog content&lt;br /&gt;
      * Note: You can also use myDiv.innerHTML!&lt;br /&gt;
      */&lt;br /&gt;
     var myDiv = newnode(&amp;quot;div&amp;quot;,{ textAlign: &amp;quot;center&amp;quot;, padding: &amp;quot;10px&amp;quot; }, 0, [ &lt;br /&gt;
             newnode(&amp;quot;div&amp;quot;, 0, { background: &amp;quot;url(http://www.example.com/img/header/logo.gif)&amp;quot; }, 0,&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;span&amp;quot;, 0, 0, [ &lt;br /&gt;
                 document.createTextNode(&amp;quot;Diese Funktion ist nur in Open-Xchange Premium verfügbar!&amp;quot;) ],&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Weitere Information zu Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Paket-Upgrade auf Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document) &lt;br /&gt;
         ], win.document);&lt;br /&gt;
     &lt;br /&gt;
     // calling the newAlert function to open the dialog at the given window&lt;br /&gt;
     win.newAlert(&amp;quot;Hinweis &amp;quot; + feature, null, AlertPopup.close, myDiv);&lt;br /&gt;
  }&lt;br /&gt;
  &lt;br /&gt;
  /*&lt;br /&gt;
   * Comment this out to change the grayed out module images in the upper left corner!&lt;br /&gt;
   */&lt;br /&gt;
  /*&lt;br /&gt;
  if (!document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src.match(/mod_portal_sel.gif$/)) {&lt;br /&gt;
     document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src = getFullImgSrc(&amp;quot;img/portal/mod_portal.gif&amp;quot;);&lt;br /&gt;
  }&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_calendar&amp;quot;).src = getFullImgSrc(&amp;quot;img/calendar/mod_calendar.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_tasks&amp;quot;).src = getFullImgSrc(&amp;quot;img/tasks/mod_tasks.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_infostore&amp;quot;).src = getFullImgSrc(&amp;quot;img/infostore/mod_infostore.gif&amp;quot;);&lt;br /&gt;
  */&lt;br /&gt;
&lt;br /&gt;
Currently, the parameter &amp;lt;code&amp;gt;feature&amp;lt;/code&amp;gt; can have following values:&lt;br /&gt;
* configuration/mail/accounts/new&lt;br /&gt;
* modules/calendar&lt;br /&gt;
* modules/calendar/freebusy&lt;br /&gt;
* modules/calendar/mini_calender&lt;br /&gt;
* modules/calendar/new/add_attachment&lt;br /&gt;
* modules/calendar/new/add_participants&lt;br /&gt;
* modules/calendar/new/delete_attachment&lt;br /&gt;
* modules/calendar/new/remove_participants&lt;br /&gt;
* modules/calendar/save_to_infostore&lt;br /&gt;
* modules/calendar/team&lt;br /&gt;
* modules/contacts&lt;br /&gt;
* modules/contacts/save_to_infostore&lt;br /&gt;
* modules/contacts/new/add_attachment&lt;br /&gt;
* modules/contacts/new/delete_attachment&lt;br /&gt;
* modules/folders/users&lt;br /&gt;
* modules/infostore&lt;br /&gt;
* modules/infostore/send_as_attachment&lt;br /&gt;
* modules/infostore/send_as_link&lt;br /&gt;
* modules/infostore/mail/save_to_infostore&lt;br /&gt;
* modules/mail&lt;br /&gt;
* modules/mail/save_to_infostore&lt;br /&gt;
* modules/mail/new/add_infostore_attachment&lt;br /&gt;
* modules/mail/open-ical (added with 6.20.4)&lt;br /&gt;
* modules/mail/open-vcard (added with 6.20.4)&lt;br /&gt;
* modules/portal&lt;br /&gt;
* modules/tasks&lt;br /&gt;
* modules/tasks/save_to_infostore&lt;br /&gt;
* modules/tasks/new/add_participants&lt;br /&gt;
* modules/tasks/new/remove_participants&lt;br /&gt;
* modules/tasks/new/add_attachment&lt;br /&gt;
* modules/tasks/new/delete_attachment&lt;br /&gt;
&lt;br /&gt;
The following events may triggered by plugins (if enabled):&lt;br /&gt;
* modules/usm/eas&lt;br /&gt;
&lt;br /&gt;
== Customized / Extended configuration tree ==&lt;br /&gt;
&lt;br /&gt;
In order to extend your configuration frontend you will have to make more changes than overwriting existing JS methods. You have to implement your own configuration site. Below, you will find the JS API Doc that will show you how to build external contents into the configuration frontend:&lt;br /&gt;
&lt;br /&gt;
[[Main_Page_CE#Programming_Interfaces|Programming Interfaces]]&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/extendconfiguration.properties:&lt;br /&gt;
&lt;br /&gt;
 modules/extendconfiguration/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/extendconfiguration/register.js:&lt;br /&gt;
&lt;br /&gt;
 // Extending the configuration tree.&lt;br /&gt;
 &lt;br /&gt;
 // Add a new folder-like node called &amp;quot;Example&amp;quot;, and inside it another node&lt;br /&gt;
 // called &amp;quot;Page&amp;quot;. The position of a node is specified by a path string.&lt;br /&gt;
 // Each tree level is separated by slashes. There should be only two levels&lt;br /&gt;
 // below the standard &amp;quot;configuration&amp;quot; root element: configuration/x for inner&lt;br /&gt;
 // nodes and configuration/x/y for leaf nodes.&lt;br /&gt;
 &lt;br /&gt;
 new ox.Configuration.InnerNode(&amp;quot;configuration/example&amp;quot;, &amp;quot;Example&amp;quot;);&lt;br /&gt;
 var node = new ox.Configuration.LeafNode(&amp;quot;configuration/example/page&amp;quot;, &amp;quot;Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Connect the node to a new page. &lt;br /&gt;
 &lt;br /&gt;
 var page = new ox.Configuration.Page(node, &amp;quot;Example Configuration Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All data on the page is collected in a single data object. This object is&lt;br /&gt;
 // transmitted to and from the server in the methods load() and save() using&lt;br /&gt;
 // static methods of ox.JSON.&lt;br /&gt;
 // For save(), the parameter cont is a continuation function which must be&lt;br /&gt;
 // called after the data was saved successfully.&lt;br /&gt;
 &lt;br /&gt;
 page.save = function(data, cont) {&lt;br /&gt;
     ox.JSON.put(AjaxRoot + &amp;quot;/serverplugin?action=set&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         data, cont);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // The continuation function of load() expects the data object as parameter.&lt;br /&gt;
 // To extract the data object from the server reply, a new continuation function&lt;br /&gt;
 // is used.&lt;br /&gt;
 &lt;br /&gt;
 page.load = function(cont) {&lt;br /&gt;
     ox.JSON.get(AjaxRoot + &amp;quot;/serverplugin?action=get&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         function(reply) { cont(reply.data); });&lt;br /&gt;
 };&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Content is added to the page with the method addWidget().&lt;br /&gt;
 // Here, a static text is added at the top of the page.&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.Text(&amp;quot;Long explanation text&amp;quot;));&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Individual input widgets can be connected to fields in the data object by&lt;br /&gt;
 // specifying the field name as the second parameter to addWidget().&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.CheckBox(&amp;quot;CheckBox Label&amp;quot;), &amp;quot;fieldname&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Layout can be controlled by using container widgets.&lt;br /&gt;
 // Configuration pages currently support only the Group container, which adds&lt;br /&gt;
 // a header over its children.&lt;br /&gt;
 // Every group has its own data object, which becomes nested in the page&#039;s&lt;br /&gt;
 // data object.&lt;br /&gt;
 &lt;br /&gt;
 var group = new ox.Configuration.Group(&amp;quot;Group title&amp;quot;);&lt;br /&gt;
 page.addWidget(group, &amp;quot;subobject&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Adding widgets to a goup happens exactly like for a page, since both are&lt;br /&gt;
 // descendants of ox.UI.Container.&lt;br /&gt;
 &lt;br /&gt;
 var input = new ox.UI.Input(&amp;quot;Detail field&amp;quot;);&lt;br /&gt;
 group.addWidget(input, &amp;quot;input&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All input widgets have a default value which is used when the data object&lt;br /&gt;
 // does not contain the widget&#039;s field (e. g. on first login).&lt;br /&gt;
 &lt;br /&gt;
 input.default_value = &amp;quot;default&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // ox.UI.Selection has many descendants which implement the same thing:&lt;br /&gt;
 // A field which must contain one of several possible values.&lt;br /&gt;
 // The possible values are set with the method setEntries().&lt;br /&gt;
 &lt;br /&gt;
 var choice = new ox.UI.ComboBox(&amp;quot;Choice&amp;quot;);&lt;br /&gt;
 group.addWidget(choice, &amp;quot;choice&amp;quot;);&lt;br /&gt;
 choice.setEntries([0, 1, Infinity], [&amp;quot;Zero&amp;quot;, &amp;quot;One&amp;quot;, &amp;quot;Infinity&amp;quot;]);&lt;br /&gt;
&lt;br /&gt;
== Customized new buttons in the panel ==&lt;br /&gt;
&lt;br /&gt;
This example adds a new area to the contacts panel called &amp;quot;SMS&amp;quot;. The area then&lt;br /&gt;
has two buttons, &amp;quot;Display&amp;quot; and &amp;quot;Send&amp;quot;. The &amp;quot;Display&amp;quot; button is active if one ore &lt;br /&gt;
multiple contacts are selected and fires a js alert for each of them when being &lt;br /&gt;
clicked. The &amp;quot;SMS&amp;quot; button is only active when one single contact is active&lt;br /&gt;
and has a business telephone number stored in it. On click a js alert is &lt;br /&gt;
executed and the telephone number is displayed.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Viktor&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 //create a new menu Object for the panel and define the unique id (id1 here)&lt;br /&gt;
 var contextmenu = MenuNodes.createSmallButtonContext(&amp;quot;id1&amp;quot;, &amp;quot;SMS&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 /**&lt;br /&gt;
  * Add menu Entries to the new generated panel object and define the icons&lt;br /&gt;
  * as well as the to be called functions. The identifiers must be unique &lt;br /&gt;
  * all over the complete js code (button1 and button2) in this example&lt;br /&gt;
  */&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button1&amp;quot;, &amp;quot;Display&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click1);&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button2&amp;quot;, &amp;quot;Send&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click2);&lt;br /&gt;
 /* The pannel object gets the id 20 and gets displayed in the fixed area&lt;br /&gt;
  * possible areas are FIXED and DYNAMIC the id controls the order in the areas&lt;br /&gt;
  */ &lt;br /&gt;
 addMenuNode(contextmenu.node, MenuNodes.FIXED, 20);&lt;br /&gt;
 &lt;br /&gt;
 //Following makes the new pannel options dynamic active/inactive&lt;br /&gt;
 changeDisplay(&amp;quot;contacts&amp;quot;, &amp;quot;id1&amp;quot;);&lt;br /&gt;
 menuarrows[&amp;quot;contacts&amp;quot;] = {};&lt;br /&gt;
 function changeplugin() {&lt;br /&gt;
     menuglobalzaehler = 0;&lt;br /&gt;
     menuarrows[&amp;quot;contacts&amp;quot;][&amp;quot;id1&amp;quot;] = new Array();&lt;br /&gt;
 //menucountselected here holds the amount of select items&lt;br /&gt;
     menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;, menucountselected &amp;gt;= 1,&lt;br /&gt;
 &amp;quot;button1&amp;quot;);&lt;br /&gt;
 // following an example how to get data out of the GUI internal cache. button2&lt;br /&gt;
 // is only active when a contact which as a business tel number is selected.&lt;br /&gt;
   if (activemodule == &amp;quot;contacts&amp;quot;) {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, function(data) {&lt;br /&gt;
             menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;,&lt;br /&gt;
                 menucountselected == 1 &amp;amp;&amp;amp;&lt;br /&gt;
 data.objects[0].telephone_business1,&lt;br /&gt;
                 &amp;quot;button2&amp;quot;);&lt;br /&gt;
         });&lt;br /&gt;
    }&lt;br /&gt;
 }&lt;br /&gt;
 register(&amp;quot;OX_SELECTED_ITEMS_CHANGED&amp;quot;, changeplugin); &lt;br /&gt;
 &lt;br /&gt;
 //now the called functions for the buttons follow&lt;br /&gt;
 function click1() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;id&amp;quot;, &amp;quot;folder_id&amp;quot;, &amp;quot;last_name&amp;quot;]&lt;br /&gt;
     }, null, display);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function click2() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, call);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function display(data) {&lt;br /&gt;
     for (var i = 0; i &amp;lt; menucountselected; i++)&lt;br /&gt;
         alert(data.objects[i].last_name);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function call(data) {&lt;br /&gt;
      alert(&amp;quot;Now, a SMS to &amp;quot; + data.objects[0].telephone_business1 + &lt;br /&gt;
             &amp;quot; could have been sent&amp;quot;);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
== Embedding external webapps which require authentication (works with OX 6.16 and higher) == &lt;br /&gt;
&lt;br /&gt;
In other examples on this page/wiki, you learned how to extend the settings tree with your own links to external web sites or similar. &lt;br /&gt;
But often it is required to login into such external web applications with some credentials. In many situations, the OX credentials and the credentials for the external web app are the same. So it would be an improvement for the OX user to be automatically logged in to this webapp when clicking some link within OX settings tree. &lt;br /&gt;
&lt;br /&gt;
To achieve this functionality, we introduced a new servlet in OX version 6.16 and higher with some kind of &amp;quot;Single Sign On&amp;quot; functionality, which is reachable at path &amp;quot;/ajax/sso&amp;quot; only via HTTPS (INFO: HTTP connections will NOT work). This servlet can be used to retrieve the following data from the user which uses the OX GUI:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 &amp;quot;login&amp;quot; -&amp;gt; The string which was entered at OX login screen.&lt;br /&gt;
 &amp;quot;imap_login&amp;quot; -&amp;gt; The string which was provisioned into the OX account as &amp;quot;imaplogin. This is used to authenticate against the primary IMAP/Mail Account.&lt;br /&gt;
 &amp;quot;username&amp;quot; -&amp;gt; OX internal username which was choosen by the administrator of the OX context/setup.&lt;br /&gt;
 &amp;quot;password&amp;quot; -&amp;gt; The password of the user.&lt;br /&gt;
 &amp;quot;context_id&amp;quot; -&amp;gt; OX internal number which references the context where the user resides in. Specified by the administrator at OX context creation.&lt;br /&gt;
 &amp;quot;context_name&amp;quot; -&amp;gt; OX internal string which references the context. Specified by the administrator at OX context creation.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Basically, you have to extend the settings/configuration tree in OX to contain a custom link/button where the user can click on. If this link is clicked, you have to call the SSO servlet with the session-id of the current user. Once you called the servlet, it will send some response with a json object which contains the needed data explained above. You can then use this data to &amp;quot;POST&amp;quot; to your external Webapplication Login URL, once your Webapplication has authenticated the POST request, it should redirect the request to its main application. In this case, the OX user is now successfully logged in to your external web application with just a click instead of entering his credentials again.&lt;br /&gt;
&lt;br /&gt;
Here is an example, how to call the SSO servlet:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
//this will fetch needed infos for redirecting&lt;br /&gt;
function callExtAPP(){&lt;br /&gt;
	ox.JSON.get(&amp;quot;/ajax/sso?action=get&amp;amp;session=&amp;quot;+session, function(reply) {&lt;br /&gt;
		username = reply.data.username;&lt;br /&gt;
		password = reply.data.password;&lt;br /&gt;
		login = reply.data.login;&lt;br /&gt;
	});&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
You can call this function for example on a &amp;quot;onClick&amp;quot; event, which was triggered by an OX user who clicks some link in the configuration/settings tree.&lt;br /&gt;
&lt;br /&gt;
== Custom widget for the sidebar ( works with OX 6.18.2 and higher ) ==&lt;br /&gt;
&lt;br /&gt;
The sidebar has the possibility to add custom content, for example advertising, upsell or special help. The available space is equal to the, per default shown, mini calendar. The custom widget can be added below, above and as replacement for the mini calendar:&lt;br /&gt;
&lt;br /&gt;
 // create the widget&lt;br /&gt;
 var swidget = new ox.gui.Custom(function() {&lt;br /&gt;
     this.dom.node.innerHTML = &amp;quot;Hey, I&#039;m an custom widget!&amp;quot;;&lt;br /&gt;
 }, &amp;quot;custom-widget&amp;quot;).&lt;br /&gt;
 css({ backgroundColor: &amp;quot;lightyellow&amp;quot;, border: &amp;quot;1px solid #fc0&amp;quot;, &lt;br /&gt;
     padding: &amp;quot;5px&amp;quot;, lineHeight: &amp;quot;11pt&amp;quot;, height: &amp;quot;100%&amp;quot; }). setLayoutParam({ position: &amp;quot;bottom&amp;quot;, height: &amp;quot;50px&amp;quot; });  &lt;br /&gt;
 &lt;br /&gt;
 // insert widget into the sidepanel on the given position&lt;br /&gt;
 // 3 = above mini-cal, 1 or 2 = below mini-cal &lt;br /&gt;
 ox.widgets.sidepanel.insert(swidget, 3);&lt;br /&gt;
 &lt;br /&gt;
 //trigger validate to force repaint&lt;br /&gt;
 ox.widgets.sidepanel.validate();&lt;br /&gt;
 &lt;br /&gt;
 // optional: remove comment to permanently disable the mini-calendar&lt;br /&gt;
 // ox.widgets.miniCalendar.disable();&lt;br /&gt;
 // ox.widgets.miniCalendar.hide();&lt;br /&gt;
&lt;br /&gt;
[[File:Custom-sidebar-widget.png]]&lt;br /&gt;
&lt;br /&gt;
== Customizing the Help, Logout, examples UWA link, Session Expired and Direct Link locations / URLs ==&lt;br /&gt;
&lt;br /&gt;
If you need to change or customize the Help, Logout, Session Expired or Direct Link locations / URLs you can use the following variables and parameters. You can set them anywhere within your plugin. If not set, the system defaults will be used. Don&#039;t use the expression &#039;var&#039; as this is publicly available.&lt;br /&gt;
&lt;br /&gt;
 // the base path for the help pages&lt;br /&gt;
 help_location = &amp;quot;[protocol]://[hostname][path]/help/[language{1}]/&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url after logout&lt;br /&gt;
 logout_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url if the session expires&lt;br /&gt;
 sessionExpired_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the direct link url, used in the infostore detail views and the new e-mail window&lt;br /&gt;
 // note: do not remove or modify the part &amp;quot;#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;, otherwise direct links won&#039;t work anymore&lt;br /&gt;
 directLink_location = &amp;quot;[protocol]://[hostname][path]#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // example for the UWA link from the UWA-Module settings page&lt;br /&gt;
 // The text between %s%s gets shown as href for the given link&lt;br /&gt;
 uwaLink.text = &amp;quot;Please have a look at the %sInteresting UWA modules%s page. It shows a list of widgets and their associated data.&amp;quot;&lt;br /&gt;
 uwaLink.link = &amp;quot;http://www.open-xchange.com/index.php?id=361&amp;amp;L=[language{0}]&amp;quot;&lt;br /&gt;
&lt;br /&gt;
As you can see you can use place holders, similar to other programming languages. These place holders will get parsed and replaced by the OX application. Here comes a short description of some of them:&lt;br /&gt;
&lt;br /&gt;
 [protocol]      = the current used protocol - e.g. http or https&lt;br /&gt;
 [hostname]      = the hostname - e.g www.myox.de&lt;br /&gt;
 [path]          = the path (if any) behind the hostname - e.g. /ox6/ - or empty if not used&lt;br /&gt;
 [file]          = the file parameter (if any) - e.g. ox.html&lt;br /&gt;
 [language{0|1}] = the users language - e.g. de_DE, where {0} is the language iso code and {1} the country iso code&lt;br /&gt;
 [context_id]    = the users context id&lt;br /&gt;
 [timezone]      = the users timezone - e.g. Europe/Berlin&lt;br /&gt;
&lt;br /&gt;
A full set of available parameters will follow soon.&lt;br /&gt;
Note: The parameters [module], [folder] and [object_id] are only available at the directLink and can&#039;t be used anywhere else.&lt;br /&gt;
&lt;br /&gt;
= Help Menu =&lt;br /&gt;
&lt;br /&gt;
It is possible to add entries to the pop-up menu of the help button in the top right corner. The following is a simple example which opens a language-specific help page:&lt;br /&gt;
&lt;br /&gt;
 var label = { de_DE: &amp;quot;Hilfe&amp;quot;, en_US: &amp;quot;Help&amp;quot;, fr_FR: &amp;quot;Aide&amp;quot; };&lt;br /&gt;
 HelpMenu.addText(label[config.language || &amp;quot;en_US&amp;quot;], displayLink);&lt;br /&gt;
 &lt;br /&gt;
 function displayLink() {&lt;br /&gt;
         open(&amp;quot;/help/&amp;quot; + config.language);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
The manual handling of the label is required until proper support for  the internationalization plug-in is implemented.&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=10340</id>
		<title>OX6:Gui Plugin Development</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=10340"/>
		<updated>2012-05-02T14:01:40Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: added additional trigger&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
With Open-Xchange you will be able to add your own JavaScript code for existing events. The following examples show how you can add your own About page, your own Window Title, and your own message for not activated/bought components of OX (Upsell Message).&lt;br /&gt;
&lt;br /&gt;
= Setup and file description =&lt;br /&gt;
&lt;br /&gt;
Two things have to be done to register your own JavaScript code within the server:&lt;br /&gt;
&lt;br /&gt;
1. You have to create the property file in /opt/open-xchange/etc/groupware/settings/, for example myjscode.properties. The file should have the following value:&lt;br /&gt;
&lt;br /&gt;
 modules/$NAME/enabled=true&lt;br /&gt;
&lt;br /&gt;
$NAME is equal to the file name of the property file, in our case it would be:&lt;br /&gt;
&lt;br /&gt;
 modules/myjscode/enabled=true&lt;br /&gt;
&lt;br /&gt;
This will enable the JS code located in $WEBSRV/ox6/plugins/$NAME (for example /var/www/ox6/plugins/myjscode/).&lt;br /&gt;
&lt;br /&gt;
2. Next we have to create the folder that we configured, in our example we would have to create:&lt;br /&gt;
&lt;br /&gt;
 mkdir /var/www/ox6/plugins/myjscode/&lt;br /&gt;
&lt;br /&gt;
The server now will have a look at this directory and searches for the register.js file in this directory. All your JS enhancements should be written to that file.&lt;br /&gt;
&lt;br /&gt;
3. Afterwards you have to restart the groupware server with:&lt;br /&gt;
&lt;br /&gt;
 /etc/init.d/open-xchange-groupware restart&lt;br /&gt;
&lt;br /&gt;
= Examples =&lt;br /&gt;
&lt;br /&gt;
== Customized About page ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/productinfo.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/productinfo/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/productinfo/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.vendor_address = &amp;quot;&amp;lt;b&amp;gt;Open-Xchange GmbH&amp;lt;/b&amp;gt;\nMartinstrasse 41\n57462 Olpe\nE-Mail: info@open-xchange.com\n&amp;lt;a href=\&amp;quot;http://www.open-xchange.com\&amp;quot; target=\&amp;quot;_blank\&amp;quot;&amp;gt;www.open-xchange.com&amp;lt;/a&amp;gt;&amp;quot;&lt;br /&gt;
&lt;br /&gt;
== Customized Window Title ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/windowtitle.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/windowtitle/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/windowtitle/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.product_name = &amp;quot;This is the fabulous Open-Xchange Server&amp;quot;; &lt;br /&gt;
 &lt;br /&gt;
 try {&lt;br /&gt;
     window.document.title = oxProductInfo.product_name;&lt;br /&gt;
 } catch (e) { }&lt;br /&gt;
&lt;br /&gt;
If you want to change the window title on the login page:&lt;br /&gt;
&lt;br /&gt;
 vi /var/www/ox6/plugins/static.conf&lt;br /&gt;
&lt;br /&gt;
insert:&lt;br /&gt;
&lt;br /&gt;
 login.title&lt;br /&gt;
&lt;br /&gt;
create the directory and edit the file:&lt;br /&gt;
&lt;br /&gt;
 mkdir /var/www/ox6/plugins/login.title/  &lt;br /&gt;
 vi /var/www/ox6/plugins/login.title/register.js&lt;br /&gt;
&lt;br /&gt;
 try {&lt;br /&gt;
    window.document.title = &amp;quot;This is the fabulous Open-Xchange Server&amp;quot;;&lt;br /&gt;
 } catch (e) { }&lt;br /&gt;
&lt;br /&gt;
== Customized Upsell Message ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/upsell.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com&lt;br /&gt;
 # &lt;br /&gt;
 # Author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 # The following property enables the Upsell-Layer Plugin for the OX6 AJAX GUI&lt;br /&gt;
 modules/upsell/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/upsell/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 /*&lt;br /&gt;
  * Example for an Upsell-Layer&lt;br /&gt;
  * The OX GUI triggers a special event if a user clicks on disabled features.&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
  /*&lt;br /&gt;
   * Register to Upsell-Event&lt;br /&gt;
   */&lt;br /&gt;
  register(&amp;quot;Feature_Not_Available&amp;quot;, showUpsellLayer);&lt;br /&gt;
 &lt;br /&gt;
  /**&lt;br /&gt;
   * Function to display an Upsell-Alert dialog&lt;br /&gt;
   * @param feature String (optional) - Module description&lt;br /&gt;
   * @param win Window (optional) - Only needed/given if we trigger the event from the new object windows &lt;br /&gt;
   */&lt;br /&gt;
  function showUpsellLayer(feature, win) {&lt;br /&gt;
     // setting corewindow to default if win is not defined&lt;br /&gt;
     win = win || corewindow; &lt;br /&gt;
     &lt;br /&gt;
     /*&lt;br /&gt;
      * Build up the dialog content&lt;br /&gt;
      * Note: You can also use myDiv.innerHTML!&lt;br /&gt;
      */&lt;br /&gt;
     var myDiv = newnode(&amp;quot;div&amp;quot;,{ textAlign: &amp;quot;center&amp;quot;, padding: &amp;quot;10px&amp;quot; }, 0, [ &lt;br /&gt;
             newnode(&amp;quot;div&amp;quot;, 0, { background: &amp;quot;url(http://www.example.com/img/header/logo.gif)&amp;quot; }, 0,&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;span&amp;quot;, 0, 0, [ &lt;br /&gt;
                 document.createTextNode(&amp;quot;Diese Funktion ist nur in Open-Xchange Premium verfügbar!&amp;quot;) ],&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Weitere Information zu Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Paket-Upgrade auf Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document) &lt;br /&gt;
         ], win.document);&lt;br /&gt;
     &lt;br /&gt;
     // calling the newAlert function to open the dialog at the given window&lt;br /&gt;
     win.newAlert(&amp;quot;Hinweis &amp;quot; + feature, null, AlertPopup.close, myDiv);&lt;br /&gt;
  }&lt;br /&gt;
  &lt;br /&gt;
  /*&lt;br /&gt;
   * Comment this out to change the grayed out module images in the upper left corner!&lt;br /&gt;
   */&lt;br /&gt;
  /*&lt;br /&gt;
  if (!document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src.match(/mod_portal_sel.gif$/)) {&lt;br /&gt;
     document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src = getFullImgSrc(&amp;quot;img/portal/mod_portal.gif&amp;quot;);&lt;br /&gt;
  }&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_calendar&amp;quot;).src = getFullImgSrc(&amp;quot;img/calendar/mod_calendar.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_tasks&amp;quot;).src = getFullImgSrc(&amp;quot;img/tasks/mod_tasks.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_infostore&amp;quot;).src = getFullImgSrc(&amp;quot;img/infostore/mod_infostore.gif&amp;quot;);&lt;br /&gt;
  */&lt;br /&gt;
&lt;br /&gt;
Currently, the parameter &amp;lt;code&amp;gt;feature&amp;lt;/code&amp;gt; can have following values:&lt;br /&gt;
* configuration/mail/accounts/new&lt;br /&gt;
* modules/calendar&lt;br /&gt;
* modules/calendar/freebusy&lt;br /&gt;
* modules/calendar/mini_calender&lt;br /&gt;
* modules/calendar/new/add_attachment&lt;br /&gt;
* modules/calendar/new/add_participants&lt;br /&gt;
* modules/calendar/new/delete_attachment&lt;br /&gt;
* modules/calendar/new/remove_participants&lt;br /&gt;
* modules/calendar/save_to_infostore&lt;br /&gt;
* modules/calendar/team&lt;br /&gt;
* modules/contacts&lt;br /&gt;
* modules/contacts/save_to_infostore&lt;br /&gt;
* modules/contacts/new/add_attachment&lt;br /&gt;
* modules/contacts/new/delete_attachment&lt;br /&gt;
* modules/folders/users&lt;br /&gt;
* modules/infostore&lt;br /&gt;
* modules/infostore/send_as_attachment&lt;br /&gt;
* modules/infostore/send_as_link&lt;br /&gt;
* modules/infostore/mail/save_to_infostore&lt;br /&gt;
* modules/mail&lt;br /&gt;
* modules/mail/save_to_infostore&lt;br /&gt;
* modules/mail/new/add_infostore_attachment&lt;br /&gt;
* modules/mail/open-ical (added with 6.20.4)&lt;br /&gt;
* modules/mail/open-vcard (added with 6.20.4)&lt;br /&gt;
* modules/portal&lt;br /&gt;
* modules/tasks&lt;br /&gt;
* modules/tasks/save_to_infostore&lt;br /&gt;
* modules/tasks/new/add_participants&lt;br /&gt;
* modules/tasks/new/remove_participants&lt;br /&gt;
* modules/tasks/new/add_attachment&lt;br /&gt;
* modules/tasks/new/delete_attachment&lt;br /&gt;
&lt;br /&gt;
The following events may triggered by plugins (if enabled):&lt;br /&gt;
* modules/usm/eas&lt;br /&gt;
&lt;br /&gt;
== Customized / Extended configuration tree ==&lt;br /&gt;
&lt;br /&gt;
In order to extend your configuration frontend you will have to make more changes than overwriting existing JS methods. You have to implement your own configuration site. Below, you will find the JS API Doc that will show you how to build external contents into the configuration frontend:&lt;br /&gt;
&lt;br /&gt;
[[Main_Page_CE#Programming_Interfaces|Programming Interfaces]]&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/extendconfiguration.properties:&lt;br /&gt;
&lt;br /&gt;
 modules/extendconfiguration/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/extendconfiguration/register.js:&lt;br /&gt;
&lt;br /&gt;
 // Extending the configuration tree.&lt;br /&gt;
 &lt;br /&gt;
 // Add a new folder-like node called &amp;quot;Example&amp;quot;, and inside it another node&lt;br /&gt;
 // called &amp;quot;Page&amp;quot;. The position of a node is specified by a path string.&lt;br /&gt;
 // Each tree level is separated by slashes. There should be only two levels&lt;br /&gt;
 // below the standard &amp;quot;configuration&amp;quot; root element: configuration/x for inner&lt;br /&gt;
 // nodes and configuration/x/y for leaf nodes.&lt;br /&gt;
 &lt;br /&gt;
 new ox.Configuration.InnerNode(&amp;quot;configuration/example&amp;quot;, &amp;quot;Example&amp;quot;);&lt;br /&gt;
 var node = new ox.Configuration.LeafNode(&amp;quot;configuration/example/page&amp;quot;, &amp;quot;Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Connect the node to a new page. &lt;br /&gt;
 &lt;br /&gt;
 var page = new ox.Configuration.Page(node, &amp;quot;Example Configuration Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All data on the page is collected in a single data object. This object is&lt;br /&gt;
 // transmitted to and from the server in the methods load() and save() using&lt;br /&gt;
 // static methods of ox.JSON.&lt;br /&gt;
 // For save(), the parameter cont is a continuation function which must be&lt;br /&gt;
 // called after the data was saved successfully.&lt;br /&gt;
 &lt;br /&gt;
 page.save = function(data, cont) {&lt;br /&gt;
     ox.JSON.put(AjaxRoot + &amp;quot;/serverplugin?action=set&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         data, cont);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // The continuation function of load() expects the data object as parameter.&lt;br /&gt;
 // To extract the data object from the server reply, a new continuation function&lt;br /&gt;
 // is used.&lt;br /&gt;
 &lt;br /&gt;
 page.load = function(cont) {&lt;br /&gt;
     ox.JSON.get(AjaxRoot + &amp;quot;/serverplugin?action=get&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         function(reply) { cont(reply.data); });&lt;br /&gt;
 };&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Content is added to the page with the method addWidget().&lt;br /&gt;
 // Here, a static text is added at the top of the page.&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.Text(&amp;quot;Long explanation text&amp;quot;));&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Individual input widgets can be connected to fields in the data object by&lt;br /&gt;
 // specifying the field name as the second parameter to addWidget().&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.CheckBox(&amp;quot;CheckBox Label&amp;quot;), &amp;quot;fieldname&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Layout can be controlled by using container widgets.&lt;br /&gt;
 // Configuration pages currently support only the Group container, which adds&lt;br /&gt;
 // a header over its children.&lt;br /&gt;
 // Every group has its own data object, which becomes nested in the page&#039;s&lt;br /&gt;
 // data object.&lt;br /&gt;
 &lt;br /&gt;
 var group = new ox.Configuration.Group(&amp;quot;Group title&amp;quot;);&lt;br /&gt;
 page.addWidget(group, &amp;quot;subobject&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Adding widgets to a goup happens exactly like for a page, since both are&lt;br /&gt;
 // descendants of ox.UI.Container.&lt;br /&gt;
 &lt;br /&gt;
 var input = new ox.UI.Input(&amp;quot;Detail field&amp;quot;);&lt;br /&gt;
 group.addWidget(input, &amp;quot;input&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All input widgets have a default value which is used when the data object&lt;br /&gt;
 // does not contain the widget&#039;s field (e. g. on first login).&lt;br /&gt;
 &lt;br /&gt;
 input.default_value = &amp;quot;default&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // ox.UI.Selection has many descendants which implement the same thing:&lt;br /&gt;
 // A field which must contain one of several possible values.&lt;br /&gt;
 // The possible values are set with the method setEntries().&lt;br /&gt;
 &lt;br /&gt;
 var choice = new ox.UI.ComboBox(&amp;quot;Choice&amp;quot;);&lt;br /&gt;
 group.addWidget(choice, &amp;quot;choice&amp;quot;);&lt;br /&gt;
 choice.setEntries([0, 1, Infinity], [&amp;quot;Zero&amp;quot;, &amp;quot;One&amp;quot;, &amp;quot;Infinity&amp;quot;]);&lt;br /&gt;
&lt;br /&gt;
== Customized new buttons in the panel ==&lt;br /&gt;
&lt;br /&gt;
This example adds a new area to the contacts panel called &amp;quot;SMS&amp;quot;. The area then&lt;br /&gt;
has two buttons, &amp;quot;Display&amp;quot; and &amp;quot;Send&amp;quot;. The &amp;quot;Display&amp;quot; button is active if one ore &lt;br /&gt;
multiple contacts are selected and fires a js alert for each of them when being &lt;br /&gt;
clicked. The &amp;quot;SMS&amp;quot; button is only active when one single contact is active&lt;br /&gt;
and has a business telephone number stored in it. On click a js alert is &lt;br /&gt;
executed and the telephone number is displayed.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Viktor&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 //create a new menu Object for the panel and define the unique id (id1 here)&lt;br /&gt;
 var contextmenu = MenuNodes.createSmallButtonContext(&amp;quot;id1&amp;quot;, &amp;quot;SMS&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 /**&lt;br /&gt;
  * Add menu Entries to the new generated panel object and define the icons&lt;br /&gt;
  * as well as the to be called functions. The identifiers must be unique &lt;br /&gt;
  * all over the complete js code (button1 and button2) in this example&lt;br /&gt;
  */&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button1&amp;quot;, &amp;quot;Display&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click1);&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button2&amp;quot;, &amp;quot;Send&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click2);&lt;br /&gt;
 /* The pannel object gets the id 20 and gets displayed in the fixed area&lt;br /&gt;
  * possible areas are FIXED and DYNAMIC the id controls the order in the areas&lt;br /&gt;
  */ &lt;br /&gt;
 addMenuNode(contextmenu.node, MenuNodes.FIXED, 20);&lt;br /&gt;
 &lt;br /&gt;
 //Following makes the new pannel options dynamic active/inactive&lt;br /&gt;
 changeDisplay(&amp;quot;contacts&amp;quot;, &amp;quot;id1&amp;quot;);&lt;br /&gt;
 menuarrows[&amp;quot;contacts&amp;quot;] = {};&lt;br /&gt;
 function changeplugin() {&lt;br /&gt;
     menuglobalzaehler = 0;&lt;br /&gt;
     menuarrows[&amp;quot;contacts&amp;quot;][&amp;quot;id1&amp;quot;] = new Array();&lt;br /&gt;
 //menucountselected here holds the amount of select items&lt;br /&gt;
     menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;, menucountselected &amp;gt;= 1,&lt;br /&gt;
 &amp;quot;button1&amp;quot;);&lt;br /&gt;
 // following an example how to get data out of the GUI internal cache. button2&lt;br /&gt;
 // is only active when a contact which as a business tel number is selected.&lt;br /&gt;
   if (activemodule == &amp;quot;contacts&amp;quot;) {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, function(data) {&lt;br /&gt;
             menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;,&lt;br /&gt;
                 menucountselected == 1 &amp;amp;&amp;amp;&lt;br /&gt;
 data.objects[0].telephone_business1,&lt;br /&gt;
                 &amp;quot;button2&amp;quot;);&lt;br /&gt;
         });&lt;br /&gt;
    }&lt;br /&gt;
 }&lt;br /&gt;
 register(&amp;quot;OX_SELECTED_ITEMS_CHANGED&amp;quot;, changeplugin); &lt;br /&gt;
 &lt;br /&gt;
 //now the called functions for the buttons follow&lt;br /&gt;
 function click1() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;id&amp;quot;, &amp;quot;folder_id&amp;quot;, &amp;quot;last_name&amp;quot;]&lt;br /&gt;
     }, null, display);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function click2() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, call);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function display(data) {&lt;br /&gt;
     for (var i = 0; i &amp;lt; menucountselected; i++)&lt;br /&gt;
         alert(data.objects[i].last_name);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function call(data) {&lt;br /&gt;
      alert(&amp;quot;Now, a SMS to &amp;quot; + data.objects[0].telephone_business1 + &lt;br /&gt;
             &amp;quot; could have been sent&amp;quot;);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
== Embedding external webapps which require authentication (works with OX 6.16 and higher) == &lt;br /&gt;
&lt;br /&gt;
In other examples on this page/wiki, you learned how to extend the settings tree with your own links to external web sites or similar. &lt;br /&gt;
But often it is required to login into such external web applications with some credentials. In many situations, the OX credentials and the credentials for the external web app are the same. So it would be an improvement for the OX user to be automatically logged in to this webapp when clicking some link within OX settings tree. &lt;br /&gt;
&lt;br /&gt;
To achieve this functionality, we introduced a new servlet in OX version 6.16 and higher with some kind of &amp;quot;Single Sign On&amp;quot; functionality, which is reachable at path &amp;quot;/ajax/sso&amp;quot; only via HTTPS (INFO: HTTP connections will NOT work). This servlet can be used to retrieve the following data from the user which uses the OX GUI:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 &amp;quot;login&amp;quot; -&amp;gt; The string which was entered at OX login screen.&lt;br /&gt;
 &amp;quot;imap_login&amp;quot; -&amp;gt; The string which was provisioned into the OX account as &amp;quot;imaplogin. This is used to authenticate against the primary IMAP/Mail Account.&lt;br /&gt;
 &amp;quot;username&amp;quot; -&amp;gt; OX internal username which was choosen by the administrator of the OX context/setup.&lt;br /&gt;
 &amp;quot;password&amp;quot; -&amp;gt; The password of the user.&lt;br /&gt;
 &amp;quot;context_id&amp;quot; -&amp;gt; OX internal number which references the context where the user resides in. Specified by the administrator at OX context creation.&lt;br /&gt;
 &amp;quot;context_name&amp;quot; -&amp;gt; OX internal string which references the context. Specified by the administrator at OX context creation.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Basically, you have to extend the settings/configuration tree in OX to contain a custom link/button where the user can click on. If this link is clicked, you have to call the SSO servlet with the session-id of the current user. Once you called the servlet, it will send some response with a json object which contains the needed data explained above. You can then use this data to &amp;quot;POST&amp;quot; to your external Webapplication Login URL, once your Webapplication has authenticated the POST request, it should redirect the request to its main application. In this case, the OX user is now successfully logged in to your external web application with just a click instead of entering his credentials again.&lt;br /&gt;
&lt;br /&gt;
Here is an example, how to call the SSO servlet:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
//this will fetch needed infos for redirecting&lt;br /&gt;
function callExtAPP(){&lt;br /&gt;
	ox.JSON.get(&amp;quot;/ajax/sso?action=get&amp;amp;session=&amp;quot;+session, function(reply) {&lt;br /&gt;
		username = reply.data.username;&lt;br /&gt;
		password = reply.data.password;&lt;br /&gt;
		login = reply.data.login;&lt;br /&gt;
	});&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
You can call this function for example on a &amp;quot;onClick&amp;quot; event, which was triggered by an OX user who clicks some link in the configuration/settings tree.&lt;br /&gt;
&lt;br /&gt;
== Custom widget for the sidebar ( works with OX 6.18.2 and higher ) ==&lt;br /&gt;
&lt;br /&gt;
The sidebar has the possibility to add custom content, for example advertising, upsell or special help. The available space is equal to the, per default shown, mini calendar. The custom widget can be added below, above and as replacement for the mini calendar:&lt;br /&gt;
&lt;br /&gt;
 // create the widget&lt;br /&gt;
 var swidget = new ox.gui.Custom(function() {&lt;br /&gt;
     this.dom.node.innerHTML = &amp;quot;Hey, I&#039;m an custom widget!&amp;quot;;&lt;br /&gt;
 }, &amp;quot;custom-widget&amp;quot;).&lt;br /&gt;
 css({ backgroundColor: &amp;quot;lightyellow&amp;quot;, border: &amp;quot;1px solid #fc0&amp;quot;, &lt;br /&gt;
     padding: &amp;quot;5px&amp;quot;, lineHeight: &amp;quot;11pt&amp;quot;, height: &amp;quot;100%&amp;quot; }). setLayoutParam({ position: &amp;quot;bottom&amp;quot;, height: &amp;quot;50px&amp;quot; });  &lt;br /&gt;
 &lt;br /&gt;
 // insert widget into the sidepanel on the given position&lt;br /&gt;
 // 3 = above mini-cal, 1 or 2 = below mini-cal &lt;br /&gt;
 ox.widgets.sidepanel.insert(swidget, 3);&lt;br /&gt;
 &lt;br /&gt;
 //trigger validate to force repaint&lt;br /&gt;
 ox.widgets.sidepanel.validate();&lt;br /&gt;
 &lt;br /&gt;
 // optional: remove comment to permanently disable the mini-calendar&lt;br /&gt;
 // ox.widgets.miniCalendar.disable();&lt;br /&gt;
 // ox.widgets.miniCalendar.hide();&lt;br /&gt;
&lt;br /&gt;
[[File:Custom-sidebar-widget.png]]&lt;br /&gt;
&lt;br /&gt;
== Customizing the Help, Logout, examples UWA link, Session Expired and Direct Link locations / URLs ==&lt;br /&gt;
&lt;br /&gt;
If you need to change or customize the Help, Logout, Session Expired or Direct Link locations / URLs you can use the following variables and parameters. You can set them anywhere within your plugin. If not set, the system defaults will be used. Don&#039;t use the expression &#039;var&#039; as this is publicly available.&lt;br /&gt;
&lt;br /&gt;
 // the base path for the help pages&lt;br /&gt;
 help_location = &amp;quot;[protocol]://[hostname][path]/help/[language{1}]/&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url after logout&lt;br /&gt;
 logout_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url if the session expires&lt;br /&gt;
 sessionExpired_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the direct link url, used in the infostore detail views and the new e-mail window&lt;br /&gt;
 // note: do not remove or modify the part &amp;quot;#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;, otherwise direct links won&#039;t work anymore&lt;br /&gt;
 directLink_location = &amp;quot;[protocol]://[hostname][path]#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // example for the UWA link from the UWA-Module settings page&lt;br /&gt;
 // The text between %s%s gets shown as href for the given link&lt;br /&gt;
 uwaLink.text = &amp;quot;Please have a look at the %sInteresting UWA modules%s page. It shows a list of widgets and their associated data.&amp;quot;&lt;br /&gt;
 uwaLink.link = &amp;quot;http://www.open-xchange.com/index.php?id=361&amp;amp;L=[language{0}]&amp;quot;&lt;br /&gt;
&lt;br /&gt;
As you can see you can use place holders, similar to other programming languages. These place holders will get parsed and replaced by the OX application. Here comes a short description of some of them:&lt;br /&gt;
&lt;br /&gt;
 [protocol]      = the current used protocol - e.g. http or https&lt;br /&gt;
 [hostname]      = the hostname - e.g www.myox.de&lt;br /&gt;
 [path]          = the path (if any) behind the hostname - e.g. /ox6/ - or empty if not used&lt;br /&gt;
 [file]          = the file parameter (if any) - e.g. ox.html&lt;br /&gt;
 [language{0|1}] = the users language - e.g. de_DE, where {0} is the language iso code and {1} the country iso code&lt;br /&gt;
 [context_id]    = the users context id&lt;br /&gt;
 [timezone]      = the users timezone - e.g. Europe/Berlin&lt;br /&gt;
&lt;br /&gt;
A full set of available parameters will follow soon.&lt;br /&gt;
Note: The parameters [module], [folder] and [object_id] are only available at the directLink and can&#039;t be used anywhere else.&lt;br /&gt;
&lt;br /&gt;
= Help Menu =&lt;br /&gt;
&lt;br /&gt;
It is possible to add entries to the pop-up menu of the help button in the top right corner. The following is a simple example which opens a language-specific help page:&lt;br /&gt;
&lt;br /&gt;
 var label = { de_DE: &amp;quot;Hilfe&amp;quot;, en_US: &amp;quot;Help&amp;quot;, fr_FR: &amp;quot;Aide&amp;quot; };&lt;br /&gt;
 HelpMenu.addText(label[config.language || &amp;quot;en_US&amp;quot;], displayLink);&lt;br /&gt;
 &lt;br /&gt;
 function displayLink() {&lt;br /&gt;
         open(&amp;quot;/help/&amp;quot; + config.language);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
The manual handling of the label is required until proper support for  the internationalization plug-in is implemented.&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=9940</id>
		<title>ThemeChanges</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=9940"/>
		<updated>2012-01-30T13:12:47Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Changes from 6.20 (Rev 36) to 6.20.1 (Rev5) */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;=Changes from 6.20 (Rev 36) to 6.20.1 (Rev5) =&lt;br /&gt;
&lt;br /&gt;
===Diff file with all changes===&lt;br /&gt;
[[File:6.20_rev36_6.20.1_rev5.diff]]&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
No CSS files removed.&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/calendar.css&lt;br /&gt;
 - theme/css/global.css&lt;br /&gt;
 - theme/css/iframe.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in calendar.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.imip {&lt;br /&gt;
     background-color: white;&lt;br /&gt;
     padding: 15px 20px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .date {&lt;br /&gt;
     font-size: 11pt;&lt;br /&gt;
     color: #ccc;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .interval {&lt;br /&gt;
     color: #555;&lt;br /&gt;
     white-space: nowrap;&lt;br /&gt;
     float: right;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .day {&lt;br /&gt;
     color: #888;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .title {&lt;br /&gt;
     font-size: 18pt;&lt;br /&gt;
     line-height: 22pt;&lt;br /&gt;
     margin: 0.25em 0 0.25em 0;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .location {&lt;br /&gt;
     font-size: 11pt;&lt;br /&gt;
     color: #888;&lt;br /&gt;
     margin: 0.25em 0;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .label {&lt;br /&gt;
     font-size: 9pt;&lt;br /&gt;
     color: #888;&lt;br /&gt;
     clear: both;&lt;br /&gt;
     border-bottom: 1px solid #ccc;&lt;br /&gt;
     padding: 1em 0 0.25em 0em;&lt;br /&gt;
     margin-bottom: 0.5em;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .note {&lt;br /&gt;
     max-width: 550px;&lt;br /&gt;
     white-space: pre-wrap;&lt;br /&gt;
     margin: 1em 0;&lt;br /&gt;
     -webkit-user-select: text;&lt;br /&gt;
     -moz-user-select: text;&lt;br /&gt;
     user-select: text;&lt;br /&gt;
     cursor: text;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .participants {&lt;br /&gt;
     min-height: 2em;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .link {&lt;br /&gt;
     cursor: pointer;&lt;br /&gt;
     text-decoration: underline;&lt;br /&gt;
     color: #00a0cd;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .actions {&lt;br /&gt;
     height: 2em;&lt;br /&gt;
     text-align: right;&lt;br /&gt;
     line-height: 2em;&lt;br /&gt;
     border-bottom: 1px solid #f0f0f0;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .action {&lt;br /&gt;
     float: right;&lt;br /&gt;
     margin-right: 1em;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .changes {&lt;br /&gt;
   margin: 1em 0;&lt;br /&gt;
   font-size: 11pt;&lt;br /&gt;
}&lt;br /&gt;
  &lt;br /&gt;
.imip .changes .original {&lt;br /&gt;
   font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
  &lt;br /&gt;
.imip .changes .recurrencePosition {&lt;br /&gt;
   font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
  &lt;br /&gt;
.imip .changes .updated {&lt;br /&gt;
   color: green;&lt;br /&gt;
  font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip changes {&lt;br /&gt;
    margin-bottom: 2em;&lt;br /&gt;
    font-family: OpenSans, Helvetica, Arial, sans-serif;&lt;br /&gt;
    font-weight: 200;&lt;br /&gt;
    font-size: 12pt;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .changes .original {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .changes .recurrencePosition {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .changes .updated {&lt;br /&gt;
    color: green;&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .person, .imip .person-link {&lt;br /&gt;
     color: #00A0CD;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .participants-clear {&lt;br /&gt;
     clear: both;&lt;br /&gt;
     height: 1px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .participant-list {&lt;br /&gt;
     -webkit-column-width: 250px;&lt;br /&gt;
     -webkit-column-gap: 20px;&lt;br /&gt;
     -moz-column-width: 250px;&lt;br /&gt;
     -moz-column-gap: 20px;&lt;br /&gt;
     column-width: 250px;&lt;br /&gt;
     column-gap: 20px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .participant {&lt;br /&gt;
     min-height: 2em;&lt;br /&gt;
     line-height: 1.2em;&lt;br /&gt;
     display: inline-block;&lt;br /&gt;
     width: 250px; &lt;br /&gt;
     float: left;&lt;br /&gt;
     overflow: hidden;&lt;br /&gt;
     text-overflow: ellipsis;&lt;br /&gt;
     margin: 0 20px 0.5em 0;&lt;br /&gt;
     white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .detail-label {&lt;br /&gt;
     display: inline-block;&lt;br /&gt;
     width: 80px;&lt;br /&gt;
     white-space: nowrap;&lt;br /&gt;
     color: #666;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .detail {&lt;br /&gt;
     white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .detail.shown_as {&lt;br /&gt;
     display: inline-block;&lt;br /&gt;
     height: 1.5em;&lt;br /&gt;
     width: 1em;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.shown_as.reserved { background-color: #08c; } /* blue */&lt;br /&gt;
.shown_as.temporary { background-color: #fc0; } /* yellow */&lt;br /&gt;
.shown_as.absent { background-color: #913F3F; } /* red */&lt;br /&gt;
.shown_as.free { background-color: #8EB360; } /* green */&lt;br /&gt;
 &lt;br /&gt;
.shown_as_label.reserved { color: #08c; } /* blue */&lt;br /&gt;
.shown_as_label.temporary { color: #fc0; } /* yellow */&lt;br /&gt;
.shown_as_label.absent { color: #913F3F; } /* red */&lt;br /&gt;
.shown_as_label.free { color: #8EB360; } /* green */&lt;br /&gt;
 &lt;br /&gt;
.imip .participant .status { }&lt;br /&gt;
.imip .participant .status.accepted { color: #8EB360; } /* green */&lt;br /&gt;
.imip .participant .status.declined { color: #913F3F; } /* red */&lt;br /&gt;
.imip .participant .status.tentative { color: #c80; } /* orange */&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
/* for mac users */&lt;br /&gt;
.macos .ox-embedded-close {&lt;br /&gt;
     position: absolute;&lt;br /&gt;
     top: 7px;&lt;br /&gt;
     left: 10px;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a.common-link {&lt;br /&gt;
     color: #3A6FCF;&lt;br /&gt;
     text-decoration: underline;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
input.monospace {&lt;br /&gt;
     font-family: monospace;&lt;br /&gt;
     font-size: 11pt;&lt;br /&gt;
     padding: 5px 10px 5px 10px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
select.monospace, select.monospace option {&lt;br /&gt;
     font-family: monospace;&lt;br /&gt;
     font-size: 11pt;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
body.show-source {&lt;br /&gt;
     background-color: lightyellow;&lt;br /&gt;
     margin: 0px;&lt;br /&gt;
     padding: 10px;&lt;br /&gt;
     border-top: 5px solid #fc0;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.show-source .header {&lt;br /&gt;
     background-color: lightyellow;&lt;br /&gt;
     position: absolute;&lt;br /&gt;
     top: 5px; &lt;br /&gt;
     left: 0; &lt;br /&gt;
     right: 10px; &lt;br /&gt;
     height: 25px; &lt;br /&gt;
     line-height: 25px;&lt;br /&gt;
     text-align: right;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.show-source .content {&lt;br /&gt;
     background-color: lightyellow;&lt;br /&gt;
     position: absolute;&lt;br /&gt;
     top: 30px;&lt;br /&gt;
     left: 0;&lt;br /&gt;
     right: 0;&lt;br /&gt;
     bottom: 0;&lt;br /&gt;
     padding: 10px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.show-source .content textarea {&lt;br /&gt;
     background-color: lightyellow;&lt;br /&gt;
     width: 100%;&lt;br /&gt;
     height: 100%;&lt;br /&gt;
     border: 0px none;&lt;br /&gt;
     whiteSpace: pre;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.20 to Public Patch Release 2011-09-22 for 6.20 (Rev 27) =&lt;br /&gt;
&lt;br /&gt;
===Diff file with all changes===&lt;br /&gt;
[[File:6.20_to_6.20_rev27_2011-09-22.diff]]&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
No CSS files removed.&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/bgimages.css&lt;br /&gt;
 - theme/css/global.css&lt;br /&gt;
 - theme/css/popus.css &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.bg-toolbar-compact {&lt;br /&gt;
    background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header-handle {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 24px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    line-height: 22px;&lt;br /&gt;
    padding-left: 10px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit/IE9 */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr=&#039;#ffffff&#039;, endColorstr=&#039;#efefef&#039;);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button,&lt;br /&gt;
.ox-portal-widget .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.ox-button.ox-button-disabled,&lt;br /&gt;
.ox-button.default.ox-button-disabled&lt;br /&gt;
.ox-button.dark.ox-button-disabled {&lt;br /&gt;
    color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover, .ox-button:focus {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in popup.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
#wizzardPublishImageTank .linkstyle {&lt;br /&gt;
	cursor: default !important;&lt;br /&gt;
	text-decoration: none !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span,&lt;br /&gt;
#wizzardPublishImageTank .linkstyle a {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.2 to 6.20 =&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files in this release.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/newwindow.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .topheader-l {&lt;br /&gt;
  background-image: url(../img/border/topheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-tl {&lt;br /&gt;
  background-image: url(../img/border/topheader-tl.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-t {&lt;br /&gt;
  background-image: url(../img/border/topheader-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-tr {&lt;br /&gt;
  background-image: url(../img/border/topheader-tr.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-r {&lt;br /&gt;
  background-image: url(../img/border/topheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }		&lt;br /&gt;
&lt;br /&gt;
 .topheaderactive-t {&lt;br /&gt;
  background-image: url(../img/border/topheaderactive-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .calbody-r {&lt;br /&gt;
  background-image: url(../img/border/calbody-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .oxheader-l {&lt;br /&gt;
  background-image: url(../img/border/oxheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
			&lt;br /&gt;
 .oxheader-r {&lt;br /&gt;
  background-image: url(../img/border/oxheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .cpbody-size {&lt;br /&gt;
  left: 4px;&lt;br /&gt;
  right: 4px;&lt;br /&gt;
  width: 4px;&lt;br /&gt;
  top: 1px;&lt;br /&gt;
  bottom: 1px;&lt;br /&gt;
  height: 1px;&lt;br /&gt;
 }	&lt;br /&gt;
&lt;br /&gt;
 .cpbottom-size {&lt;br /&gt;
  left: 12px;&lt;br /&gt;
  right: 12px;&lt;br /&gt;
  width: 12px;&lt;br /&gt;
  top: 20px;&lt;br /&gt;
  bottom: 20px;&lt;br /&gt;
  height: 20px;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .expandButton {&lt;br /&gt;
  background-image:url(&amp;quot;../img/arrows/arrow_gray_down.gif&amp;quot;);	&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .sp-toggle&lt;br /&gt;
 {&lt;br /&gt;
  background-image:url(../img/border/spback.gif);&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in branding.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 #header {&lt;br /&gt;
  top: 0px !important; /* change this to branding height */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #header-decorator {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #notheader {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in calendar.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.kwSeparationBackGround {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.offTimeBackground {&lt;br /&gt;
    background-color : #E4E8FA;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.workTimeBackground {&lt;br /&gt;
    background-color : #F2F6FA;&lt;br /&gt;
}&lt;br /&gt;
.wholeDayBackground {&lt;br /&gt;
    background-color: #dddddd;&lt;br /&gt;
}&lt;br /&gt;
.appointmentTitleBG {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appointmentViewHeadBG {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
    border-top: 1px solid;  &lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.strokeCalendar {&lt;br /&gt;
    border-color : #D1D8DD !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.sectionStrokeCalendar {&lt;br /&gt;
    border-color : #a5b5bf !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSliderBox {&lt;br /&gt;
    border-top: 1px solid #3066c5;&lt;br /&gt;
    border-bottom: 1px solid #3066c5;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSlider {&lt;br /&gt;
    border: 1px solid #999;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_control_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .leftColumn .rowSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .dataGrid .appointment.isSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
 /* customs */&lt;br /&gt;
&lt;br /&gt;
#cwwtimecontent &amp;gt; tbody &amp;gt; tr &amp;gt; td &amp;gt; table &amp;gt; tbody &amp;gt; tr &amp;gt; td:first-child {&lt;br /&gt;
    background-color: #ff0000;&lt;br /&gt;
    width: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cww_timeline {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cww-timeline-font {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
    color: #333;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cwwheaderresize &amp;gt; table {&lt;br /&gt;
    height: 100%;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appInWeekView, .appInMonthView, .showAppointmentTextMonthFull {&lt;br /&gt;
	background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.todayBackground {&lt;br /&gt;
    background-color: #fc0 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in iframe.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
html, body {&lt;br /&gt;
    font-family: Arial, Helvetica, sans-serif; &lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.plainTextContent {&lt;br /&gt;
    font-family: monospace, Courier New;&lt;br /&gt;
    line-height: 1.5em;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Rainbow quoting */&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote {&lt;br /&gt;
	border-left: 2px solid #364e9b !important; /* blue */&lt;br /&gt;
	background-color: #f5f7ff;&lt;br /&gt;
    color: #1a254a !important;&lt;br /&gt;
    margin-right: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote {&lt;br /&gt;
    border-color: #366a9b !important; /* cyan */&lt;br /&gt;
    background-color: #e6f3ff;&lt;br /&gt;
    color: #1e3b56 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #3c7027 !important; /* green */&lt;br /&gt;
    background-color: #edffe6;&lt;br /&gt;
    color: #192e10 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #efc000 !important; /* orange */&lt;br /&gt;
    background-color: #fffae6;&lt;br /&gt;
    color: #713200 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #5c1111 !important; /* red*/&lt;br /&gt;
    background-color: #ffeeee;&lt;br /&gt;
    color: #751000 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #801062 !important; /* pink */&lt;br /&gt;
    background-color: #ffeffb;&lt;br /&gt;
    color: #3c072e !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #240a4f !important; /* violet */&lt;br /&gt;
    background-color: #f1e9ff;&lt;br /&gt;
    color: #3a1081 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #333 !important; /* gray */&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    color: #333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #555 !important; /* black */&lt;br /&gt;
    background-color: #fff;&lt;br /&gt;
    color: #111 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in popuo.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.popupHeaderBackground {&lt;br /&gt;
	background-color: #bbb !important;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivOver {&lt;br /&gt;
	background-color:#bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActive {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActiveNoPadding {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.popup-header, .listDialogue td.listDialogueHeader {&lt;br /&gt;
	font-weight: bold;&lt;br /&gt;
	color: #000;&lt;br /&gt;
	background-image: url(../img/panels/miniviewHeader_b.gif);	&lt;br /&gt;
	background-color: #bbb;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
body {&lt;br /&gt;
	background-color: #cccccc; /* was #a9b2c5 */&lt;br /&gt;
	font-family: Arial, Helvetica, sans-serif;&lt;br /&gt;
	font-size: 9pt;&lt;br /&gt;
	color:#000;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.webkit body {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 50%, 0% 100%, from(#ccc), to(#333)); /* ccc to 555 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.firefox body {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #eee, #555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.font-style-person, .font-color-person {&lt;br /&gt;
    color: #344F70;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cpheader-color {&lt;br /&gt;
	background-color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.topHeaderBG, .topheader-color {&lt;br /&gt;
	background-color: #444;	/* was #65769b */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.background-color-content, .cpbody-color {&lt;br /&gt;
	background-color: #f5f5f5 !important;&lt;br /&gt;
}&lt;br /&gt;
(was .background-color-content, .cpbody-color, .calbody-color)&lt;br /&gt;
&lt;br /&gt;
.background-color-PMG-selection-elements {&lt;br /&gt;
	background-color: #bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.entrySelDiv {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*live grid selection*/&lt;br /&gt;
.selected {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.selectedfocused {&lt;br /&gt;
	border-color: #607090 !important;&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont {&lt;br /&gt;
	background-color: white !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont, .mailDetailAttachmentsContSel {&lt;br /&gt;
    border-color: #C0C0C0 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dndOver {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
	border-color: #bdd3eb !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.browsercheck {&lt;br /&gt;
	background-image: url(../img/browsercheck.png);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#sidepanel_dragpoint_background {&lt;br /&gt;
    background-color: #ddd;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit #sidepanel_dragpoint_background {&lt;br /&gt;
    -webkit-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox #sidepanel_dragpoint_background {&lt;br /&gt;
    -moz-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #sidesplit {&lt;br /&gt;
    border-right: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #mainarea {&lt;br /&gt;
    border-left: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dropdownbox .comboboxColumn2 {&lt;br /&gt;
    background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
#menu_search_mail_context, #menu_search_context {&lt;br /&gt;
	background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl {&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-sidepanel-title {&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl a {&lt;br /&gt;
	color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    background-color: #666; /* was #455069 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTabCurrent, div.oxTabControl td.oxTabCurrent:hover {&lt;br /&gt;
    color: #000;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-top: 2px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*&lt;br /&gt;
 * Portal &lt;br /&gt;
 */&lt;br /&gt;
&lt;br /&gt;
.ox-portal {&lt;br /&gt;
    background-color: white; /* body: A9B2C5 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top , #FFFFFF, #DDDDDD);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#DDDDDD));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-placeholder {&lt;br /&gt;
    border: 2px dashed #888;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget */&lt;br /&gt;
.ox-portal-widget {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    padding: 0px 0px 8px 0px;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -moz-border-radius: 8px;&lt;br /&gt;
    -moz-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -webkit-border-radius: 8px;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* IE gets no radius, no shadow */&lt;br /&gt;
.IE .ox-portal-widget {&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget header */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit */&lt;br /&gt;
.firefox .ox-portal-header {&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-header {&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* close/remove button */&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* controls */&lt;br /&gt;
.ox-portal-topbar {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-bottom: 1px solid #aaa;&lt;br /&gt;
    color: #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar i {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	font-style: normal;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar b {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	color: #999;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar a {&lt;br /&gt;
    color: #00f;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    text-decoration: underline;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls, .ox-quick-config {&lt;br /&gt;
	background-color: #444;&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-controls, .firefox .ox-quick-config {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-controls, .webkit .ox-quick-config {&lt;br /&gt;
	background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config table {&lt;br /&gt;
	margin: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config td, .ox-quick-config th {&lt;br /&gt;
	padding: 0px 20px 5px 0px;&lt;br /&gt;
	vertical-align: top;&lt;br /&gt;
	white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config th {&lt;br /&gt;
    color: #8AC2FF;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    text-align: left;&lt;br /&gt;
    padding-bottom: 2px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls label, .ox-quick-config label {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout {&lt;br /&gt;
	width: 90px;&lt;br /&gt;
	height: 60px;&lt;br /&gt;
    background-image: url(../img/portal/layouts.png);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    margin: 2px 22px 2px 2px;&lt;br /&gt;
    border: 0px none;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.one {&lt;br /&gt;
	background-position: 0px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.two {&lt;br /&gt;
    background-position: -90px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.three {&lt;br /&gt;
    background-position: -180px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.four {&lt;br /&gt;
    background-position: -270px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.five {&lt;br /&gt;
    background-position: -360px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.active, .ox-portal-layout.active:hover {&lt;br /&gt;
	background-color: #67789D;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
	-webkit-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout:hover {&lt;br /&gt;
	background-color: #888;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* &lt;br /&gt;
 * Button&lt;br /&gt;
 */&lt;br /&gt;
.ox-button {&lt;br /&gt;
	font-size: 8pt;&lt;br /&gt;
	line-height: 1.5em;&lt;br /&gt;
    border-radius: 5px;&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
    color: black;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    padding: 5px 1em 5px 1em;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    display: inline-block;&lt;br /&gt;
    vertical-align: middle;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark {&lt;br /&gt;
    background-color: #333;&lt;br /&gt;
    border: 1px solid #222;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* firefox */&lt;br /&gt;
.ox-button.firefox {&lt;br /&gt;
	-moz-border-radius: 5px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.firefox {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #555555, #333333);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.firefox:hover {&lt;br /&gt;
	-moz-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* webkit */&lt;br /&gt;
.ox-button.webkit {&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.webkit {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#555555), to(#333333));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.webkit:hover {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows */&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-decorator {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px; &lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    background-color: black; &lt;br /&gt;
    opacity: 0.10;&lt;br /&gt;
    filter: alpha(opacity=10);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-container {&lt;br /&gt;
    position: absolute; &lt;br /&gt;
    top: 0px; &lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 50%; &lt;br /&gt;
    margin-left: 0px; /* use to center */&lt;br /&gt;
    width: 0px; /* live parameter; override with !important */&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    visibility: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-container {&lt;br /&gt;
    -moz-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-container {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE .ox-embedded-container {&lt;br /&gt;
    border: 1px solid #333;&lt;br /&gt;
    border-width: 0px 1px 0px 1px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-title {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    line-height: 12px;&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    text-align: center;&lt;br /&gt;
    padding: 9px 20px 8px 10px;&lt;br /&gt;
    color: #ccc;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    border-bottom: 1px solid #333;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-title {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111, #444);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-title {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111), to(#444));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 7px;&lt;br /&gt;
    right: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close img {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/x.png);&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-iframe {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 30px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows: dock */&lt;br /&gt;
&lt;br /&gt;
.ox-dock {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    color: black;&lt;br /&gt;
    border-top: 1px solid #333;&lt;br /&gt;
    height: 33px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    z-index: 65000;&lt;br /&gt;
    display: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-tab {&lt;br /&gt;
    background-color: #222;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    border: 1px solid black;&lt;br /&gt;
    border-width: 0px 1px 1px 1px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    padding: 4px 10px 4px 10px;&lt;br /&gt;
    margin: 0px 0px 0px 5px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    height: 1.5em;&lt;br /&gt;
    color: white;&lt;br /&gt;
    border-radius: 0px 0px 8px 8px;&lt;br /&gt;
        &lt;br /&gt;
    position: relative;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    overflow: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-tab {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #333333);&lt;br /&gt;
    -moz-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-tab {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#333333));&lt;br /&gt;
    -webkit-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-selected {&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-selected {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #666);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-selected {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#666));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Context-menu button */&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.weekDivMonthView .background-color-content{&lt;br /&gt;
    background-color: #ffdaab !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/icons/16/calendar_dis.png&lt;br /&gt;
 - theme/icons/16/calendar.png&lt;br /&gt;
 - theme/icons/16/contacts_dis.png&lt;br /&gt;
 - theme/icons/16/contacts.png&lt;br /&gt;
 - theme/icons/16/draft_dis.png&lt;br /&gt;
 - theme/icons/16/draft.png&lt;br /&gt;
 - theme/icons/16/facebook.png&lt;br /&gt;
 - theme/icons/16/folder_closed_dis.png&lt;br /&gt;
 - theme/icons/16/folder_opened_dis.png&lt;br /&gt;
 - theme/icons/16/forward.png&lt;br /&gt;
 - theme/icons/16/garbage_dis.png&lt;br /&gt;
 - theme/icons/16/garbage.png&lt;br /&gt;
 - theme/icons/16/ham_dis.png&lt;br /&gt;
 - theme/icons/16/ham.png&lt;br /&gt;
 - theme/icons/16/inbox_dis.png&lt;br /&gt;
 - theme/icons/16/inbox.png&lt;br /&gt;
 - theme/icons/16/infostore_dis.png&lt;br /&gt;
 - theme/icons/16/infostore.png&lt;br /&gt;
 - theme/icons/16/mail_dis.png&lt;br /&gt;
 - theme/icons/16/mail.png&lt;br /&gt;
 - theme/icons/16/outbox_dis.png&lt;br /&gt;
 - theme/icons/16/outbox.png&lt;br /&gt;
 - theme/icons/16/public_dis.png&lt;br /&gt;
 - theme/icons/16/public.png&lt;br /&gt;
 - theme/icons/16/rss.png&lt;br /&gt;
 - theme/icons/16/shared_dis.png&lt;br /&gt;
 - theme/icons/16/shared_globe.png&lt;br /&gt;
 - theme/icons/16/shared.png&lt;br /&gt;
 - theme/icons/16/spam_dis.png&lt;br /&gt;
 - theme/icons/16/spam.png&lt;br /&gt;
 - theme/icons/16/tasks_dis.png&lt;br /&gt;
 - theme/icons/16/tasks.png&lt;br /&gt;
 - theme/icons/16/twitter.png&lt;br /&gt;
 - theme/icons/16/user_dis.png&lt;br /&gt;
&lt;br /&gt;
 - theme/icons/24/calendar_move.png&lt;br /&gt;
 - theme/icons/24/distributionlist_extcontact.png&lt;br /&gt;
 - theme/icons/24/ham.png&lt;br /&gt;
 - theme/icons/24/mark_as_done.png&lt;br /&gt;
 - theme/icons/24/mark_as.png&lt;br /&gt;
 - theme/icons/24/spam.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/arrows/arrow_white_down.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/slider_background.png&lt;br /&gt;
 - theme/img/calendar/slider_control_background.png&lt;br /&gt;
&lt;br /&gt;
 - themes/portal/layouts.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/browsercheck.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.gif&lt;br /&gt;
 changed to a png image&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/calbody-r.png&lt;br /&gt;
 - theme/img/border/cpbody-l.png&lt;br /&gt;
 - theme/img/border/cpbody-r.png&lt;br /&gt;
 - theme/img/border/cpbottom-b.png&lt;br /&gt;
 - theme/img/border/cpbottom-bl.png&lt;br /&gt;
 - theme/img/border/cpbottom-l.png&lt;br /&gt;
 - theme/img/border/cpbottom-r.png&lt;br /&gt;
 - theme/img/border/cpheader-l.png&lt;br /&gt;
 - theme/img/border/cpheader-r.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-ll.png&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-rr.png&lt;br /&gt;
 - theme/img/border/popup/popup-border-imagemap.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31.gif&lt;br /&gt;
 All icons have changed from gif to png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/infostore/mimetypes/vcard.gif&lt;br /&gt;
&lt;br /&gt;
 - theme/img/panels/miniviewHeader_b.gif&lt;br /&gt;
&lt;br /&gt;
 - themes/img/x.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1_sel.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31_sel.gif&lt;br /&gt;
 All icons with the _sel ending have been removed&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.1 to 6.18.2=&lt;br /&gt;
&lt;br /&gt;
===New CSS file===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/branding.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
- theme/css/global.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-person {&lt;br /&gt;
    		color: #215696;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	#window-header-decorator {&lt;br /&gt;
    		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
    		background-repeat: repeat-x;&lt;br /&gt;
    		background-color: #ddd;&lt;br /&gt;
    		border-bottom: 1px solid #bbb;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
		background-repeat: repeat-x;&lt;br /&gt;
		border-top: 0px none;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable.border-color-design {&lt;br /&gt;
		border-color: #aaa !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse, div.oxTabControlToggle {&lt;br /&gt;
		background-repeat: no-repeat;&lt;br /&gt;
		background-position: 3px 5px;&lt;br /&gt;
		width: 15px;&lt;br /&gt;
		height: 15px;&lt;br /&gt;
		float: right;&lt;br /&gt;
		margin: 5px 9px;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_down.gif);&lt;br /&gt;
		cursor: s-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggle {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_up.gif);&lt;br /&gt;
		cursor: n-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl {&lt;br /&gt;
	    background-color: #65769B;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.ox-sidepanel-view-title {&lt;br /&gt;
		color: white;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl a {&lt;br /&gt;
		color: #eee;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    		background-color: #455069;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Change elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color:#404962;  &lt;br /&gt;
		font-weight : bold; &lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color: #333;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	#notheader {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	#header-decorator {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.tr_h {&lt;br /&gt;
    		background-color: #e3e3e3 !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.tr_h {&lt;br /&gt;
		background-color: #eaeaea !important;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_down.gif&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_up.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_down.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_right.gif&lt;br /&gt;
 - theme/img/folder/shared_dis.gif &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
All icons under the folder /themes/[theme name]/ will be separated by their size. You will find three different sub-folders here: 16 (for 16x16 pixel icons), 24 and 36. Some icons may be available in several folders. Some icons can also be found in their old location under /themes/[theme name]/img/. In the future, all icons will be found in the new icons folder and not in the img folder.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
16/attachment_add.png&lt;br /&gt;
16/attachment_open.png&lt;br /&gt;
16/attachment_remove.png&lt;br /&gt;
16/calendar_move.png&lt;br /&gt;
16/confirmation_change.png&lt;br /&gt;
16/contact_copy.png&lt;br /&gt;
16/contact_move.png&lt;br /&gt;
16/current_version.png&lt;br /&gt;
16/delete_folder.png&lt;br /&gt;
16/delete.png&lt;br /&gt;
16/distributionlist_extcontact.png&lt;br /&gt;
16/dummy.gif&lt;br /&gt;
16/duplicate_contacts.png&lt;br /&gt;
16/folder_closed.png&lt;br /&gt;
16/folder_opened.png&lt;br /&gt;
16/infostore_move.png&lt;br /&gt;
16/lock.png&lt;br /&gt;
16/mail_copy.png&lt;br /&gt;
16/mail_move.png&lt;br /&gt;
16/mail_source.png&lt;br /&gt;
16/mark_as.png&lt;br /&gt;
16/member_add.png&lt;br /&gt;
16/member_remove.png&lt;br /&gt;
16/mod_calendar.png&lt;br /&gt;
16/mod_configuration.png&lt;br /&gt;
16/mod_contacts.png&lt;br /&gt;
16/mod_infostore.png&lt;br /&gt;
16/mod_mail.png&lt;br /&gt;
16/mod_portal.png&lt;br /&gt;
16/mod_tasks.png&lt;br /&gt;
16/print.png&lt;br /&gt;
16/save.png&lt;br /&gt;
16/search.png&lt;br /&gt;
16/send_as_attachment.png&lt;br /&gt;
16/send_as_link.png&lt;br /&gt;
16/task_copy.png&lt;br /&gt;
16/task_move.png&lt;br /&gt;
16/teamchange.png&lt;br /&gt;
16/unlock.png&lt;br /&gt;
16/user.png&lt;br /&gt;
16/userrights_delete.png&lt;br /&gt;
16/userrights.png&lt;br /&gt;
16/userrights_read.png&lt;br /&gt;
16/userrights_remove.png&lt;br /&gt;
16/userrights_write.png&lt;br /&gt;
&lt;br /&gt;
24/attachment_add.png&lt;br /&gt;
24/attachment_remove.png&lt;br /&gt;
24/cancel.png&lt;br /&gt;
24/card_view.png&lt;br /&gt;
24/category_add.png&lt;br /&gt;
24/category_remove.png&lt;br /&gt;
24/confirmation_change.png&lt;br /&gt;
24/delete.png&lt;br /&gt;
24/detail_view.png&lt;br /&gt;
24/distributionlist.png&lt;br /&gt;
24/draft.png&lt;br /&gt;
24/dummy.gif&lt;br /&gt;
24/edit.png&lt;br /&gt;
24/externalview_add.png&lt;br /&gt;
24/externalview_disable.png&lt;br /&gt;
24/externalview_edit.png&lt;br /&gt;
24/externalview_enable.png&lt;br /&gt;
24/externalview_remove.png&lt;br /&gt;
24/forward.png&lt;br /&gt;
24/h_split_view.png&lt;br /&gt;
24/inbox.png&lt;br /&gt;
24/list_view.png&lt;br /&gt;
24/mail_copy.png&lt;br /&gt;
24/mail_move.png&lt;br /&gt;
24/mail_send.png&lt;br /&gt;
24/mail_write.png&lt;br /&gt;
24/member_add.png&lt;br /&gt;
24/member_remove.png&lt;br /&gt;
24/mod_calendar.png&lt;br /&gt;
24/mod_configuration.png&lt;br /&gt;
24/mod_contacts.png&lt;br /&gt;
24/mod_foldertree.png&lt;br /&gt;
24/mod_infostore.png&lt;br /&gt;
24/mod_mail.png&lt;br /&gt;
24/mod_portal.png&lt;br /&gt;
24/mod_tasks.png&lt;br /&gt;
24/options.png&lt;br /&gt;
24/picture_add.png&lt;br /&gt;
24/picture_remove.png&lt;br /&gt;
24/print.png&lt;br /&gt;
24/reply_all.png&lt;br /&gt;
24/reply.png&lt;br /&gt;
24/save_as_link.png&lt;br /&gt;
24/save.png&lt;br /&gt;
24/tag_10.png&lt;br /&gt;
24/tag_1.png&lt;br /&gt;
24/tag_2.png&lt;br /&gt;
24/tag_3.png&lt;br /&gt;
24/tag_4.png&lt;br /&gt;
24/tag_5.png&lt;br /&gt;
24/tag_6.png&lt;br /&gt;
24/tag_7.png&lt;br /&gt;
24/tag_8.png&lt;br /&gt;
24/tag_9.png&lt;br /&gt;
24/tag_remove.png&lt;br /&gt;
24/task_copy.png&lt;br /&gt;
24/task_move.png&lt;br /&gt;
24/teamchange.png&lt;br /&gt;
24/v_split_view.png&lt;br /&gt;
&lt;br /&gt;
32/attachment_add.png&lt;br /&gt;
32/attachment_remove.png&lt;br /&gt;
32/cancel.png&lt;br /&gt;
32/category_add.png&lt;br /&gt;
32/category_remove.png&lt;br /&gt;
32/confirmation_change.png&lt;br /&gt;
32/delete.png&lt;br /&gt;
32/distributionlist.png&lt;br /&gt;
32/draft.png&lt;br /&gt;
32/dummy.gif&lt;br /&gt;
32/edit.png&lt;br /&gt;
32/externalview_add.png&lt;br /&gt;
32/externalview_disable.png&lt;br /&gt;
32/externalview_edit.png&lt;br /&gt;
32/externalview_enable.png&lt;br /&gt;
32/externalview_remove.png&lt;br /&gt;
32/forward.png&lt;br /&gt;
32/import.png&lt;br /&gt;
32/mail_copy.png&lt;br /&gt;
32/mail_move.png&lt;br /&gt;
32/mail_send.png&lt;br /&gt;
32/mail_write.png&lt;br /&gt;
32/member_add.png&lt;br /&gt;
32/member_remove.png&lt;br /&gt;
32/mod_calendar.png&lt;br /&gt;
32/mod_configuration.png&lt;br /&gt;
32/mod_contacts.png&lt;br /&gt;
32/mod_infostore.png&lt;br /&gt;
32/mod_mail.png&lt;br /&gt;
32/mod_portal.png&lt;br /&gt;
32/mod_tasks.png&lt;br /&gt;
32/options.png&lt;br /&gt;
32/picture_add.png&lt;br /&gt;
32/picture_remove.png&lt;br /&gt;
32/print.png&lt;br /&gt;
32/reply_all.png&lt;br /&gt;
32/reply.png&lt;br /&gt;
32/save_as_link.png&lt;br /&gt;
32/save.png&lt;br /&gt;
32/tag_10.png&lt;br /&gt;
32/tag_1.png&lt;br /&gt;
32/tag_2.png&lt;br /&gt;
32/tag_3.png&lt;br /&gt;
32/tag_4.png&lt;br /&gt;
32/tag_5.png&lt;br /&gt;
32/tag_6.png&lt;br /&gt;
32/tag_7.png&lt;br /&gt;
32/tag_8.png&lt;br /&gt;
32/tag_9.png&lt;br /&gt;
32/tag_remove.png&lt;br /&gt;
32/task_copy.png&lt;br /&gt;
32/task_move.png&lt;br /&gt;
32/teamchange.png&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/toolbar/toolbar_bg.gif&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=File:6.20_rev36_6.20.1_rev5.diff&amp;diff=9939</id>
		<title>File:6.20 rev36 6.20.1 rev5.diff</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=File:6.20_rev36_6.20.1_rev5.diff&amp;diff=9939"/>
		<updated>2012-01-30T13:10:06Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=9938</id>
		<title>ThemeChanges</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=9938"/>
		<updated>2012-01-30T13:09:21Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Added changes from 6.20 to 6.20.1&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;=Changes from 6.20 (Rev 36) to 6.20.1 (Rev5) =&lt;br /&gt;
&lt;br /&gt;
===Diff file with all changes===&lt;br /&gt;
[[File:Example.jpg]]&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
No CSS files removed.&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/calendar.css&lt;br /&gt;
 - theme/css/global.css&lt;br /&gt;
 - theme/css/iframe.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in calendar.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.imip {&lt;br /&gt;
     background-color: white;&lt;br /&gt;
     padding: 15px 20px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .date {&lt;br /&gt;
     font-size: 11pt;&lt;br /&gt;
     color: #ccc;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .interval {&lt;br /&gt;
     color: #555;&lt;br /&gt;
     white-space: nowrap;&lt;br /&gt;
     float: right;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .day {&lt;br /&gt;
     color: #888;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .title {&lt;br /&gt;
     font-size: 18pt;&lt;br /&gt;
     line-height: 22pt;&lt;br /&gt;
     margin: 0.25em 0 0.25em 0;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .location {&lt;br /&gt;
     font-size: 11pt;&lt;br /&gt;
     color: #888;&lt;br /&gt;
     margin: 0.25em 0;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .label {&lt;br /&gt;
     font-size: 9pt;&lt;br /&gt;
     color: #888;&lt;br /&gt;
     clear: both;&lt;br /&gt;
     border-bottom: 1px solid #ccc;&lt;br /&gt;
     padding: 1em 0 0.25em 0em;&lt;br /&gt;
     margin-bottom: 0.5em;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .note {&lt;br /&gt;
     max-width: 550px;&lt;br /&gt;
     white-space: pre-wrap;&lt;br /&gt;
     margin: 1em 0;&lt;br /&gt;
     -webkit-user-select: text;&lt;br /&gt;
     -moz-user-select: text;&lt;br /&gt;
     user-select: text;&lt;br /&gt;
     cursor: text;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .participants {&lt;br /&gt;
     min-height: 2em;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .link {&lt;br /&gt;
     cursor: pointer;&lt;br /&gt;
     text-decoration: underline;&lt;br /&gt;
     color: #00a0cd;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .actions {&lt;br /&gt;
     height: 2em;&lt;br /&gt;
     text-align: right;&lt;br /&gt;
     line-height: 2em;&lt;br /&gt;
     border-bottom: 1px solid #f0f0f0;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .action {&lt;br /&gt;
     float: right;&lt;br /&gt;
     margin-right: 1em;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .changes {&lt;br /&gt;
   margin: 1em 0;&lt;br /&gt;
   font-size: 11pt;&lt;br /&gt;
}&lt;br /&gt;
  &lt;br /&gt;
.imip .changes .original {&lt;br /&gt;
   font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
  &lt;br /&gt;
.imip .changes .recurrencePosition {&lt;br /&gt;
   font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
  &lt;br /&gt;
.imip .changes .updated {&lt;br /&gt;
   color: green;&lt;br /&gt;
  font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip changes {&lt;br /&gt;
    margin-bottom: 2em;&lt;br /&gt;
    font-family: OpenSans, Helvetica, Arial, sans-serif;&lt;br /&gt;
    font-weight: 200;&lt;br /&gt;
    font-size: 12pt;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .changes .original {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .changes .recurrencePosition {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .changes .updated {&lt;br /&gt;
    color: green;&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .person, .imip .person-link {&lt;br /&gt;
     color: #00A0CD;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .participants-clear {&lt;br /&gt;
     clear: both;&lt;br /&gt;
     height: 1px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .participant-list {&lt;br /&gt;
     -webkit-column-width: 250px;&lt;br /&gt;
     -webkit-column-gap: 20px;&lt;br /&gt;
     -moz-column-width: 250px;&lt;br /&gt;
     -moz-column-gap: 20px;&lt;br /&gt;
     column-width: 250px;&lt;br /&gt;
     column-gap: 20px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .participant {&lt;br /&gt;
     min-height: 2em;&lt;br /&gt;
     line-height: 1.2em;&lt;br /&gt;
     display: inline-block;&lt;br /&gt;
     width: 250px; &lt;br /&gt;
     float: left;&lt;br /&gt;
     overflow: hidden;&lt;br /&gt;
     text-overflow: ellipsis;&lt;br /&gt;
     margin: 0 20px 0.5em 0;&lt;br /&gt;
     white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .detail-label {&lt;br /&gt;
     display: inline-block;&lt;br /&gt;
     width: 80px;&lt;br /&gt;
     white-space: nowrap;&lt;br /&gt;
     color: #666;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .detail {&lt;br /&gt;
     white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.imip .detail.shown_as {&lt;br /&gt;
     display: inline-block;&lt;br /&gt;
     height: 1.5em;&lt;br /&gt;
     width: 1em;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.shown_as.reserved { background-color: #08c; } /* blue */&lt;br /&gt;
.shown_as.temporary { background-color: #fc0; } /* yellow */&lt;br /&gt;
.shown_as.absent { background-color: #913F3F; } /* red */&lt;br /&gt;
.shown_as.free { background-color: #8EB360; } /* green */&lt;br /&gt;
 &lt;br /&gt;
.shown_as_label.reserved { color: #08c; } /* blue */&lt;br /&gt;
.shown_as_label.temporary { color: #fc0; } /* yellow */&lt;br /&gt;
.shown_as_label.absent { color: #913F3F; } /* red */&lt;br /&gt;
.shown_as_label.free { color: #8EB360; } /* green */&lt;br /&gt;
 &lt;br /&gt;
.imip .participant .status { }&lt;br /&gt;
.imip .participant .status.accepted { color: #8EB360; } /* green */&lt;br /&gt;
.imip .participant .status.declined { color: #913F3F; } /* red */&lt;br /&gt;
.imip .participant .status.tentative { color: #c80; } /* orange */&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
/* for mac users */&lt;br /&gt;
.macos .ox-embedded-close {&lt;br /&gt;
     position: absolute;&lt;br /&gt;
     top: 7px;&lt;br /&gt;
     left: 10px;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a.common-link {&lt;br /&gt;
     color: #3A6FCF;&lt;br /&gt;
     text-decoration: underline;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
input.monospace {&lt;br /&gt;
     font-family: monospace;&lt;br /&gt;
     font-size: 11pt;&lt;br /&gt;
     padding: 5px 10px 5px 10px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
select.monospace, select.monospace option {&lt;br /&gt;
     font-family: monospace;&lt;br /&gt;
     font-size: 11pt;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
body.show-source {&lt;br /&gt;
     background-color: lightyellow;&lt;br /&gt;
     margin: 0px;&lt;br /&gt;
     padding: 10px;&lt;br /&gt;
     border-top: 5px solid #fc0;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.show-source .header {&lt;br /&gt;
     background-color: lightyellow;&lt;br /&gt;
     position: absolute;&lt;br /&gt;
     top: 5px; &lt;br /&gt;
     left: 0; &lt;br /&gt;
     right: 10px; &lt;br /&gt;
     height: 25px; &lt;br /&gt;
     line-height: 25px;&lt;br /&gt;
     text-align: right;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.show-source .content {&lt;br /&gt;
     background-color: lightyellow;&lt;br /&gt;
     position: absolute;&lt;br /&gt;
     top: 30px;&lt;br /&gt;
     left: 0;&lt;br /&gt;
     right: 0;&lt;br /&gt;
     bottom: 0;&lt;br /&gt;
     padding: 10px;&lt;br /&gt;
}&lt;br /&gt;
 &lt;br /&gt;
.show-source .content textarea {&lt;br /&gt;
     background-color: lightyellow;&lt;br /&gt;
     width: 100%;&lt;br /&gt;
     height: 100%;&lt;br /&gt;
     border: 0px none;&lt;br /&gt;
     whiteSpace: pre;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.20 to Public Patch Release 2011-09-22 for 6.20 (Rev 27) =&lt;br /&gt;
&lt;br /&gt;
===Diff file with all changes===&lt;br /&gt;
[[File:6.20_to_6.20_rev27_2011-09-22.diff]]&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
No CSS files removed.&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/bgimages.css&lt;br /&gt;
 - theme/css/global.css&lt;br /&gt;
 - theme/css/popus.css &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.bg-toolbar-compact {&lt;br /&gt;
    background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header-handle {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 24px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    line-height: 22px;&lt;br /&gt;
    padding-left: 10px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit/IE9 */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr=&#039;#ffffff&#039;, endColorstr=&#039;#efefef&#039;);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button,&lt;br /&gt;
.ox-portal-widget .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.ox-button.ox-button-disabled,&lt;br /&gt;
.ox-button.default.ox-button-disabled&lt;br /&gt;
.ox-button.dark.ox-button-disabled {&lt;br /&gt;
    color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover, .ox-button:focus {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in popup.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
#wizzardPublishImageTank .linkstyle {&lt;br /&gt;
	cursor: default !important;&lt;br /&gt;
	text-decoration: none !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span,&lt;br /&gt;
#wizzardPublishImageTank .linkstyle a {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.2 to 6.20 =&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files in this release.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/newwindow.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .topheader-l {&lt;br /&gt;
  background-image: url(../img/border/topheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-tl {&lt;br /&gt;
  background-image: url(../img/border/topheader-tl.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-t {&lt;br /&gt;
  background-image: url(../img/border/topheader-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-tr {&lt;br /&gt;
  background-image: url(../img/border/topheader-tr.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-r {&lt;br /&gt;
  background-image: url(../img/border/topheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }		&lt;br /&gt;
&lt;br /&gt;
 .topheaderactive-t {&lt;br /&gt;
  background-image: url(../img/border/topheaderactive-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .calbody-r {&lt;br /&gt;
  background-image: url(../img/border/calbody-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .oxheader-l {&lt;br /&gt;
  background-image: url(../img/border/oxheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
			&lt;br /&gt;
 .oxheader-r {&lt;br /&gt;
  background-image: url(../img/border/oxheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .cpbody-size {&lt;br /&gt;
  left: 4px;&lt;br /&gt;
  right: 4px;&lt;br /&gt;
  width: 4px;&lt;br /&gt;
  top: 1px;&lt;br /&gt;
  bottom: 1px;&lt;br /&gt;
  height: 1px;&lt;br /&gt;
 }	&lt;br /&gt;
&lt;br /&gt;
 .cpbottom-size {&lt;br /&gt;
  left: 12px;&lt;br /&gt;
  right: 12px;&lt;br /&gt;
  width: 12px;&lt;br /&gt;
  top: 20px;&lt;br /&gt;
  bottom: 20px;&lt;br /&gt;
  height: 20px;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .expandButton {&lt;br /&gt;
  background-image:url(&amp;quot;../img/arrows/arrow_gray_down.gif&amp;quot;);	&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .sp-toggle&lt;br /&gt;
 {&lt;br /&gt;
  background-image:url(../img/border/spback.gif);&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in branding.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 #header {&lt;br /&gt;
  top: 0px !important; /* change this to branding height */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #header-decorator {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #notheader {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in calendar.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.kwSeparationBackGround {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.offTimeBackground {&lt;br /&gt;
    background-color : #E4E8FA;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.workTimeBackground {&lt;br /&gt;
    background-color : #F2F6FA;&lt;br /&gt;
}&lt;br /&gt;
.wholeDayBackground {&lt;br /&gt;
    background-color: #dddddd;&lt;br /&gt;
}&lt;br /&gt;
.appointmentTitleBG {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appointmentViewHeadBG {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
    border-top: 1px solid;  &lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.strokeCalendar {&lt;br /&gt;
    border-color : #D1D8DD !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.sectionStrokeCalendar {&lt;br /&gt;
    border-color : #a5b5bf !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSliderBox {&lt;br /&gt;
    border-top: 1px solid #3066c5;&lt;br /&gt;
    border-bottom: 1px solid #3066c5;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSlider {&lt;br /&gt;
    border: 1px solid #999;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_control_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .leftColumn .rowSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .dataGrid .appointment.isSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
 /* customs */&lt;br /&gt;
&lt;br /&gt;
#cwwtimecontent &amp;gt; tbody &amp;gt; tr &amp;gt; td &amp;gt; table &amp;gt; tbody &amp;gt; tr &amp;gt; td:first-child {&lt;br /&gt;
    background-color: #ff0000;&lt;br /&gt;
    width: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cww_timeline {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cww-timeline-font {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
    color: #333;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cwwheaderresize &amp;gt; table {&lt;br /&gt;
    height: 100%;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appInWeekView, .appInMonthView, .showAppointmentTextMonthFull {&lt;br /&gt;
	background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.todayBackground {&lt;br /&gt;
    background-color: #fc0 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in iframe.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
html, body {&lt;br /&gt;
    font-family: Arial, Helvetica, sans-serif; &lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.plainTextContent {&lt;br /&gt;
    font-family: monospace, Courier New;&lt;br /&gt;
    line-height: 1.5em;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Rainbow quoting */&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote {&lt;br /&gt;
	border-left: 2px solid #364e9b !important; /* blue */&lt;br /&gt;
	background-color: #f5f7ff;&lt;br /&gt;
    color: #1a254a !important;&lt;br /&gt;
    margin-right: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote {&lt;br /&gt;
    border-color: #366a9b !important; /* cyan */&lt;br /&gt;
    background-color: #e6f3ff;&lt;br /&gt;
    color: #1e3b56 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #3c7027 !important; /* green */&lt;br /&gt;
    background-color: #edffe6;&lt;br /&gt;
    color: #192e10 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #efc000 !important; /* orange */&lt;br /&gt;
    background-color: #fffae6;&lt;br /&gt;
    color: #713200 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #5c1111 !important; /* red*/&lt;br /&gt;
    background-color: #ffeeee;&lt;br /&gt;
    color: #751000 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #801062 !important; /* pink */&lt;br /&gt;
    background-color: #ffeffb;&lt;br /&gt;
    color: #3c072e !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #240a4f !important; /* violet */&lt;br /&gt;
    background-color: #f1e9ff;&lt;br /&gt;
    color: #3a1081 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #333 !important; /* gray */&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    color: #333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #555 !important; /* black */&lt;br /&gt;
    background-color: #fff;&lt;br /&gt;
    color: #111 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in popuo.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.popupHeaderBackground {&lt;br /&gt;
	background-color: #bbb !important;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivOver {&lt;br /&gt;
	background-color:#bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActive {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActiveNoPadding {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.popup-header, .listDialogue td.listDialogueHeader {&lt;br /&gt;
	font-weight: bold;&lt;br /&gt;
	color: #000;&lt;br /&gt;
	background-image: url(../img/panels/miniviewHeader_b.gif);	&lt;br /&gt;
	background-color: #bbb;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
body {&lt;br /&gt;
	background-color: #cccccc; /* was #a9b2c5 */&lt;br /&gt;
	font-family: Arial, Helvetica, sans-serif;&lt;br /&gt;
	font-size: 9pt;&lt;br /&gt;
	color:#000;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.webkit body {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 50%, 0% 100%, from(#ccc), to(#333)); /* ccc to 555 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.firefox body {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #eee, #555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.font-style-person, .font-color-person {&lt;br /&gt;
    color: #344F70;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cpheader-color {&lt;br /&gt;
	background-color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.topHeaderBG, .topheader-color {&lt;br /&gt;
	background-color: #444;	/* was #65769b */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.background-color-content, .cpbody-color {&lt;br /&gt;
	background-color: #f5f5f5 !important;&lt;br /&gt;
}&lt;br /&gt;
(was .background-color-content, .cpbody-color, .calbody-color)&lt;br /&gt;
&lt;br /&gt;
.background-color-PMG-selection-elements {&lt;br /&gt;
	background-color: #bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.entrySelDiv {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*live grid selection*/&lt;br /&gt;
.selected {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.selectedfocused {&lt;br /&gt;
	border-color: #607090 !important;&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont {&lt;br /&gt;
	background-color: white !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont, .mailDetailAttachmentsContSel {&lt;br /&gt;
    border-color: #C0C0C0 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dndOver {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
	border-color: #bdd3eb !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.browsercheck {&lt;br /&gt;
	background-image: url(../img/browsercheck.png);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#sidepanel_dragpoint_background {&lt;br /&gt;
    background-color: #ddd;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit #sidepanel_dragpoint_background {&lt;br /&gt;
    -webkit-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox #sidepanel_dragpoint_background {&lt;br /&gt;
    -moz-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #sidesplit {&lt;br /&gt;
    border-right: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #mainarea {&lt;br /&gt;
    border-left: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dropdownbox .comboboxColumn2 {&lt;br /&gt;
    background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
#menu_search_mail_context, #menu_search_context {&lt;br /&gt;
	background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl {&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-sidepanel-title {&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl a {&lt;br /&gt;
	color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    background-color: #666; /* was #455069 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTabCurrent, div.oxTabControl td.oxTabCurrent:hover {&lt;br /&gt;
    color: #000;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-top: 2px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*&lt;br /&gt;
 * Portal &lt;br /&gt;
 */&lt;br /&gt;
&lt;br /&gt;
.ox-portal {&lt;br /&gt;
    background-color: white; /* body: A9B2C5 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top , #FFFFFF, #DDDDDD);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#DDDDDD));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-placeholder {&lt;br /&gt;
    border: 2px dashed #888;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget */&lt;br /&gt;
.ox-portal-widget {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    padding: 0px 0px 8px 0px;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -moz-border-radius: 8px;&lt;br /&gt;
    -moz-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -webkit-border-radius: 8px;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* IE gets no radius, no shadow */&lt;br /&gt;
.IE .ox-portal-widget {&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget header */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit */&lt;br /&gt;
.firefox .ox-portal-header {&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-header {&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* close/remove button */&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* controls */&lt;br /&gt;
.ox-portal-topbar {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-bottom: 1px solid #aaa;&lt;br /&gt;
    color: #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar i {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	font-style: normal;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar b {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	color: #999;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar a {&lt;br /&gt;
    color: #00f;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    text-decoration: underline;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls, .ox-quick-config {&lt;br /&gt;
	background-color: #444;&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-controls, .firefox .ox-quick-config {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-controls, .webkit .ox-quick-config {&lt;br /&gt;
	background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config table {&lt;br /&gt;
	margin: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config td, .ox-quick-config th {&lt;br /&gt;
	padding: 0px 20px 5px 0px;&lt;br /&gt;
	vertical-align: top;&lt;br /&gt;
	white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config th {&lt;br /&gt;
    color: #8AC2FF;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    text-align: left;&lt;br /&gt;
    padding-bottom: 2px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls label, .ox-quick-config label {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout {&lt;br /&gt;
	width: 90px;&lt;br /&gt;
	height: 60px;&lt;br /&gt;
    background-image: url(../img/portal/layouts.png);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    margin: 2px 22px 2px 2px;&lt;br /&gt;
    border: 0px none;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.one {&lt;br /&gt;
	background-position: 0px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.two {&lt;br /&gt;
    background-position: -90px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.three {&lt;br /&gt;
    background-position: -180px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.four {&lt;br /&gt;
    background-position: -270px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.five {&lt;br /&gt;
    background-position: -360px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.active, .ox-portal-layout.active:hover {&lt;br /&gt;
	background-color: #67789D;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
	-webkit-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout:hover {&lt;br /&gt;
	background-color: #888;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* &lt;br /&gt;
 * Button&lt;br /&gt;
 */&lt;br /&gt;
.ox-button {&lt;br /&gt;
	font-size: 8pt;&lt;br /&gt;
	line-height: 1.5em;&lt;br /&gt;
    border-radius: 5px;&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
    color: black;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    padding: 5px 1em 5px 1em;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    display: inline-block;&lt;br /&gt;
    vertical-align: middle;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark {&lt;br /&gt;
    background-color: #333;&lt;br /&gt;
    border: 1px solid #222;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* firefox */&lt;br /&gt;
.ox-button.firefox {&lt;br /&gt;
	-moz-border-radius: 5px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.firefox {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #555555, #333333);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.firefox:hover {&lt;br /&gt;
	-moz-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* webkit */&lt;br /&gt;
.ox-button.webkit {&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.webkit {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#555555), to(#333333));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.webkit:hover {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows */&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-decorator {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px; &lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    background-color: black; &lt;br /&gt;
    opacity: 0.10;&lt;br /&gt;
    filter: alpha(opacity=10);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-container {&lt;br /&gt;
    position: absolute; &lt;br /&gt;
    top: 0px; &lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 50%; &lt;br /&gt;
    margin-left: 0px; /* use to center */&lt;br /&gt;
    width: 0px; /* live parameter; override with !important */&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    visibility: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-container {&lt;br /&gt;
    -moz-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-container {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE .ox-embedded-container {&lt;br /&gt;
    border: 1px solid #333;&lt;br /&gt;
    border-width: 0px 1px 0px 1px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-title {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    line-height: 12px;&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    text-align: center;&lt;br /&gt;
    padding: 9px 20px 8px 10px;&lt;br /&gt;
    color: #ccc;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    border-bottom: 1px solid #333;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-title {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111, #444);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-title {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111), to(#444));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 7px;&lt;br /&gt;
    right: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close img {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/x.png);&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-iframe {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 30px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows: dock */&lt;br /&gt;
&lt;br /&gt;
.ox-dock {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    color: black;&lt;br /&gt;
    border-top: 1px solid #333;&lt;br /&gt;
    height: 33px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    z-index: 65000;&lt;br /&gt;
    display: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-tab {&lt;br /&gt;
    background-color: #222;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    border: 1px solid black;&lt;br /&gt;
    border-width: 0px 1px 1px 1px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    padding: 4px 10px 4px 10px;&lt;br /&gt;
    margin: 0px 0px 0px 5px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    height: 1.5em;&lt;br /&gt;
    color: white;&lt;br /&gt;
    border-radius: 0px 0px 8px 8px;&lt;br /&gt;
        &lt;br /&gt;
    position: relative;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    overflow: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-tab {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #333333);&lt;br /&gt;
    -moz-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-tab {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#333333));&lt;br /&gt;
    -webkit-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-selected {&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-selected {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #666);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-selected {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#666));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Context-menu button */&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.weekDivMonthView .background-color-content{&lt;br /&gt;
    background-color: #ffdaab !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/icons/16/calendar_dis.png&lt;br /&gt;
 - theme/icons/16/calendar.png&lt;br /&gt;
 - theme/icons/16/contacts_dis.png&lt;br /&gt;
 - theme/icons/16/contacts.png&lt;br /&gt;
 - theme/icons/16/draft_dis.png&lt;br /&gt;
 - theme/icons/16/draft.png&lt;br /&gt;
 - theme/icons/16/facebook.png&lt;br /&gt;
 - theme/icons/16/folder_closed_dis.png&lt;br /&gt;
 - theme/icons/16/folder_opened_dis.png&lt;br /&gt;
 - theme/icons/16/forward.png&lt;br /&gt;
 - theme/icons/16/garbage_dis.png&lt;br /&gt;
 - theme/icons/16/garbage.png&lt;br /&gt;
 - theme/icons/16/ham_dis.png&lt;br /&gt;
 - theme/icons/16/ham.png&lt;br /&gt;
 - theme/icons/16/inbox_dis.png&lt;br /&gt;
 - theme/icons/16/inbox.png&lt;br /&gt;
 - theme/icons/16/infostore_dis.png&lt;br /&gt;
 - theme/icons/16/infostore.png&lt;br /&gt;
 - theme/icons/16/mail_dis.png&lt;br /&gt;
 - theme/icons/16/mail.png&lt;br /&gt;
 - theme/icons/16/outbox_dis.png&lt;br /&gt;
 - theme/icons/16/outbox.png&lt;br /&gt;
 - theme/icons/16/public_dis.png&lt;br /&gt;
 - theme/icons/16/public.png&lt;br /&gt;
 - theme/icons/16/rss.png&lt;br /&gt;
 - theme/icons/16/shared_dis.png&lt;br /&gt;
 - theme/icons/16/shared_globe.png&lt;br /&gt;
 - theme/icons/16/shared.png&lt;br /&gt;
 - theme/icons/16/spam_dis.png&lt;br /&gt;
 - theme/icons/16/spam.png&lt;br /&gt;
 - theme/icons/16/tasks_dis.png&lt;br /&gt;
 - theme/icons/16/tasks.png&lt;br /&gt;
 - theme/icons/16/twitter.png&lt;br /&gt;
 - theme/icons/16/user_dis.png&lt;br /&gt;
&lt;br /&gt;
 - theme/icons/24/calendar_move.png&lt;br /&gt;
 - theme/icons/24/distributionlist_extcontact.png&lt;br /&gt;
 - theme/icons/24/ham.png&lt;br /&gt;
 - theme/icons/24/mark_as_done.png&lt;br /&gt;
 - theme/icons/24/mark_as.png&lt;br /&gt;
 - theme/icons/24/spam.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/arrows/arrow_white_down.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/slider_background.png&lt;br /&gt;
 - theme/img/calendar/slider_control_background.png&lt;br /&gt;
&lt;br /&gt;
 - themes/portal/layouts.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/browsercheck.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.gif&lt;br /&gt;
 changed to a png image&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/calbody-r.png&lt;br /&gt;
 - theme/img/border/cpbody-l.png&lt;br /&gt;
 - theme/img/border/cpbody-r.png&lt;br /&gt;
 - theme/img/border/cpbottom-b.png&lt;br /&gt;
 - theme/img/border/cpbottom-bl.png&lt;br /&gt;
 - theme/img/border/cpbottom-l.png&lt;br /&gt;
 - theme/img/border/cpbottom-r.png&lt;br /&gt;
 - theme/img/border/cpheader-l.png&lt;br /&gt;
 - theme/img/border/cpheader-r.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-ll.png&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-rr.png&lt;br /&gt;
 - theme/img/border/popup/popup-border-imagemap.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31.gif&lt;br /&gt;
 All icons have changed from gif to png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/infostore/mimetypes/vcard.gif&lt;br /&gt;
&lt;br /&gt;
 - theme/img/panels/miniviewHeader_b.gif&lt;br /&gt;
&lt;br /&gt;
 - themes/img/x.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1_sel.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31_sel.gif&lt;br /&gt;
 All icons with the _sel ending have been removed&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.1 to 6.18.2=&lt;br /&gt;
&lt;br /&gt;
===New CSS file===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/branding.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
- theme/css/global.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-person {&lt;br /&gt;
    		color: #215696;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	#window-header-decorator {&lt;br /&gt;
    		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
    		background-repeat: repeat-x;&lt;br /&gt;
    		background-color: #ddd;&lt;br /&gt;
    		border-bottom: 1px solid #bbb;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
		background-repeat: repeat-x;&lt;br /&gt;
		border-top: 0px none;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable.border-color-design {&lt;br /&gt;
		border-color: #aaa !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse, div.oxTabControlToggle {&lt;br /&gt;
		background-repeat: no-repeat;&lt;br /&gt;
		background-position: 3px 5px;&lt;br /&gt;
		width: 15px;&lt;br /&gt;
		height: 15px;&lt;br /&gt;
		float: right;&lt;br /&gt;
		margin: 5px 9px;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_down.gif);&lt;br /&gt;
		cursor: s-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggle {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_up.gif);&lt;br /&gt;
		cursor: n-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl {&lt;br /&gt;
	    background-color: #65769B;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.ox-sidepanel-view-title {&lt;br /&gt;
		color: white;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl a {&lt;br /&gt;
		color: #eee;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    		background-color: #455069;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Change elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color:#404962;  &lt;br /&gt;
		font-weight : bold; &lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color: #333;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	#notheader {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	#header-decorator {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.tr_h {&lt;br /&gt;
    		background-color: #e3e3e3 !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.tr_h {&lt;br /&gt;
		background-color: #eaeaea !important;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_down.gif&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_up.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_down.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_right.gif&lt;br /&gt;
 - theme/img/folder/shared_dis.gif &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
All icons under the folder /themes/[theme name]/ will be separated by their size. You will find three different sub-folders here: 16 (for 16x16 pixel icons), 24 and 36. Some icons may be available in several folders. Some icons can also be found in their old location under /themes/[theme name]/img/. In the future, all icons will be found in the new icons folder and not in the img folder.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
16/attachment_add.png&lt;br /&gt;
16/attachment_open.png&lt;br /&gt;
16/attachment_remove.png&lt;br /&gt;
16/calendar_move.png&lt;br /&gt;
16/confirmation_change.png&lt;br /&gt;
16/contact_copy.png&lt;br /&gt;
16/contact_move.png&lt;br /&gt;
16/current_version.png&lt;br /&gt;
16/delete_folder.png&lt;br /&gt;
16/delete.png&lt;br /&gt;
16/distributionlist_extcontact.png&lt;br /&gt;
16/dummy.gif&lt;br /&gt;
16/duplicate_contacts.png&lt;br /&gt;
16/folder_closed.png&lt;br /&gt;
16/folder_opened.png&lt;br /&gt;
16/infostore_move.png&lt;br /&gt;
16/lock.png&lt;br /&gt;
16/mail_copy.png&lt;br /&gt;
16/mail_move.png&lt;br /&gt;
16/mail_source.png&lt;br /&gt;
16/mark_as.png&lt;br /&gt;
16/member_add.png&lt;br /&gt;
16/member_remove.png&lt;br /&gt;
16/mod_calendar.png&lt;br /&gt;
16/mod_configuration.png&lt;br /&gt;
16/mod_contacts.png&lt;br /&gt;
16/mod_infostore.png&lt;br /&gt;
16/mod_mail.png&lt;br /&gt;
16/mod_portal.png&lt;br /&gt;
16/mod_tasks.png&lt;br /&gt;
16/print.png&lt;br /&gt;
16/save.png&lt;br /&gt;
16/search.png&lt;br /&gt;
16/send_as_attachment.png&lt;br /&gt;
16/send_as_link.png&lt;br /&gt;
16/task_copy.png&lt;br /&gt;
16/task_move.png&lt;br /&gt;
16/teamchange.png&lt;br /&gt;
16/unlock.png&lt;br /&gt;
16/user.png&lt;br /&gt;
16/userrights_delete.png&lt;br /&gt;
16/userrights.png&lt;br /&gt;
16/userrights_read.png&lt;br /&gt;
16/userrights_remove.png&lt;br /&gt;
16/userrights_write.png&lt;br /&gt;
&lt;br /&gt;
24/attachment_add.png&lt;br /&gt;
24/attachment_remove.png&lt;br /&gt;
24/cancel.png&lt;br /&gt;
24/card_view.png&lt;br /&gt;
24/category_add.png&lt;br /&gt;
24/category_remove.png&lt;br /&gt;
24/confirmation_change.png&lt;br /&gt;
24/delete.png&lt;br /&gt;
24/detail_view.png&lt;br /&gt;
24/distributionlist.png&lt;br /&gt;
24/draft.png&lt;br /&gt;
24/dummy.gif&lt;br /&gt;
24/edit.png&lt;br /&gt;
24/externalview_add.png&lt;br /&gt;
24/externalview_disable.png&lt;br /&gt;
24/externalview_edit.png&lt;br /&gt;
24/externalview_enable.png&lt;br /&gt;
24/externalview_remove.png&lt;br /&gt;
24/forward.png&lt;br /&gt;
24/h_split_view.png&lt;br /&gt;
24/inbox.png&lt;br /&gt;
24/list_view.png&lt;br /&gt;
24/mail_copy.png&lt;br /&gt;
24/mail_move.png&lt;br /&gt;
24/mail_send.png&lt;br /&gt;
24/mail_write.png&lt;br /&gt;
24/member_add.png&lt;br /&gt;
24/member_remove.png&lt;br /&gt;
24/mod_calendar.png&lt;br /&gt;
24/mod_configuration.png&lt;br /&gt;
24/mod_contacts.png&lt;br /&gt;
24/mod_foldertree.png&lt;br /&gt;
24/mod_infostore.png&lt;br /&gt;
24/mod_mail.png&lt;br /&gt;
24/mod_portal.png&lt;br /&gt;
24/mod_tasks.png&lt;br /&gt;
24/options.png&lt;br /&gt;
24/picture_add.png&lt;br /&gt;
24/picture_remove.png&lt;br /&gt;
24/print.png&lt;br /&gt;
24/reply_all.png&lt;br /&gt;
24/reply.png&lt;br /&gt;
24/save_as_link.png&lt;br /&gt;
24/save.png&lt;br /&gt;
24/tag_10.png&lt;br /&gt;
24/tag_1.png&lt;br /&gt;
24/tag_2.png&lt;br /&gt;
24/tag_3.png&lt;br /&gt;
24/tag_4.png&lt;br /&gt;
24/tag_5.png&lt;br /&gt;
24/tag_6.png&lt;br /&gt;
24/tag_7.png&lt;br /&gt;
24/tag_8.png&lt;br /&gt;
24/tag_9.png&lt;br /&gt;
24/tag_remove.png&lt;br /&gt;
24/task_copy.png&lt;br /&gt;
24/task_move.png&lt;br /&gt;
24/teamchange.png&lt;br /&gt;
24/v_split_view.png&lt;br /&gt;
&lt;br /&gt;
32/attachment_add.png&lt;br /&gt;
32/attachment_remove.png&lt;br /&gt;
32/cancel.png&lt;br /&gt;
32/category_add.png&lt;br /&gt;
32/category_remove.png&lt;br /&gt;
32/confirmation_change.png&lt;br /&gt;
32/delete.png&lt;br /&gt;
32/distributionlist.png&lt;br /&gt;
32/draft.png&lt;br /&gt;
32/dummy.gif&lt;br /&gt;
32/edit.png&lt;br /&gt;
32/externalview_add.png&lt;br /&gt;
32/externalview_disable.png&lt;br /&gt;
32/externalview_edit.png&lt;br /&gt;
32/externalview_enable.png&lt;br /&gt;
32/externalview_remove.png&lt;br /&gt;
32/forward.png&lt;br /&gt;
32/import.png&lt;br /&gt;
32/mail_copy.png&lt;br /&gt;
32/mail_move.png&lt;br /&gt;
32/mail_send.png&lt;br /&gt;
32/mail_write.png&lt;br /&gt;
32/member_add.png&lt;br /&gt;
32/member_remove.png&lt;br /&gt;
32/mod_calendar.png&lt;br /&gt;
32/mod_configuration.png&lt;br /&gt;
32/mod_contacts.png&lt;br /&gt;
32/mod_infostore.png&lt;br /&gt;
32/mod_mail.png&lt;br /&gt;
32/mod_portal.png&lt;br /&gt;
32/mod_tasks.png&lt;br /&gt;
32/options.png&lt;br /&gt;
32/picture_add.png&lt;br /&gt;
32/picture_remove.png&lt;br /&gt;
32/print.png&lt;br /&gt;
32/reply_all.png&lt;br /&gt;
32/reply.png&lt;br /&gt;
32/save_as_link.png&lt;br /&gt;
32/save.png&lt;br /&gt;
32/tag_10.png&lt;br /&gt;
32/tag_1.png&lt;br /&gt;
32/tag_2.png&lt;br /&gt;
32/tag_3.png&lt;br /&gt;
32/tag_4.png&lt;br /&gt;
32/tag_5.png&lt;br /&gt;
32/tag_6.png&lt;br /&gt;
32/tag_7.png&lt;br /&gt;
32/tag_8.png&lt;br /&gt;
32/tag_9.png&lt;br /&gt;
32/tag_remove.png&lt;br /&gt;
32/task_copy.png&lt;br /&gt;
32/task_move.png&lt;br /&gt;
32/teamchange.png&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/toolbar/toolbar_bg.gif&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=9397</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=9397"/>
		<updated>2011-11-21T08:42:57Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Documented action=zip_messages&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server through HTTP GET, POST and PUT requests. HTTP cookies are used for authentication and must therefore be processed and sent back by the client as specified by [http://tools.ietf.org/html/rfc6265 RFC 6265]. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || The latest timestamp of the returned data (see [[HTTP_API#Updates|Updates]]).&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is a 1-based decimal parameter index. The conversion specifications are replaced from left to right by elements from error_params, starting at the first element. %s is replaced by the current element and the current index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the &#039;&#039;n&#039;&#039;th element and the current index is set to the (&#039;&#039;n&#039;&#039; + 1)th element.&lt;br /&gt;
&lt;br /&gt;
Some error message contain data sizes which must be expressed in Bytes or Kilobytes etc., depending on the actual value. Since the unit must be translated, this conversion is performed by the client. Unfortunately, standard printf()-style formatting does not have a specifier for this kind of translation. Therefore, the conversion specification for sizes is the same as for normal strings, and the client has to determine which parameters to translate based on the error code. The current error codes and the corresponding size parameters are listed in [[#DataSizeParameters | Data size parameters]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSizeParameters&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data size parameters&lt;br /&gt;
! Error code !! Parameter indices&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0006   || 1&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0020   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
| CON-0101   || 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| FLS-0003   || 1, 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0065   || 1, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0066   || 1&lt;br /&gt;
|-&lt;br /&gt;
| NON-0005   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
==== Detailed Exception Data (Preliminary) ====&lt;br /&gt;
Starting with some upcoming version application errors will be returned in the field &amp;quot;exception&amp;quot; in a response. The exception field will contain a JSON array containing objects that have the format specified in the following table:&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Exception Object&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|} &lt;br /&gt;
|-&lt;br /&gt;
| message      || String    || Localized error message. &lt;br /&gt;
|-&lt;br /&gt;
| parameters   || Array     || Replacement parameters for the message. &#039;&#039;What are they good for if the message is already localized? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| logMessage   || String    || Technical error message useful for debugging the problem. &lt;br /&gt;
|-&lt;br /&gt;
| exceptionId  || String    || Unique error identifier to help finding this error instance in the server logs. &lt;br /&gt;
|-&lt;br /&gt;
| help         || String    || Localized help text, telling the user how he may resolve the problem. &lt;br /&gt;
|-&lt;br /&gt;
| session      || String    || The session id of the session in which this exception was caused. &#039;&#039;When can this be &#039;&#039;&#039;not&#039;&#039;&#039; the current session? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| user         || Number    || The id of the user having caused the exception. &#039;&#039;When can this be &#039;&#039;&#039;not&#039;&#039;&#039; the current user? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| context      || Number    || The context id of the context in which the exception happened. &#039;&#039;When can this be &#039;&#039;&#039;not&#039;&#039;&#039; the current context? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| details      || Object    || A JSON Object containing extra information for debugging purposes. &lt;br /&gt;
|-&lt;br /&gt;
| application  || String    || Application ID of the subsystem having thrown this exception. &lt;br /&gt;
|-&lt;br /&gt;
| stacktrace   || Array     || An array of Strings containing the error trace. Note: This can be turned off in the backend, in which case an empty array will be returned. &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the &#039;&#039;user&#039;s&#039;&#039; timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)). Unless optional URL parameter &amp;lt;code&amp;gt;&#039;&#039;&#039;timezone&#039;&#039;&#039;&amp;lt;/code&amp;gt; is present. Then dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the &#039;&#039;specified&#039;&#039; timezone and UTC at the time in question.&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is functionally equivalent to:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             (owner || parent).callback_&amp;lt;b&amp;gt;action&amp;lt;/b&amp;gt;(&amp;lt;b&amp;gt;{json}&amp;lt;/b&amp;gt;);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;{json}&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Non-browser clients don&#039;t need to interpret HTML or JavaScript. The JSON data can be recognized by the outermost &amp;lt;code&amp;gt;({&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;})&amp;lt;/code&amp;gt;, where the inner braces are part of the JSON value. For example, the regular expression &amp;lt;code&amp;gt;\((\{.*\})\)&amp;lt;/code&amp;gt; captures the entire JSON value in its first capturing group.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
=== Common object data ===&lt;br /&gt;
&lt;br /&gt;
This table contains common fields which apply for any module&#039;s data type and is referenced throughout this document whenever a module&#039;s data type is described.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100  || categories     || String  || String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101  || private_flag     || Boolean  || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 102  || color_label  || Number  || Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 1 and 10 (inclusive). Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 103  || number_of_links     || Number  || Number of links. &#039;&#039;&#039;deprecated&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| 104  || number_of_attachments     || Number  || Number of attachments &lt;br /&gt;
|-&lt;br /&gt;
| 105 || lastModifiedOfNewestAttachmentUTC || Time || Date and time of the newest attachment written with UTC time zone.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
* &amp;lt;code&amp;gt;authId&amp;lt;/code&amp;gt; (optional) – Identifier for tracing every single login request passed between different systems in a cluster. The value should be some token that is unique for every login request. This parameter must be given as URL parameter and not inside the body of the POST request.&lt;br /&gt;
* &amp;lt;code&amp;gt;client&amp;lt;/code&amp;gt; (optional) – Identifier of the client using the HTTP/JSON interface. This is for statistic evaluations what clients are used with Open-Xchange.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – Used version of the HTTP/JSON interface client.&lt;br /&gt;
* &amp;lt;code&amp;gt;clientIP&amp;lt;/code&amp;gt; (optional) – IP address of the client host for that the session is created. If this parameter is not specified the IP address of the HTTP client doing this request is used.&lt;br /&gt;
* &amp;lt;code&amp;gt;clientUserAgent&amp;lt;/code&amp;gt; (optional) – Value of the User-Agent header of the client host for that the session is created. If this parameter is not specified the User-Agent of the current HTTP client doing this request is used.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object containing the session ID used for all subsequent requests. Additionally a random token is contained to be used for the Easy Login method.&lt;br /&gt;
&lt;br /&gt;
=== Form Login (since 6.20) ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/login?action=formlogin&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This request implements a possible login to the web frontend by only using a simple HTML form. An example for such a form can be found in the backend&#039;s documentation folder (&amp;lt;code&amp;gt;/usr/share/doc/open-xchange&amp;lt;/code&amp;gt;) under &amp;lt;code&amp;gt;examples/login.html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;login&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
* &amp;lt;code&amp;gt;authId&amp;lt;/code&amp;gt; – Identifier for tracing every single login request passed between different systems in a cluster. The value should be some token that is unique for every login request. This parameter must be given as URL parameter and not inside the body of the POST request.&lt;br /&gt;
* &amp;lt;code&amp;gt;client&amp;lt;/code&amp;gt; – Identifier of the client using the HTTP/JSON interface. This is for statistic evaluations what clients are used with Open-Xchange. If the autologin request should work the client must be the same as the client sent by the UI in the normal login request.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; – Used version of the HTTP/JSON interface client.&lt;br /&gt;
* &amp;lt;code&amp;gt;autologin&amp;lt;/code&amp;gt; – True or false. True tells the UI to issue a store request for the session cookie. This store request is necessary if you want the autologin request not to fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;uiWebPath&amp;lt;/code&amp;gt; (optional) – Defines another path on the web server where the UI is located. If this parameter is not defined the configured default of the backend is used.&lt;br /&gt;
* &amp;lt;code&amp;gt;clientIP&amp;lt;/code&amp;gt; (optional) – IP address of the client host for that the session is created. If this parameter is not specified the IP address of the HTTP client doing this request is used.&lt;br /&gt;
* &amp;lt;code&amp;gt;clientUserAgent&amp;lt;/code&amp;gt; (optional) – Value of the User-Agent header of the client host for that the session is created. If this parameter is not specified the User-Agent of the current HTTP client doing this request is used.&lt;br /&gt;
&lt;br /&gt;
Response: A redirect to the web UI. The URL of the web UI is either taken from the given parameter or from the configured default of the backend.&lt;br /&gt;
&lt;br /&gt;
For a complete description of the FormLogin-Process please see [[FormLogin|this documentation]]&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
=== Refresh secret cookie (since 6.18.2) ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=refreshSecret&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
=== Refresh auto-login cookie ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=store&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
=== Redirect ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login;jsessionid=1157370816112.OX1?action=redirect&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;SECURITY WARNING!&#039;&#039;&#039; Utilizing this request is &#039;&#039;&#039;INSECURE&#039;&#039;&#039;! This request allows to access a session with a single one time token. This one time token may be delivered to the wrong client if the AJP protocol has an error or Apache or the load balancer make a mistake. This will cause a wrong user to be in a wrong session. &#039;&#039;&#039;IMMEDIATELY&#039;&#039;&#039; consider not to use this request anymore. You have been warned. Use instead the FormLogin that does not need to use the redirect request.&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;random&amp;lt;/code&amp;gt; – A session random token to jump into the session. This random token is part of the login response. Only a very short configurable time after the login it is allowed to jump into the session with the random token.&lt;br /&gt;
* &amp;lt;code&amp;gt;client&amp;lt;/code&amp;gt; (optional) – The client can be defined here newly if it is not correct on the login request itself.&lt;br /&gt;
* &amp;lt;code&amp;gt;store&amp;lt;/code&amp;gt; (optional) – Tells the UI to do a store request after login to be able to use autologin request.&lt;br /&gt;
* &amp;lt;code&amp;gt;uiWebPath&amp;lt;/code&amp;gt; (optional) – The optional path on the webserver to the UI. If this parameter is not given the configured uiWebPath is used.&lt;br /&gt;
&lt;br /&gt;
=== Change IP ===&lt;br /&gt;
&lt;br /&gt;
The following request is especially for integration with systems located in the providers infrastructure. If those systems create a session with the following request the client host IP address in the session can be changed. The IP check for following requests will be done using this newly set client host IP address.&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/login?action=changeip&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;clientIP&amp;lt;/code&amp;gt; – New IP address of the client host for the current session.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object containing the string &amp;quot;1&amp;quot; as data attribute.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – A string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;fastgui&amp;lt;/code&amp;gt; - A string containing GUI-specific settings. This is a JSON object that must be kept small for performance.&lt;br /&gt;
** &amp;lt;code&amp;gt;context_id&amp;lt;/code&amp;gt; - the unique identifier of the context (read-only, added 2008-01-28).&lt;br /&gt;
** &amp;lt;code&amp;gt;cookielifetime&amp;lt;/code&amp;gt; - the cookie life time in seconds or &amp;lt;code&amp;gt;-1&amp;lt;/code&amp;gt; for session cookie (read-only, added 2010-11-16).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;availableTimeZones&amp;lt;/code&amp;gt; – a JSON object containing all available time zones. The key is the time zone identifier and the value contains its name in users language. (read-only, added 2010-07-08/v6.18).&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments (deprecated since 2008-12-11)&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks (deprecated since 2008-12-11)&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;maxUploadIdleTimeout&amp;lt;/code&amp;gt; - Timeout after that idle uploads are deleted.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with.  (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt; (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not. (deprecated 2008-04-29)&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;autoSearch&amp;lt;/code&amp;gt; - If a search for all users, groups and resources when participant selection dialog is opened. (read-only, added 2008-10-09/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;maximumNumberParticipants&amp;lt;/code&amp;gt; – Defines the maximum number of participants for appointments and tasks. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
*** &amp;lt;code&amp;gt;showDialog&amp;lt;/code&amp;gt; – Enables participant selection dialog for appointments and tasks. (read-only, added 2008-04-30/SP4)&lt;br /&gt;
** &amp;lt;code&amp;gt;availableModules&amp;lt;/code&amp;gt; – Contains a JSON array listing all enabled modules for a user. GUI loads Plugins through this list. To get your plugin listed here, create a subtree below &amp;lt;code&amp;gt;modules/&amp;lt;/code&amp;gt; without a &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; subelement or with a subelement containing &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; (read-only, added 2008-02-25)&lt;br /&gt;
** &amp;lt;code&amp;gt;minimumSearchCharacters&amp;lt;/code&amp;gt; – Minimum number of characters a search pattern must have to prevent large responses and slow queries. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;portal&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for portal module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;appendmailtext&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;allowhtmlimages&amp;lt;/code&amp;gt; – Alters default setting whether external images contained in HTML content are allowed or not (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;colorquoted&amp;lt;/code&amp;gt; – color quoted lines (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectFolder&amp;lt;/code&amp;gt; – contact folder id to save mail addresses from sent mails (added 2008-10-16)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectEnabled&amp;lt;/code&amp;gt; – switch contact collection on/off (added 2008-10-16)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectOnMailAccess&amp;lt;/code&amp;gt; – enables/disables contact collection for incoming mails. Default is true. (added 2009-09-24)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectOnMailTransport&amp;lt;/code&amp;gt; – enables/disables contact collection for outgoing mails. Default is true. (added 2009-09-24)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;deletemail&amp;lt;/code&amp;gt; – delete emails or move to trash (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultFolder&amp;lt;/code&amp;gt;&lt;br /&gt;
***** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;forwardmessage&amp;lt;/code&amp;gt; – forward messages as inline or attachment (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for mail module&lt;br /&gt;
**** &amp;lt;code&amp;gt;inlineattachments&amp;lt;/code&amp;gt; – activate inlining of HTML attachments (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;linewrap&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – if mail module is enabled or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;phishingheaders&amp;lt;/code&amp;gt; – header(s) identifying phishing headers (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;replyallcc&amp;lt;/code&amp;gt; – put all recipients on reply all into CC (added 2008-12-16/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; – Spam Button should be displayed in GUI or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails (added 2008-02-25)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the calendar module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyNewModifiedDeleted&amp;lt;/code&amp;gt; receive mail notification for new, modified or deleted appointments (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsCreator&amp;lt;/code&amp;gt; receive mail notification for accepted or declined appointments created by the user (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsParticipant&amp;lt;/code&amp;gt; receive mail notification for accepted or declined appointments that the user participates (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultStatusPrivate&amp;lt;/code&amp;gt; Default status for new appointments in private folders, where the user is participant. This does not affect appointments created by this user, which always have the status &amp;quot;accepted&amp;quot;. The status are described in [[#UserParticipantObject | User participant object]]. Default is 0:none (added 2009-07-20/6.12)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultStatusPublic&amp;lt;/code&amp;gt; Default status for new appointments in public folders, where the user is participant. This does not affect appointments created by this user, which always have the status &amp;quot;accepted&amp;quot;. The status are described in [[#UserParticipantObject | User participant object]]. Default is 0:none (added 2009-07-20/6.12)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the contacts module&lt;br /&gt;
**** &amp;lt;code&amp;gt;mailAddressAutoSearch&amp;lt;/code&amp;gt; – Define if a search is triggered when the recipient selection dialog is opened or the folder is changed. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; True if the contact module is enabled for the current user, false otherwise.&lt;br /&gt;
**** &amp;lt;code&amp;gt;singleFolderSearch&amp;lt;/code&amp;gt; – True if the current user is allowed to search for contacts only in a single folder. False if contact searches across all folders are allowed. (read-only, added 2009-02-04/SP5 U1)&lt;br /&gt;
**** &amp;lt;code&amp;gt;characterSearch&amp;lt;/code&amp;gt; – True if the side bar for searching for contacts by a start letter should be displayed. False if the side bar should be hidden. (read-only, added 2009-05-29/6.10)&lt;br /&gt;
**** &amp;lt;code&amp;gt;allFoldersForAutoComplete&amp;lt;/code&amp;gt; – true if an auto complete search may omit the folder identifier array and search for contacts in all readable folders. This is configured through the contact.properties configuration file. (read-only, added 2010-07-22/v6.18.0)&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the tasks module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyNewModifiedDeleted&amp;lt;/code&amp;gt; receive mail notification for new, modified or deleted tasks (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsCreator&amp;lt;/code&amp;gt; receive mail notification for accepted or declined tasks created by the user (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsParticipant&amp;lt;/code&amp;gt; receive mail notification for accepted or declined taks that the user participates (added 2008-12-11/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the infostore module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;interfaces&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; UI settings for the folder tree&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – Selected folder tree, the user wants to use. Currents trees are 0 for the known OX folder tree and 1 for the new virtual folder tree. (added 2010-04-09/6.18)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.extras&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Extras link in the configuration (read only, added 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.passwordchange&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to change the Password within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.personaldata&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to edit personal contact information within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.group&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to edit groups and loads the corresponding Plug-In. (read only, added 2008-08-08)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.resource&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to edit resources and loads the corresponding Plug-In. (read only, added 2008-08-08)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.publish&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to publish items. (read only, added 2009-05-27)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.subscribe&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to subscribe sources. (read only, added 2009-05-27)&lt;br /&gt;
*** &amp;lt;code&amp;gt;olox20&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;active&amp;lt;/code&amp;gt; – Tells the UI if the user is allowed to use the OXtender for Microsoft Outlook 2. (read only, added 2011-03-15/6.20)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Is set to false to prevent the UI from trying to load a plugin. (read only, added 2011-03-15/6.20)&lt;br /&gt;
***&amp;lt;code&amp;gt;com.openexchange.oxupdater&amp;lt;/code&amp;gt;&lt;br /&gt;
****&amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Is true if the OXUpdater package is installed and started. (read only, added 2011-06-01/6.20)&lt;br /&gt;
****&amp;lt;code&amp;gt;active&amp;lt;/code&amp;gt; – Is true if the user is allowed to download the OXUpdater. Otherwise it&#039;s false. (read only, added 2011-06-01/6.20)&lt;br /&gt;
***&amp;lt;code&amp;gt;com.openexchange.passwordchange&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;showStrength&amp;lt;/code&amp;gt; – Show a widget, which displays the current passwort Strength while entering. (default: false)&lt;br /&gt;
**** &amp;lt;code&amp;gt;minLength&amp;lt;/code&amp;gt; – The minimum length of an entered password. (default: 4)&lt;br /&gt;
**** &amp;lt;code&amp;gt;maxLength&amp;lt;/code&amp;gt; – The maximum length of an entered password. 0 for unlimited. (default: 0)&lt;br /&gt;
**** &amp;lt;code&amp;gt;regexp&amp;lt;/code&amp;gt; – Defines the class of allowed special characters as Regular Expression. (default: [^a-z0-9])&lt;br /&gt;
**** &amp;lt;code&amp;gt;special&amp;lt;/code&amp;gt; – Shows an example of allowed special characters to the user. Should be a subset of &amp;quot;regexp&amp;quot; in a human readable format. (default: $, _, or %) &lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowed_modules&amp;lt;/code&amp;gt; – (Preliminary) An array of modules (either numbers or strings; e.g. &amp;quot;tasks,calendar,contacts,mail&amp;quot;) supported by requesting client. If missing, all available modules are considered.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common folder data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 6 || last_modified_utc || Timestamp || Timestamp of the last modification. Note that the type is Timestamp, not Time. See [[#Date and time]] for details. (added 2008-10-17, with SP5, temporary workaround)&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder; e.g. &amp;quot;tasks&amp;quot;, &amp;quot;calendar&amp;quot;, &amp;quot;contacts&amp;quot;, &amp;quot;infostore&amp;quot;, or &amp;quot;mail&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| 306 || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 313 || capabilities || Number || Bit mask containing information about mail folder capabilites, as described in [[#Capabilities | capabilities]].&lt;br /&gt;
|-&lt;br /&gt;
| 314 || subscribed || Boolean || Indicates whether this folder should appear in folder tree or not.&lt;br /&gt;
|-&lt;br /&gt;
| 315 || subscr_subflds || Boolean || Indicates whether subfolders should appear in folder tree or not.&lt;br /&gt;
|-&lt;br /&gt;
| 316 || standard_folder_type || Number || Indicates the default folder type. Zero for non-default folder. See [[#DefaultTypes | Standard folder types]]&lt;br /&gt;
|-&lt;br /&gt;
| 3010 || com.openexchange.publish.publicationFlag || Boolean || Indicates whether this folder is published. Read Only, provided by the com.openexchange.publish plugin, since 6.14.&lt;br /&gt;
|-&lt;br /&gt;
| 3020 || com.openexchange.subscribe.subscriptionFlag || Boolean || Indicates whether this folder has subscriptions storing their content in this folder. Read Only, provided by the com.openexchange.subscribe plugin, since 6.14.&lt;br /&gt;
|-&lt;br /&gt;
| 3030 || com.openexchange.folderstorage.displayName || String || Provides the display of the folder&#039;s owner. Read Only, Since 6.20.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-6 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder. &#039;&#039;&#039;Note&#039;&#039;&#039;: &#039;&#039;&#039;Does not apply to folders of module &#039;&#039;system&#039;&#039;&#039;&#039;&#039;.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || All permissions. This is currently the same as &amp;quot;Create subfolders&amp;quot; but in the future additional permissions may be added that will be given to the user when using this value.&lt;br /&gt;
|}&lt;br /&gt;
The values are scalars and not bit sets. Any other than the described values should not be used. If they are used expect an exception from the backend. Every value automatically contains the access rights covered by lower values.&amp;lt;br&amp;gt;&#039;&#039;&#039;NOTE&#039;&#039;&#039;: &#039;&#039;Create objects in the folder&#039;&#039; is not covered by &#039;&#039;Create subfolders&#039;&#039; if folder&#039;s module is &#039;&#039;system&#039;&#039;.&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || All permissions. This is currently the same as &amp;quot;Read all objects&amp;quot; but in the future additional permissions may be added that will be given to the user when using this value.&lt;br /&gt;
|}&lt;br /&gt;
The values are scalars and not bit sets. Any other than the described values should not be used. If they are used expect an exception from the backend. Every value automatically contains the access rights covered by lower values.&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || All permissions. This is currently the same as &amp;quot;Modify all objects&amp;quot; but in the future additional permissions may be added that will be given to the user when using this value.&lt;br /&gt;
|}&lt;br /&gt;
The values are scalars and not bit sets. Any other than the described values should not be used. If they are used expect an exception from the backend. Every value automatically contains the access rights covered by lower values.&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || All permissions. This is currently the same as &amp;quot;Delete all objects&amp;quot; but in the future additional permissions may be added that will be given to the user when using this value.&lt;br /&gt;
|}&lt;br /&gt;
The values are scalars and not bit sets. Any other than the described values should not be used. If they are used expect an exception from the backend. Every value automatically contains the access rights covered by lower values.&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Every operation modifying the folder in some way requires this permission. This are e.g. changing the folder name, modifying the permissions, deleting or moving the folder.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Capabilities&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Capabilities&lt;br /&gt;
! Bit  !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 0 || Mailing system supports permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Mailing system supports ordering mails by their thread reference.&lt;br /&gt;
|-&lt;br /&gt;
| 2 || Mailing system supports quota restrictions.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Mailing system supports sorting.&lt;br /&gt;
|-&lt;br /&gt;
| 4 || Mailing system supports folder subscription.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DefaultTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Standard Folder Types&lt;br /&gt;
! Bit  !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 0 || No default folder.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Task.&lt;br /&gt;
|-&lt;br /&gt;
| 2 || Calendar.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Contact.&lt;br /&gt;
|-&lt;br /&gt;
| 7 || Inbox.&lt;br /&gt;
|-&lt;br /&gt;
| 8 || Infostore.&lt;br /&gt;
|-&lt;br /&gt;
| 9 || Drafts.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Sent.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || Spam.&lt;br /&gt;
|-&lt;br /&gt;
| 12 || Trash.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;all&amp;lt;/code&amp;gt; – Set to &amp;lt;code&amp;gt;1&amp;lt;/code&amp;gt; to list even not subscribed folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowed_modules&amp;lt;/code&amp;gt; – An array of modules (either numbers or strings; e.g. &amp;quot;tasks,calendar,contacts,mail&amp;quot;) supported by requesting client. If missing, all available modules are considered.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowed_modules&amp;lt;/code&amp;gt; – (Preliminary) An array of modules (either numbers or strings; e.g. &amp;quot;tasks,calendar,contacts,mail&amp;quot;) supported by requesting client. If missing, all available modules are considered.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowed_modules&amp;lt;/code&amp;gt; – (Preliminary) An array of modules (either numbers or strings; e.g. &amp;quot;tasks,calendar,contacts,mail&amp;quot;) supported by requesting client. If missing, all available modules are considered.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders (should the &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; parameter be ever implemented) would be identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowed_modules&amp;lt;/code&amp;gt; – (Preliminary) An array of modules (either numbers or strings; e.g. &amp;quot;tasks,calendar,contacts,mail&amp;quot;) supported by requesting client. If missing, all available modules are considered.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id is not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowed_modules&amp;lt;/code&amp;gt; – (Preliminary) An array of modules (either numbers or strings; e.g. &amp;quot;tasks,calendar,contacts,mail&amp;quot;) supported by requesting client. If missing, all available modules are considered.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;folder_id&amp;lt;/code&amp;gt; – The parent folder of the newly created folder&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowed_modules&amp;lt;/code&amp;gt; – (Preliminary) An array of modules (either numbers or strings; e.g. &amp;quot;tasks,calendar,contacts,mail&amp;quot;) supported by requesting client. If missing, all available modules are considered.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id should not be present.&lt;br /&gt;
&lt;br /&gt;
Provided that permission is granted to create a folder, its module is bound to the limitation, that the new folder&#039;s module must be equal to parent folder&#039;s module except that:&lt;br /&gt;
* Parent folder is one of the system folders &amp;lt;code&amp;gt;private&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;public&amp;lt;/code&amp;gt;, or &amp;lt;code&amp;gt;shared&amp;lt;/code&amp;gt;. Below these folders task, calendar, and contact modules are permitted.&lt;br /&gt;
* Parent folder&#039;s module is one of task, calendar, or contact. Below this kind of folders task, calendar, and contact modules are permitted.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowed_modules&amp;lt;/code&amp;gt; – (Preliminary) An array of modules (either numbers or strings; e.g. &amp;quot;tasks,calendar,contacts,mail&amp;quot;) supported by requesting client. If missing, all available modules are considered. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the folders that shall be deleted.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders that were &#039;&#039;&#039;NOT&#039;&#039;&#039; deleted. There may be a lot of different causes for a not deleted folder: A folder has been modified in the mean  time, the user does not have the permission to delete it or those permissions have just been removed, the folder does not exist, etc.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content  ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=clear&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowed_modules&amp;lt;/code&amp;gt; – (Preliminary) An array of modules (either numbers or strings; e.g. &amp;quot;tasks,calendar,contacts,mail&amp;quot;) supported by requesting client. If missing, all available modules are considered.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
=== Get all visible folder of a certain module  (since v6.18.2)  ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=allVisible&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; – The desired content type (either numbers or strings; e.g. &amp;quot;tasks&amp;quot;, &amp;quot;calendar&amp;quot;, &amp;quot;contacts&amp;quot;, &amp;quot;mail&amp;quot;)&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; –  A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
&lt;br /&gt;
Request body: None&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: A JSON object containing three fields: &amp;quot;private&amp;quot;, &amp;quot;public, and &amp;quot;shared&amp;quot;. Each field is a JSON array with data for all folders. Each folder is itself described by an array.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number or Time || Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for &amp;quot;no alarm&amp;quot;). For tasks, the Time value specifies the absolute time when the user should be notified.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 210 || change_exceptions                     || Array       || An array of Dates, representing all change exceptions of a sequence.&lt;br /&gt;
|-&lt;br /&gt;
| 211 || delete_exceptions                     || Array       || An array of Dates, representing all delete exceptions of a sequence.&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Inclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user, group or booked resource as described in [[#Participant | participant table]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|-&lt;br /&gt;
| 222 || occurrences || Number || Specifies how often a recurrence should appear. May be present only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 223 || uid || String || Can only be written when the object is created. Internal and external globally unique identifier of the appointment. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID. Not implemented for tasks.&lt;br /&gt;
|-&lt;br /&gt;
| 224 || organizer || String || Contains the email address of the appointment organizer which is not necessarily an internal user. Not implemented for tasks.&lt;br /&gt;
|-&lt;br /&gt;
| 225 || sequence || Number || iCal sequence number. Not implemented for tasks. Must be incremented on update. Will be incremented by the server, if not set.&lt;br /&gt;
|-&lt;br /&gt;
| 226 || confirmations || Array || Each element represents a confirming participant as described in [[#ConfirmingParticipant | confirming participant]]. This can be internal and external user. Not implemented for tasks.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Participant&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{|&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|-&lt;br /&gt;
| 5 || external user&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| mail || String || mail address of an external participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID. Confirming for other users only works for appointments and not for tasks.&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ConfirmingParticipant&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Confirming participant&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{|&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 5 || external user&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| mail || String || email address of external participant&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || display name of external participant&lt;br /&gt;
|-&lt;br /&gt;
| status || Number ||&lt;br /&gt;
{|&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete || Date || Deprecated. Only present in AJAX interface. Value will not be stored on OX server.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority || Number || 1 = LOW, 2 = MEDIUM, 3 = HIGH&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks (should the &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; parameter be ever implemented) would be identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the task&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder Identifier through that the task is accessed. This is necessary for checking the permissions.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object with attributes described in [[#SearchTasks | Search tasks]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchTasks&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search tasks&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find tasks. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || (optional) Defines the folder to search for tasks in. If this is omitted in all task folders will be searched.&lt;br /&gt;
|-&lt;br /&gt;
| start || Date or Time || (optional) Inclusive start date for a time range the tasks should end in. If start is omitted end is ignored.&lt;br /&gt;
|-&lt;br /&gt;
| end || Date or Time || (optional) Exclusive end date for a time range the tasks should end in. If this parameter is omitted the time range has an open end.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with matching tasks. Tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;collation&amp;lt;/code&amp;gt; (preliminary, since 6.20) – allows you to specify a collation to sort the contacts by. As of 6.20, only supports &amp;quot;gbk&amp;quot; and &amp;quot;gb2312&amp;quot;, not needed for other languages. Parameter &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; should be set for this to work.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home || String&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status || String&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children || String&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type  || String&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number || String&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business || String&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees || String&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume || String&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other || String&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1 || String&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01 || String&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02 || String&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03 || String&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04 || String&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05 || String&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06 || String&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07 || String&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08 || String&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09 || String&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10 || String&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11 || String&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12 || String&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13 || String&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14 || String&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15 || String&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16 || String&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17 || String&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18 || String&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19 || String&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20 || String || Contains a UUID if one was assigned (after 6.18.2)&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]]. &#039;&#039;&#039;deprecated&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distribution_list || Number&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links || Number || &#039;&#039;&#039;deprecated&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || number_of_images || Number&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified || Timestamp&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other || String&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as || String&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type || String&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist || Boolean&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address || Number&lt;br /&gt;
|-&lt;br /&gt;
| 606 ||                             || image1_url || String&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid || Number&lt;br /&gt;
|-&lt;br /&gt;
| 608 ||                             || useCount || Number || In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.&lt;br /&gt;
|-&lt;br /&gt;
| 610 ||                             || yomiFirstName || String || Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues. (since 6.20)&lt;br /&gt;
|-&lt;br /&gt;
| 611 ||                             || yomiLastName || String || Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues. (since 6.20)&lt;br /&gt;
|-&lt;br /&gt;
| 612 ||                             || yomiCompany || String || Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues. (since 6.20)&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID of the member&#039;s contact if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with objects. Each object contains fields “id” and “folder” of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=listuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with id&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
Available with SP4&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts (should the &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; parameter be ever implemented) would be identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the contact&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Get contact by user ID ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – User ID (not Object ID) of the requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. &lt;br /&gt;
&lt;br /&gt;
Available with SP4 package.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder identifier through that the contact is accessed. This is necessary for checking the permissions.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
To remove some contact image send the image attribute set to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
To change or add some contact image the PUT command must be replaced with a POST command and all data must be provided within a &amp;lt;code&amp;gt;multipart/form-data&amp;lt;/code&amp;gt; body. The normal request body must be placed into a form field named &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; while the image file must be placed in a file field named &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt;. The response is then an HTML page as described in section [[#File_uploads | File uploads]].&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
To add some contact image the PUT command must be replaced with a POST command and all data must be provided within a &amp;lt;code&amp;gt;multipart/form-data&amp;lt;/code&amp;gt; body. The normal request body must be placed into a form field named &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; while the image file must be placed in a file field named &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt;. The response is then an HTML page as described in section [[#File uploads | File uploads]].&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. In case of use of column 609 (use count depending order for collected contacts with global address book) the parameter &amp;quot;order&amp;quot; ist NOT necessary and will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;collation&amp;lt;/code&amp;gt; (preliminary, since 6.20) – allows you to specify a collation to sort the contacts by. As of 6.20, only supports &amp;quot;gbk&amp;quot; and &amp;quot;gb2312&amp;quot;, not needed for other languages. Parameter &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; should be set for this to work.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter. If this field is present, the pattern is matched against the contact field which is specified by the property contact_first_letter_field on the server (default: last name). Otherwise, the pattern is matched against the display name.&lt;br /&gt;
|-&lt;br /&gt;
| folder || Array of Number || If a list of folder identifiers or at least a single folder identifier is given, only in that folders will be searched for contacts. This paramenter is optional but searching in all contact folders that are viewable and where objects can be read in is more expensive on that database than searching in a dedicated number of them. The possibility to provide here an array of folder identifier has been added with 6.10.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Alternative request body: An Object as described in [[#SearchContactsAlternative | Search contacts alternative]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContactsAlternative&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts alternative&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| email1 || String || Searches contacts where the email1 address match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| email2 || String || Searches contacts where the email2 address match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| email3 || String || Searches contacts where the email3 address match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| categories || String || Searches contacts where the categories match with the given search pattern. &lt;br /&gt;
|-&lt;br /&gt;
| orSearch || Boolean || If set to true, the fields are connected through an OR search habit.&lt;br /&gt;
|-&lt;br /&gt;
| emailAutoComplete || Boolean || If set to true, results are guaranteed to contain at least one email adress and the search is performed by connecting the relevant fields through an OR search habit.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts by filter (since 6.20) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=advancedSearch&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. &lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;collation&amp;lt;/code&amp;gt; (preliminary, since 6.20) – allows you to specify a collation to sort the contacts by. As of 6.20, only supports &amp;quot;gbk&amp;quot; and &amp;quot;gb2312&amp;quot;, not needed for other languages. Parameter &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; should be set for this to work.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchFilter | Search Filter]]&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Associate two contacts (Since 6.18.1, Preliminary) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=associate&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* uuid1: The UUID of the first contact (not needed if you use folder and id instead)&lt;br /&gt;
* folder1: ID of the folder the first contact is in (not needed if you use UUID)&lt;br /&gt;
* id1: ID of the first contact (not needed if you use UUID)&lt;br /&gt;
* uuid2: The UUID of the second contact (not needed if you use folder and id instead)&lt;br /&gt;
* folder2: ID of the folder the second contact is in (not needed if you use UUID)&lt;br /&gt;
* id2: ID of the second contact (not needed if you use UUID) &lt;br /&gt;
&lt;br /&gt;
Response: None.&lt;br /&gt;
&lt;br /&gt;
=== Dissociate two contacts (Since 6.18.1, Preliminary) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=dissociate&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* uuid1: The UUID of the first contact (not needed if you use folder and id instead)&lt;br /&gt;
* folder1: ID of the folder the first contact is in (not needed if you use UUID)&lt;br /&gt;
* id1: ID of the first contact (not needed if you use UUID)&lt;br /&gt;
* uuid2: The UUID of the second contact (not needed if you use folder and id instead)&lt;br /&gt;
* folder2: ID of the folder the second contact is in (not needed if you use UUID)&lt;br /&gt;
* id2: ID of the second contact (not needed if you use UUID) &lt;br /&gt;
&lt;br /&gt;
Response: None.&lt;br /&gt;
&lt;br /&gt;
=== Get associated contacts of a contact (Since 6.18.1, Preliminary) ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getAssociated&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* uuid: The UUID of this contact (not needed if you use folder and id instead)&lt;br /&gt;
* folder: ID of the folder the contact is in (not needed if you use UUID)&lt;br /&gt;
* id: ID of the contact (not needed if you use UUID) &lt;br /&gt;
&lt;br /&gt;
Response: A JSON response with the data field containing an array with the UUID of every associated contact.&lt;br /&gt;
&lt;br /&gt;
=== Get association status of two contacts (Since 6.18.1, Preliminary) ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getAssociation&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
* uuid1: The UUID of the first contact (not needed if you use folder and id instead)&lt;br /&gt;
* folder1: ID of the folder the first contact is in (not needed if you use UUID)&lt;br /&gt;
* id1: ID of the first contact (not needed if you use UUID)&lt;br /&gt;
* uuid2: The UUID of the second contact (not needed if you use folder and id instead)&lt;br /&gt;
* folder2: ID of the folder the second contact is in (not needed if you use UUID)&lt;br /&gt;
* id2: ID of the second contact (not needed if you use UUID) &lt;br /&gt;
&lt;br /&gt;
Response: A JSON response with the data field containing the status as integer meaning the following:&lt;br /&gt;
* 1: not referring to the same person&lt;br /&gt;
* 2: the two contacts represent the same person&lt;br /&gt;
* 3: contacts have never been explicitly associated or dissociated &lt;br /&gt;
&lt;br /&gt;
=== Get contact by uuid (Since 6.18.1, Preliminary) ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getByUuid&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
* uuid: The UUID of this contact (not needed if you use folder and id instead)&lt;br /&gt;
* folder: ID of the folder the contact is in (not needed if you use UUID)&lt;br /&gt;
* id: ID of the contact (not needed if you use UUID) &lt;br /&gt;
&lt;br /&gt;
Response: A JSON response with the data field containing the full contact data of every single associated contact.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which start on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which end before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
* &amp;lt;code&amp;gt;showPrivate&amp;lt;/code&amp;gt; (optional) – only works in shared folders: When enabled, shows private appointments of the folder owner. Such appointments are anonymized by stripping away all information except start date, end date and recurrence information (since 6.18)&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 408 || timezone    || String  || Timezone&lt;br /&gt;
|-&lt;br /&gt;
| 410 || recurrence_start    || Date  || Start of a sequence without time&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client. &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days. Each entry in the array corresponds with one day in the range that was queried, explaining whether there is an appointment on this day or not.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with full object IDs (folder, id and optionally either recurrence_position or recurrence_date_position) of requested appointments.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
* &amp;lt;code&amp;gt;showPrivate&amp;lt;/code&amp;gt; (optional) – only works in shared folders: When enabled, shows private appointments of the folder owner. Such appointments are anonymized by stripping away all information except start date, end date and recurrence information (since 6.18)&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments (should the &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; parameter be ever implemented) would be identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_position&amp;lt;/code&amp;gt; (optional) – Recurrence Position requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the appointment&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: If the appointment was created successfully, an object with the attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created appointment. If the appointment could not be created due to conflicts, the response body is an object with the field &amp;lt;code&amp;gt;conflicts&amp;lt;/code&amp;gt;, which is an array of appointment objects which caused the conflict. Each appointment object which represents a resource conflict contains an additional field &amp;lt;code&amp;gt;hard_conflict&amp;lt;/code&amp;gt; with the Boolean value true. If the user does not have read access to a conflicting appointment, only the fields &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;start_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;end_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;shown_as&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; are present and the field &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; contains only the participants which caused the conflict.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Confirm appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the appointment to confirm.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through which the appointment is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirmed appointment.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot;, &amp;quot;confirmmessage&amp;quot; and &amp;quot;id&amp;quot; (optional) as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource (1 for users, 3 for resources)&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| folder_id || String || Folder ID. Only set, if the user has the right to see the object. (added 2009-08-18/6.12) &lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find appointments. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search appointments with the given starting letter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get new appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/appointments?action=newappointments&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;limit&amp;lt;/code&amp;gt; – limits the number of returned object to the given value.&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Resolve UID ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=resolveuid&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;uid&amp;lt;/code&amp;gt; – The UID to be resolved.&lt;br /&gt;
&lt;br /&gt;
Response: An object object with the field &amp;quot;id&amp;quot; containing the ox-object id, if existing, an error message otherwise.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number || Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 1 and 10 (inclusive).&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a two-element array specifying one sender. The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt; values.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a two-element array (see the from field) specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a two-element array (see the from field) specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a two-element array (see the from field) specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|-&lt;br /&gt;
| 256 || forwarded&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 2   || High&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 615  || msg_ref                 || String  || Message reference on reply/forward.&lt;br /&gt;
|-&lt;br /&gt;
| 651  || flag_seen                 || String  || Special field to sort mails by seen status&lt;br /&gt;
|-&lt;br /&gt;
| 652  || account_name                 || String  || Message&#039;s account name.&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Array  || An array with user-defined flags as strings.&lt;br /&gt;
|-&lt;br /&gt;
|     || headers                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt; Supported values for &amp;lt;code&amp;gt;col&amp;lt;/code&amp;gt; are 603 to 607 (from, to, cc, bcc and subject) and -1 for full text search.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;headers&amp;lt;/code&amp;gt; - (preliminary) A comma-separated list of header names. Each name requests denoted header from each mail&lt;br /&gt;
&lt;br /&gt;
Request body: An array with one object for each requested mail. Each object contains the fields &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter followed by requested headers.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;message_id&amp;lt;/code&amp;gt; – (Preliminary) The value of &amp;quot;Message-Id&amp;quot; header of the requested mail. This parameter is a substitute for &amp;quot;id&amp;quot; parameter.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Note&#039;&#039;&#039;: If neither parameter &amp;quot;&amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt;&amp;quot; nor parameter &amp;quot;&amp;lt;code&amp;gt;message_id&amp;lt;/code&amp;gt;&amp;quot; is specified, all folder&#039;s messages are updated accordingly. Available with v6.20.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail as described in [[#UpdateMail | Update mail]] or [[#UpdateMailExtended | Update mail extended]] (available with SP6 v6.10).&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object containing the Object ID of the updated mail and its folder.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UpdateMail&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Update mail&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| color_label || Number || The color number between 1 and 10.&lt;br /&gt;
|-&lt;br /&gt;
| flags || Number || A set of flags to add or remove. Note: Flags for &amp;quot;recent&amp;quot; (8) and &amp;quot;user&amp;quot; (64) are ignored.&lt;br /&gt;
|-&lt;br /&gt;
| value || Boolean || &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; to add the flags specified by &amp;lt;code&amp;gt;flags&amp;lt;/code&amp;gt; (logical OR), &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt; to remove them (logical AND with the inverted value).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UpdateMailExtended&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Update mail extended (available with SP6 v6.10)&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| set_flags || Number || A set of flags to add. Note: Flags for &amp;quot;recent&amp;quot; (8) and &amp;quot;user&amp;quot; (64) are ignored.&lt;br /&gt;
|-&lt;br /&gt;
| clear_flags || Number || A set of flags to remove. Note: Flags for &amp;quot;recent&amp;quot; (8) and &amp;quot;user&amp;quot; (64) are ignored.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;message_id&amp;lt;/code&amp;gt; – (Preliminary) The value of &amp;quot;Message-Id&amp;quot; header of the requested mail. This parameter is a substitute for &amp;quot;id&amp;quot; parameter.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the mail&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) – 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
* &amp;lt;code&amp;gt;view&amp;lt;/code&amp;gt; (optional - available with SP4)&lt;br /&gt;
** &amp;quot;raw&amp;quot; returns the content as it is, meaning no preparation are performed and thus no guarantee for safe contents is given (available with SP6 v6.10).&lt;br /&gt;
** &amp;quot;text&amp;quot; forces the server to deliver a text-only version of the requested mail&#039;s body, even if content is HTML.&lt;br /&gt;
** &amp;quot;textNoHtmlAttach&amp;quot; is the same as &amp;quot;text&amp;quot;, but does not deliver the HTML part as attachment in case of multipart/alternative content.&lt;br /&gt;
** &amp;quot;html&amp;quot; to allow a possible HTML mail body being transferred as it is (but white-list filter applied).&lt;br /&gt;
** &amp;quot;noimg&amp;quot; to allow a possible HTML content being transferred but without original image src attributes which references external images: Can be used to prevent loading external linked images (spam privacy protection).&lt;br /&gt;
** &#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;unseen&amp;lt;/code&amp;gt; (optional) – &amp;quot;1&amp;quot; or &amp;quot;true&amp;quot; to leave an unseen mail as unseen although its content is requested&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get multiple mails as a ZIP file ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=zip_messages&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The folder identifier.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; –  A comma-separated list of Object IDs of the requested mails&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the ZIP file.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The folder identifier.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment &#039;&#039;&#039;OR&#039;&#039;&#039;&lt;br /&gt;
* &amp;lt;code&amp;gt;cid&amp;lt;/code&amp;gt; – Value of header &#039;Content-ID&#039; of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
* &amp;lt;code&amp;gt;filter&amp;lt;/code&amp;gt; (optional) – 1 to apply HTML white-list filter rules if and only if requested attachment is of MIME type &amp;lt;code&amp;gt;text/htm*&amp;lt;/code&amp;gt; &#039;&#039;&#039;AND&#039;&#039;&#039; parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
=== Get multiple mail attachments as a ZIP file ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=zip_attachments&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The folder identifier.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachments.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – A comma-separated list of IDs of the requested attachments&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the ZIP file.&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
==== Attach data sources ====&lt;br /&gt;
Moreover the JSON representation may contain data sources which should be appended as file attachments to the mail. Then the mail contains the &amp;lt;code&amp;gt;&amp;quot;datasources&amp;quot;&amp;lt;/code&amp;gt; key which is expected to be a JSON array of data source descriptions.&lt;br /&gt;
&lt;br /&gt;
A data source description follows the [[#Module_.22conversion.22_.28preliminary.29 | conversion specification]].&lt;br /&gt;
&lt;br /&gt;
For example to attach a file through an URL the field looks like this (available with v6.18.2):&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
 &amp;quot;from&amp;quot;: &amp;quot;someone@somewhere.com,&lt;br /&gt;
 ...&lt;br /&gt;
 &amp;quot;datasources&amp;quot;&lt;br /&gt;
 [&lt;br /&gt;
  {&lt;br /&gt;
   &amp;quot;identifier&amp;quot;: &amp;quot;com.openexchange.url.mail.attachment&amp;quot;,&lt;br /&gt;
   &amp;quot;args&amp;quot;:&lt;br /&gt;
    {&lt;br /&gt;
     &amp;quot;url&amp;quot;: &amp;lt;url-string&amp;gt;,&lt;br /&gt;
     &amp;quot;timeout&amp;quot;: &amp;lt;optional-timeout-millis-int, default is 2500msec&amp;gt;,&lt;br /&gt;
     &amp;quot;contentType&amp;quot;: &amp;lt;optional-content-type-string&amp;gt;,&lt;br /&gt;
     &amp;quot;charset&amp;quot;: &amp;lt;optional-charset-string&amp;gt;,&lt;br /&gt;
     &amp;quot;size&amp;quot;: &amp;lt;optional-size-int&amp;gt;,&lt;br /&gt;
     &amp;quot;disposition&amp;quot;: &amp;lt;optional-disposition-string&amp;gt;,&lt;br /&gt;
     &amp;quot;fileName&amp;quot;: &amp;lt;optional-file-name-string&amp;gt;,&lt;br /&gt;
    }&lt;br /&gt;
  }&lt;br /&gt;
 ]&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
=== Send/Save mail as MIME data block (RFC822) (added in SP5) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; - A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) - In case the mail should not be sent out, but saved in a specific folder, the &amp;quot;folder&amp;quot; parameter can be used. If the mail should be sent out to the recipient, the &amp;quot;folder&amp;quot; parameter must not be included and the mail is stored in the folder &amp;quot;Sent Items&amp;quot;. Example &amp;quot;folder=default.INBOX/Testfolder&amp;quot;&lt;br /&gt;
* &amp;lt;code&amp;gt;flags&amp;lt;/code&amp;gt; (optional) - In case the mail should be stored with status &amp;quot;read&amp;quot; (e.g. mail has been read already in the client inbox), the parameter &amp;quot;flags&amp;quot; has to be included. If no &amp;quot;folder&amp;quot;  parameter is specified, this parameter must not be included. For infos about mail flags see [[#DetailedMailData | Detailed mail data]] spec.&lt;br /&gt;
 &lt;br /&gt;
Request Body: The MIME Data Block&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created/moved mail.&lt;br /&gt;
&lt;br /&gt;
=== Import of mails as MIME data block (RFC822) (added with 6.18) ===&lt;br /&gt;
&lt;br /&gt;
This request can be used to store a single or a lot of mails in the OX mail storage backend. This action should be used instead of &amp;lt;code&amp;gt;action=new&amp;lt;/code&amp;gt; because it is faster and tolerant to 8bit encoded emails.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;POST /ajax/mail?action=import&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; - A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - For the import this parameter is required to specify the folder into that the emails should be imported. Example &amp;quot;folder=default.INBOX/Testfolder&amp;quot;&lt;br /&gt;
* &amp;lt;code&amp;gt;flags&amp;lt;/code&amp;gt; (optional) - In case the mail should be stored with status &amp;quot;read&amp;quot; (e.g. mail has been read already in the client inbox), the parameter &amp;quot;flags&amp;quot; has to be included. For infos about mail flags see [[#DetailedMailData | Detailed mail data]] spec.&lt;br /&gt;
*&amp;lt;code&amp;gt;force&amp;lt;/code&amp;gt; (optional) - If this parameter is set to true, the server skips checking the valid From-address&lt;br /&gt;
 &lt;br /&gt;
Request Body: A multipart/form-data with a single or multiple file parts each having a different name and containing the RFC822 encoded email as binary data like in a file upload.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object containing the folder identifier and the object identifier of the imported mail or a JSON array of those JSON objects if multiple mails are imported.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&amp;lt;br&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&amp;lt;br&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&amp;lt;br&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;view&amp;lt;/code&amp;gt; (optional - available with SP6) - &amp;quot;text&amp;quot; forces the server to deliver a text-only version of the requested mail&#039;s body, even if content is HTML. &amp;quot;html&amp;quot; to allow a possible HTML mail body being transferred as it is (but white-list filter applied).&#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array of objects providing folder IDs and object IDs of the deleted mails.&lt;br /&gt;
&amp;lt;code&amp;gt;&amp;lt;br&amp;gt;&lt;br /&gt;
[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;{&amp;amp;nbsp;&amp;amp;quot;folder&amp;amp;quot;:&amp;amp;quot;default0/INBOX&amp;amp;quot;,&amp;amp;nbsp;&amp;amp;quot;id&amp;amp;quot;:&amp;amp;quot;123&amp;amp;quot;&amp;amp;nbsp;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;...&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;{&amp;amp;nbsp;&amp;amp;quot;folder&amp;amp;quot;:&amp;amp;quot;default0/MyFolder&amp;amp;quot;,&amp;amp;nbsp;&amp;amp;quot;id&amp;amp;quot;:&amp;amp;quot;134&amp;amp;quot;&amp;amp;nbsp;}&amp;lt;br&amp;gt;&lt;br /&gt;
]&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Clear mail folder(s) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=clear&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with IDs of the mail folders to clear&lt;br /&gt;
&lt;br /&gt;
Response: An array with IDs of mail folder that could not be cleared; meaning the response body is an empty JSON array if everything went well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: A group object as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
=== List groups ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with group identifiers.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
=== Search for groups ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#GroupSearch | Group search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array of group objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group data&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| name         || String || Name with character restrictions&lt;br /&gt;
|-&lt;br /&gt;
| members       || Array  || The array contains identifier of users that are member of the group.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Create a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created group.&lt;br /&gt;
&lt;br /&gt;
=== Delete a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the group to delete.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id” containing the unique identifier of the group.&lt;br /&gt;
&lt;br /&gt;
Response: An empty json array if the group was deleted successfully.&lt;br /&gt;
&lt;br /&gt;
=== Change a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the group to update.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Time stamp of the group to update. If the group was modified after the specified time stamp, then the update must fail. &lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. Only modified fields are present and the field id is omitted.&lt;br /&gt;
&lt;br /&gt;
=== Get updates (since v6.18.1) ===&lt;br /&gt;
&lt;br /&gt;
introduced 2010-09-13&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested groups.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted groups. New, modified and deleted groups are represented by JSON objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get all resources ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource identifier.&lt;br /&gt;
&lt;br /&gt;
=== List resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Request body: An array with resources ids.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Create a resource ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Resource object as described in [[#ResourceResponse | Resource response]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: An object with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created resource.&lt;br /&gt;
&lt;br /&gt;
=== Delete a resource ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the resource to delete.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id” containing the unique identifier of the resource.&lt;br /&gt;
&lt;br /&gt;
Response: An empty json array if the resource was deleted successfully.&lt;br /&gt;
&lt;br /&gt;
=== Change a resource ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the resource to update.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Time stamp of the resource to update. If the resource was modified after the specified time stamp, then the update must fail. &lt;br /&gt;
&lt;br /&gt;
Request body: Resource object as described in [[#ResourceResponse | Resource response]]. Only modified fields are present and the field id is omitted.&lt;br /&gt;
&lt;br /&gt;
=== Get updates (since v6.18.1) ===&lt;br /&gt;
&lt;br /&gt;
introduced 2010-09-13&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested resources.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted resources. New, modified and deleted resources are represented by JSON objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document. Not yet implemented, so this is currently always empty.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise. . Note: This is not writeable&lt;br /&gt;
|-&lt;br /&gt;
| 711 || number_of_versions || Number || The number of all versions of the infoitem. Note: This is not writeable.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems (should the &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; parameter be ever implemented) would be identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the infoitem&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with [[]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with objects to delete. The fields for the object are described in [[#FullIdentifierForAnInfostoreDocument|Full identifier for an infostore document]]. &lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnInfostoreDocument&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an infostore document&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || Folder ID&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; (deprecated) ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments (should the &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; parameter be ever implemented) would be identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| servertime || Time || The time on the server&lt;br /&gt;
|-&lt;br /&gt;
| user_id || Number || The ID of the user.&lt;br /&gt;
|-&lt;br /&gt;
| last_modified || Time || The last modification timestamp of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| recurrence_position || Number || The recurrence position for series appointments or 0 if no series&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || The ID of the folder through that the object can be read&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Reminder===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/reminder?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
Response body: An JSON array with the id that was not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Remind again (since v6.18.1) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/reminder?action=remindAgain&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the reminder whose date shall be changed.&lt;br /&gt;
&lt;br /&gt;
Request body: The JSON representation of the reminder; mainly containing the field “alarm” which provides the new reminder date.&amp;lt;br&amp;gt;&lt;br /&gt;
E.g. &amp;lt;code&amp;gt;{ &amp;quot;alarm&amp;quot;: 1283418027381 }&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response body: The JSON representation of the updated reminder.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: A &amp;quot;multipart/form-data&amp;quot; encoded .CSV file. The field name for the file is &amp;quot;file&amp;quot;. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
* &amp;lt;code&amp;gt;suppressNotification&amp;lt;/code&amp;gt; – This optional parameter can be used to disable the notifications for new appointments that are imported through the given iCal file. This help keeping the Inbox clean if a lot of appointments need to be imported. The value of this parameter does not matter because only for the existence of the parameter is checked.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered, and warnings (under the key &amp;quot;warnings&amp;quot;) containing an Array of objects with the warning data, containing all customary error fields.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Calendar folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mailfilter&amp;quot; ==&lt;br /&gt;
The module mailfilter descriptes how to add, update or delete mail filter rules or to check which actions are supported by the underlying system.&lt;br /&gt;
&lt;br /&gt;
A detailed description can be found here [[ HTTP_API_MailFilter | Mail Filter HTTP API]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;ajax file upload&amp;quot; ==&lt;br /&gt;
This module offers to store files in server&#039;s dedicated download directory for a configureable amount of time. The files are then accessible for further operations like inline images in (html) mails&lt;br /&gt;
&lt;br /&gt;
=== Uploading a file ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/file?action=new&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The module for which the file is uploaded to determine proper upload quota constraints (e.g. &amp;quot;mail&amp;quot;, &amp;quot;infostore&amp;quot;, etc.).&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; – The file type filter to define which file types are allowed during upload. Currently supported filters are: &amp;lt;code&amp;gt;file=all, text=text/*, media=image OR audio OR video, image=image/*, audio=audio/*, video=video/*, application=application/*&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A common POST request body of MIME type &amp;quot;multipart/*&amp;quot; which holds the file(s) to upload&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of the uploaded files. The files are accessible through the returned IDs for future use.&lt;br /&gt;
&lt;br /&gt;
=== Updating a file&#039;s last access timestamp (keep alive) ===&lt;br /&gt;
By updating the last access timestamp it&#039;s prevented from being deleted from both session and disk storage.&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=keepalive&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file whose timestamp should be updated&lt;br /&gt;
&lt;br /&gt;
Response: The string &amp;quot;null&amp;quot; in response&#039;s data element&lt;br /&gt;
&lt;br /&gt;
=== Requesting a formerly uploaded file ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested file is directly written into output stream&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;image&amp;quot; ==&lt;br /&gt;
This module allows to download images from Open-Xchange server without providing a session ID in request&#039;s URL parameters.&lt;br /&gt;
&lt;br /&gt;
=== Requesting an image ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/image&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;uid&amp;lt;/code&amp;gt; – The unique ID referring to the desired image&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested image is directly written into output stream&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;conversion&amp;quot; (preliminary) ==&lt;br /&gt;
&lt;br /&gt;
A generic module to request data from a data source and to process obtained/submitted data with a data handler. Thus data is converted from a data source by a data handler.&lt;br /&gt;
&lt;br /&gt;
=== Converting data ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/conversion?action=convert&amp;lt;/code&amp;gt;&amp;lt;br&amp;gt;&lt;br /&gt;
or&amp;lt;br&amp;gt;&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/conversion?action=convert&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters: &amp;amp;lt;no parameters required&amp;amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A [[#ConversionRequest | conversion request]] JSON object containing nested JSON objects for [[#DataSource | data source]] and [[#DataHandler | data handler]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ConversionRequest&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Conversion request object&lt;br /&gt;
! Field      !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| datasource || JSON object || The data source object.&lt;br /&gt;
|-&lt;br /&gt;
| datahandler || JSON object || The data handler object.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSource&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data source object&lt;br /&gt;
! Field      !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| identifier || String || The identifier of the data source.&lt;br /&gt;
|-&lt;br /&gt;
| args || JSON array or JSON object || The &#039;&#039;&#039;optional&#039;&#039;&#039; name-value-pairs as a single JSON object or  a JSON object for each kept inside a JSON array for data source&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataHandler&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data handler object&lt;br /&gt;
! Field      !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| identifier || String || The identifier of the data handler.&lt;br /&gt;
|-&lt;br /&gt;
| args || JSON array or JSON object || The &#039;&#039;&#039;optional&#039;&#039;&#039; name-value-pairs as a single JSON object or  a JSON object for each kept inside a JSON array for data handler&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: The result of converted data ready as an appropriate JSON response&lt;br /&gt;
&lt;br /&gt;
==== Saving an ICal email attachment ====&lt;br /&gt;
&lt;br /&gt;
If an ICal file is attached to an email, its content can be saved as appointments and tasks into given calendar and task folder.&lt;br /&gt;
If the fields &amp;quot;com.openexchange.groupware.calendar.confirmstatus&amp;quot; and &amp;quot;com.openexchange.groupware.calendar.confirmmessage&amp;quot; are set, the data handler inserts the appointment with the given status for the user, if the appointment does not exist. If it is already existing, the handler just updates the participant status.&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.ical&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.fullname&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-fullname&amp;amp;gt;&amp;amp;quot;},&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.mailid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;mail-id&amp;amp;gt;&amp;amp;quot;},&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.sequenceid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;attachment-sequence-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.ical&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.groupware.calendar.folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;calendar-folder-id&amp;amp;gt;&amp;amp;quot;},&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&lt;br /&gt;
{&amp;amp;quot;com.openexchange.groupware.task.folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;task-folder-id&amp;amp;gt;&amp;amp;quot;},&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&lt;br /&gt;
{&amp;amp;quot;com.openexchange.groupware.calendar.confirmstatus&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;status&amp;amp;gt;&amp;amp;quot;},&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&lt;br /&gt;
{&amp;amp;quot;com.openexchange.groupware.calendar.confirmmessage&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;message&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array of JSON objects each providing folder and object ID of added appointment/task; e.g. &amp;lt;code&amp;gt;[{&amp;amp;quot;folder_id&amp;amp;quot;:2567, &amp;amp;quot;id&amp;amp;quot;:7689}, ...]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==== Converting an ICal email attachment into JSON objects ====&lt;br /&gt;
&lt;br /&gt;
If an ICal file is attached to an email, its content can converted to JSON appointments and tasks.&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.ical&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.fullname&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-fullname&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.mailid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;mail-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.sequenceid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;attachment-sequence-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object.&amp;lt;br&amp;gt;&lt;br /&gt;
&#039;&#039;&#039;Note&#039;&#039;&#039; that all arguments are optional: Default is user time zone and zero recurrence position&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;quot;com.openexchange.groupware.calendar.searchobject&amp;quot; triggers a search for the uid, and replaces the object_id and folder_id with the data of the corresponding ox-object id, if existing. The returned objects are still the ical objects and NOT the ox-objects.&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.ical.json&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.groupware.calendar.timezone&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;timezone-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&lt;br /&gt;
{&amp;amp;quot;com.openexchange.groupware.calendar.recurrencePosition&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;recurrence-position&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&lt;br /&gt;
{&amp;amp;quot;com.openexchange.groupware.calendar.searchobject&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;true|false&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array of JSON objects for each appointment/task as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]/[[##DetailedAppointmentData | Detailed appointment data]]&lt;br /&gt;
&lt;br /&gt;
==== Saving a VCard email attachment ====&lt;br /&gt;
&lt;br /&gt;
If a VCard file is attached to an email, its content can be saved as contacts into given contact folder.&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.vcard&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.fullname&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-fullname&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.mailid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;mail-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.sequenceid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;attachment-sequence-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.contact&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.groupware.contact.folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;contact-folder-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array of JSON objects each providing folder and object ID of added contact; e.g. &amp;lt;code&amp;gt;[{&amp;amp;quot;folder_id&amp;amp;quot;:2567, &amp;amp;quot;id&amp;amp;quot;:7689}, ...]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==== Contact(s) attached to a new email as a VCard file ====&lt;br /&gt;
&lt;br /&gt;
Obtain VCard data from specified contact object(s).&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.contact&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-id1&amp;amp;gt;&amp;amp;quot;,&amp;amp;quot;id&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;id1&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;...&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-idn&amp;amp;gt;&amp;amp;quot;,&amp;amp;quot;id&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;idn&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Get a new email&#039;s JSON object with specified VCard data source attached.&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.vcard&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:[]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A [[#DetailedMailData | mail]] JSON object.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;search&amp;quot; (preliminary) ==&lt;br /&gt;
&lt;br /&gt;
The search module is an enhancement to each search request as an optional JSON object via PUT method to filter elements; e.g.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
PUT /ajax/contacts?action=all&amp;amp;...&lt;br /&gt;
&lt;br /&gt;
{&amp;quot;filter&amp;quot;:{search-term-object}}&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This section describes the syntax of the optional JSON object representing the search term.&amp;lt;br&amp;gt;&lt;br /&gt;
In general the structure of a search term is in prefix notation; meaning the operator is written before its operands:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;operation&amp;quot;:&amp;quot;equals&amp;quot;,&amp;quot;operands&amp;quot;:[...]}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Moreover there are two different types of a search terms:&lt;br /&gt;
* A single search term&lt;br /&gt;
* A composite search term&lt;br /&gt;
&lt;br /&gt;
A single search term reflects an operation which cannot hold nested search terms as operands; e.g. &amp;quot;equals&amp;quot;. In opposite to this a composite search term holds one or more nested search terms as operands; e.g. &amp;quot;not&amp;quot; or the logical junctors &amp;quot;and&amp;quot;/&amp;quot;or&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
By now the following operations are supported:&lt;br /&gt;
* composite operations&lt;br /&gt;
** &amp;quot;and&amp;quot; - The AND junctor&lt;br /&gt;
** &amp;quot;or&amp;quot; - The OR junctor&lt;br /&gt;
** &amp;quot;not&amp;quot; - Negation&lt;br /&gt;
* single operations&lt;br /&gt;
** &amp;quot;equals&amp;quot; - Equals comparison&lt;br /&gt;
** &amp;quot;lt&amp;quot; - Less-than comparison&lt;br /&gt;
** &amp;quot;gt&amp;quot; - Greater-than comparison&lt;br /&gt;
&lt;br /&gt;
Furthermore following operand types are supported for single search terms:&lt;br /&gt;
* Column - Providing a name referring to a field/column&lt;br /&gt;
* Constant - A constant&lt;br /&gt;
&lt;br /&gt;
Example of an EQUALS search term:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;quot;operation&amp;quot;:&amp;quot;equals&amp;quot;,&amp;quot;operands&amp;quot;:[{&amp;quot;type&amp;quot;:&amp;quot;column&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;first_name&amp;quot;},&amp;quot;Jane&amp;quot;]}&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Example of an OR search term:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;quot;operation&amp;quot;:&amp;quot;or&amp;quot;,&amp;quot;operands&amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;{&amp;quot;operation&amp;quot;:&amp;quot;equals&amp;quot;,&amp;quot;operands&amp;quot;:[{&amp;quot;type&amp;quot;:&amp;quot;column&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;first_name&amp;quot;},&amp;quot;Jane&amp;quot;]},&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;{&amp;quot;operation&amp;quot;:&amp;quot;gt&amp;quot;,&amp;quot;operands&amp;quot;:[{&amp;quot;type&amp;quot;:&amp;quot;column&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;birthday&amp;quot;},&amp;quot;1975-05-01&amp;quot;]}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Refer to object data tables introduced by different modules to know which field names are supported; e.g. for tasks it is [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]], and [[#DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;search&amp;quot; (alternative suggestion, still preliminary) ==&lt;br /&gt;
&lt;br /&gt;
The search module is an enhancement to each search request as an optional JSON object via PUT method to filter elements; e.g.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
PUT /ajax/contacts?action=all&amp;amp;...&lt;br /&gt;
&lt;br /&gt;
{&amp;quot;filter&amp;quot;:&amp;lt;i&amp;gt;[search term]&amp;lt;/i&amp;gt;}&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This section describes the syntax of the optional JSON object representing the search term.&lt;br /&gt;
In general the structure of a search term is in prefix notation; meaning the operator is written before its operands:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;[&amp;quot;&amp;gt;&amp;quot;, 5, 2]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The available operators are:&lt;br /&gt;
* Comparison operators &amp;quot;&amp;gt;&amp;quot;, &amp;quot;&amp;lt;&amp;quot;, &amp;quot;=&amp;quot;, &amp;quot;&amp;lt;=&amp;quot;, &amp;quot;&amp;gt;=&amp;quot;, &amp;quot;&amp;lt;&amp;gt;&amp;quot;&lt;br /&gt;
* logic operators &amp;quot;not&amp;quot;, &amp;quot;and&amp;quot;, &amp;quot;or&amp;quot;&lt;br /&gt;
&lt;br /&gt;
Comparison operators have exactly two operands. Each operand can be either a field name or a constant. A field name is an object with the member &amp;quot;field&amp;quot; specifying the field name, e.g. &amp;lt;code&amp;gt;{ field: &amp;quot;first_name&amp;quot; }&amp;lt;/code&amp;gt;. The available field names depend on the searched module. Primitive JSON types are interpreted as constants. Arrays are not valid operands for comparison operators.&lt;br /&gt;
&lt;br /&gt;
The logic operator &amp;quot;not&amp;quot; has exactly one operand, the other logic operators can have any number of operands. Each operand must be an array representing a nested search expression.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail account&amp;quot; (available with v6.12) ==&lt;br /&gt;
&lt;br /&gt;
The mail account module is used to manage multiple mail accounts held by a user.&lt;br /&gt;
&lt;br /&gt;
=== Get All mail accounts  ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/account?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mail account&#039;s are defined in [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one mail account and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail account ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/account?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the account to return.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object representing the desired mail account. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MailAccountData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Mail account data&lt;br /&gt;
! ID    !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  1001   || id            || Number  || Account ID&lt;br /&gt;
|-&lt;br /&gt;
|  1002   ||  login    || String  || The login.&lt;br /&gt;
|-&lt;br /&gt;
|  1003   ||  password   || String  || The (optional) password.&lt;br /&gt;
|-&lt;br /&gt;
|  1004   ||  mail_url || String    || The mail server URL; e.g. &amp;quot;imap://imap.somewhere.com:143&amp;quot;. &#039;&#039;&#039;URL is preferred over single fields&#039;&#039;&#039; (like mail_server, mail_port, etc.)&lt;br /&gt;
|-&lt;br /&gt;
|  1005   ||  transport_url || String    || The transport server URL; e.g. &amp;quot;smtp://smtp.somewhere.com:25&amp;quot;. &#039;&#039;&#039;URL is preferred over single fields&#039;&#039;&#039; (like transport_server, transport_port, etc.)&lt;br /&gt;
|-&lt;br /&gt;
|   1006  ||  name || String    || Account&#039;s display name.&lt;br /&gt;
|-&lt;br /&gt;
|  1007   ||  primary_address || String    || User&#039;s primary address in account; e.g. &amp;quot;someone@somewhere.com&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|  1008   ||  spam_handler || String    || The name of the spam handler used by account.&lt;br /&gt;
|-&lt;br /&gt;
|   1009  ||  trash || String    || The name of the default trash folder.&lt;br /&gt;
|-&lt;br /&gt;
|  1010   ||  sent || String    || The name of the default sent folder.&lt;br /&gt;
|-&lt;br /&gt;
|   1011  ||  drafts || String    || The name of the default drafts folder.&lt;br /&gt;
|-&lt;br /&gt;
|  1012   ||  spam || String    || The name of the default spam folder.&lt;br /&gt;
|-&lt;br /&gt;
|  1013   ||  confirmed_spam || String    || The name of the default confirmed-spam folder.&lt;br /&gt;
|-&lt;br /&gt;
|   1014  || confirmed_ham || String    || The name of the default confirmed-ham folder.&lt;br /&gt;
|-&lt;br /&gt;
|   1015  ||  mail_server || String    || The mail server&#039;s hostname or IP address.&lt;br /&gt;
|-&lt;br /&gt;
|   1016  ||  mail_port || Number    || The mail server&#039;s port.&lt;br /&gt;
|-&lt;br /&gt;
|   1017  ||  mail_protocol || String    || The mail server&#039;s protocol. &#039;&#039;&#039;Always use basic protocol name.&#039;&#039;&#039; E.g. use &amp;quot;imap&amp;quot; instead of &amp;quot;imaps&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1018  ||  mail_secure || Boolean    || Whether to establish a secure connection to mail server (SSL, TLS).&lt;br /&gt;
|-&lt;br /&gt;
|   1019  ||  transport_server || String    || The transport server&#039;s hostname or IP address.&lt;br /&gt;
|-&lt;br /&gt;
|   1020  ||  transport_port || Number    || The transport server&#039;s port.&lt;br /&gt;
|-&lt;br /&gt;
|   1021  ||  transport_protocol || String    || The transport server&#039;s protocol. &#039;&#039;&#039;Always use basic protocol name.&#039;&#039;&#039; E.g. use &amp;quot;smtp&amp;quot; instead of &amp;quot;smtps&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1022  ||  transport_secure || Boolean    || Whether to establish a secure connection to transport server (SSL, TLS).&lt;br /&gt;
|-&lt;br /&gt;
|   1023  ||  transport_login || String    || The transport login. If empty &amp;quot;login&amp;quot; is taken as transport login as well.&lt;br /&gt;
|-&lt;br /&gt;
|   1024  ||  transport_password || String    || The transport password. If empty &amp;quot;password&amp;quot; is taken as transport password as well.&lt;br /&gt;
|-&lt;br /&gt;
|   1025  ||  unified_inbox_enabled || Boolean    || If enabled for Unified INBOX&lt;br /&gt;
|-&lt;br /&gt;
|   1026  ||  trash_fullname || String    || Path to default trash folder. Preferred over &amp;quot;trash&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1027  ||  sent_fullname || String    || Path to default sent folder. Preferred over &amp;quot;sent&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1028  ||  drafts_fullname || String    || Path to default drafts folder. Preferred over &amp;quot;drafts&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1029  ||  spam_fullname || String    || Path to default spam folder. Preferred over &amp;quot;spam&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1030  ||  confirmed_spam_fullname || String    || Path to default confirmed-spam folder. Preferred over &amp;quot;confirmed_spam&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1031  ||  confirmed_ham_fullname || String    || Path to default confirmed-ham folder. Preferred over &amp;quot;confirmed_ham&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1032  ||  pop3_refresh_rate || Number    || The interval in minutes the POP3 account is refreshed&lt;br /&gt;
|-&lt;br /&gt;
|   1033  ||  pop3_expunge_on_quit || Boolean    || Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not&lt;br /&gt;
|-&lt;br /&gt;
|   1034  ||  pop3_delete_write_through || Boolean    || If option &amp;quot;pop3_expunge_on_quit&amp;quot; is disabled, this property defines whether a delete in local INBOX also deletes affected message in actual POP3 account&lt;br /&gt;
|-&lt;br /&gt;
|   1035  ||  pop3_storage || String    || The name of POP3 storage provider, default is &amp;quot;mailaccount&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1036  ||  pop3_path || String    || Path to POP3&#039;s virtual root folder in storage, default is name of the POP3 account beside default folders&lt;br /&gt;
|-&lt;br /&gt;
|   1037  ||  personal || String    || The customizable personal part of email address&lt;br /&gt;
|-&lt;br /&gt;
|   1038  ||  reply_to || String    || The customizable reply-to email address&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Create a new mail account ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request: A JSON object describing the new account to create. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object representing the inserted mail account. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
=== Update a mail account ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request: A JSON object identifiying (field ID is present) and describing the account to update. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object representing the updated mail account. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
=== Delete a mail account ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ID of the mail account to delete.&lt;br /&gt;
&lt;br /&gt;
=== Validate a mail account (which shall be created) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=validate&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; - An optional boolean parameter which indicates whether on successful validation the folder tree shall be returned (NULL on failure) or if set to &amp;quot;false&amp;quot; or missing only a boolean is returned which indicates validation result&lt;br /&gt;
&lt;br /&gt;
Request: A JSON object describing the new account to validate. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: Dependent on optional &amp;quot;tree&amp;quot; parameter a JSON folder object or a boolean value indicating the validation result&lt;br /&gt;
&lt;br /&gt;
The JSON folder object corresponding to [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
Additionally a field &amp;quot;subfolder_array&amp;quot; is added which contains possible subfolders. This field is missing if a folder contains no subfolders.&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;user&amp;quot; (available with v6.14) ==&lt;br /&gt;
&lt;br /&gt;
The user module is used to access user information.&lt;br /&gt;
&lt;br /&gt;
=== Get all users ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/user?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for users are defined in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with user data. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedUserData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed user data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type       !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 610 || Aliases                     || aliases              || Array      || The user&#039;s aliases&lt;br /&gt;
|-&lt;br /&gt;
| 611 || Time zone                   || timezone             || String     || The time zone ID.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || Locale                      || locale               || String     || The name of user&#039;s entire locale, with the language, country and variant separated by underbars. E.g. &amp;quot;en&amp;quot;, &amp;quot;de_DE&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 613 || Groups                      || groups               || Array      || The IDs of user&#039;s groups&lt;br /&gt;
|-&lt;br /&gt;
| 614 || Contact ID                  || contact_id           || Number     || The contact ID of the user&lt;br /&gt;
|-&lt;br /&gt;
| 615 || Login info                  || login_info           || String     || The user&#039;s login information&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for users are defined in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of numbers. Each number is the ID of requested user. Since v6.18.1, a &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt; value in the array is interpreted as the currently logged in user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with user data. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a user ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/user?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested user. Since v6.18.1, this parameter is optional: the default is the currently logged in user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested user. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]].&lt;br /&gt;
&lt;br /&gt;
=== Update a user ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated user.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated user. If the user was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: User object as described in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Note&#039;&#039;&#039;: &amp;quot;timezone&amp;quot; and &amp;quot;locale&amp;quot; are the only fields from [[#DetailedUserData | Detailed user data]] which are allowed to be updated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An empty object.&lt;br /&gt;
&lt;br /&gt;
=== Search users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. In case of use of column 609 (use count depending order for collected users with global address book) the parameter &amp;quot;order&amp;quot; ist NOT necessary and will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchUsers | Search users]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchUsers&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search users&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find users. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search users with the given startletter. If this field is present, the pattern is matched against the user field which is specified by the property contact_first_letter_field on the server (default: last name). Otherwise, the pattern is matched against the display name.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Alternative request body: An Object as described in [[#SearchUsersAlternative | Search users alternative]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchUsersAlternative&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search users alternative&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches users where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches users where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches users where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| orSearch || Boolean || If set to true, the fields are connected through an OR search habit.&lt;br /&gt;
|-&lt;br /&gt;
| emailAutoComplete || Boolean || If set to true, results are guaranteed to contain at least one email adress and the search is performed by connecting the relevant fields through an OR search habit.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with user data. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get user attribute (available with v6.20) ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/user?action=getAttribute&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – ID of the user. &lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The attribute name. &lt;br /&gt;
&lt;br /&gt;
Response without timestamp: A JSON object providing name and value of the requested attribute&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 { &amp;quot;name&amp;quot;:&amp;quot;somename&amp;quot;, &amp;quot;value&amp;quot;:&amp;quot;somevalue&amp;quot;}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Set user attribute (available with v6.20) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=setAttribute&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – ID of the user. &lt;br /&gt;
* &amp;lt;code&amp;gt;setIfAbsent&amp;lt;/code&amp;gt; - Set to &amp;quot;true&amp;quot; to put the value only if the specified name is not already associated with a value, otherwise &amp;quot;false&amp;quot; to put value in any case&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON object providing name and value of the attribute. If the &amp;lt;code&amp;gt;&amp;quot;value&amp;quot;&amp;lt;/code&amp;gt; field id missing or NULL, the attribute is removed.&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 { &amp;quot;name&amp;quot;:&amp;quot;somename&amp;quot;, &amp;quot;value&amp;quot;:&amp;quot;somevalue&amp;quot;}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: The boolean value &amp;quot;true&amp;quot; if PUT was successful; otherwise &amp;quot;false&amp;quot;&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;OAuth&amp;quot; (available with v6.20) ==&lt;br /&gt;
&lt;br /&gt;
The OAuth module is used to manage multiple OAuth accounts for certian online services for a user. The OAuth mechanism allows the Open-Xchange application to act as behalf of this user using previously obtained access tokens granted by user.&lt;br /&gt;
&lt;br /&gt;
The OAuth interface is divided into two parts: Account access and service&#039;s meta data access.&lt;br /&gt;
&lt;br /&gt;
=== OAuth account access ===&lt;br /&gt;
&lt;br /&gt;
The OAuth service account access description.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
==== Get all OAuth accounts ====&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/oauth/accounts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;serviceId&amp;lt;/code&amp;gt; – The &amp;lt;b&amp;gt;optional&amp;lt;/b&amp;gt; service meta data identifier. If missing all accounts of all services are returned; otherwise all accounts of specified service are returned&lt;br /&gt;
&lt;br /&gt;
Response: An array with account data. Each array element is a JSON object describing an OAuth account as specified in [[#OAuthAccountData | OAuth account data]].&lt;br /&gt;
&lt;br /&gt;
==== Get an OAuth account ====&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/oauth/accounts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The account identifier.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object describing an OAuth account as specified in [[#OAuthAccountData | OAuth account data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;OAuthAccountData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | OAuth account&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || The numeric identifier of the OAuth account.&lt;br /&gt;
|-&lt;br /&gt;
| displayName || String || The account display name&lt;br /&gt;
|-&lt;br /&gt;
| serviceId     || String   || The identifier of the associated service meta data; e.g. &amp;lt;code&amp;gt;&amp;quot;com.openexchange.oauth.twitter&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| token    || String || The token&lt;br /&gt;
|-&lt;br /&gt;
| secret || String || The token secret&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
==== Delete an OAuth account ====&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/oauth/accounts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The account identifier.&lt;br /&gt;
&lt;br /&gt;
Response: The boolean value &amp;quot;true&amp;quot; if successful&lt;br /&gt;
&lt;br /&gt;
==== Update an OAuth account ====&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/oauth/accounts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The account identifier. May also be provided in request body&#039;s JSON OAuth account representation by &amp;lt;code&amp;gt;&amp;quot;id&amp;quot;&amp;lt;/code&amp;gt; field.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON object providing the OAuth account fields to update. See [[#OauthAccountData | OAuth account data]]. Currently the only values which make sende being updated are &amp;lt;code&amp;gt;&amp;quot;displayName&amp;quot;&amp;lt;/code&amp;gt; and the &amp;lt;code&amp;gt;&amp;quot;token&amp;quot;&amp;lt;/code&amp;gt;-&amp;lt;code&amp;gt;&amp;quot;secret&amp;quot;&amp;lt;/code&amp;gt;-pair.&lt;br /&gt;
&lt;br /&gt;
Response: The boolean value &amp;quot;true&amp;quot; if successful&lt;br /&gt;
&lt;br /&gt;
==== Initialize creation of an OAuth account ====&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/oauth/accounts?action=init&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;serviceId&amp;lt;/code&amp;gt; – The service meta data identifier; e.g. &amp;lt;code&amp;gt;&amp;quot;com.openexchange.oauth.twitter&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: An JSON representation of the resulting interaction providing needed information to complete account creation. See [[#OauthInteractionData | OAuth interaction data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;OauthInteractionData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | OAuth interaction&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| authUrl || String || The numeric identifier of the OAuth account.&lt;br /&gt;
|-&lt;br /&gt;
| type || String || The interaction type name; &amp;lt;code&amp;gt;&amp;quot;outOfBand&amp;quot;&amp;lt;/code&amp;gt; or &amp;lt;code&amp;gt;&amp;quot;callback&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| token    || String || The token&lt;br /&gt;
|-&lt;br /&gt;
| uuid || String || The UUID for this OAuth interaction&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
==== Create an OAuth account ====&lt;br /&gt;
&lt;br /&gt;
Note: This action is typically called by provided call-back URL and is ony intended for manual invocation if &amp;quot;outOfBand&amp;quot; interaction is returned by preceeding &amp;lt;code&amp;gt;/ajax/oauth/account?action=init&amp;lt;/code&amp;gt; step.&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/oauth/accounts?action=create&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module&lt;br /&gt;
* &amp;lt;code&amp;gt;oauth_token&amp;lt;/code&amp;gt; – The request token from preceeding OAuth interaction&lt;br /&gt;
* &amp;lt;code&amp;gt;uuid&amp;lt;/code&amp;gt; – The UUID of the preceeding OAuth interaction&lt;br /&gt;
* &amp;lt;code&amp;gt;oauth_verfifier&amp;lt;/code&amp;gt; – The verifier string which confirms that user granted access&lt;br /&gt;
* &amp;lt;code&amp;gt;displayName&amp;lt;/code&amp;gt; – The display name for the new account&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object describing the newly created OAuth account as specified in [[#OAuthAccountData | OAuth account data]].&lt;br /&gt;
&lt;br /&gt;
=== OAuth service meta data access ===&lt;br /&gt;
&lt;br /&gt;
The OAuth service meta data access description.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
==== Get all OAuth services&#039; meta data ====&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/oauth/services?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: An array with service data. Each array element is a JSON object describing an OAuth service&#039;s meta data as specified in [[#OAuthServiceMetaData | OAuth service meta data]].&lt;br /&gt;
&lt;br /&gt;
==== Get an OAuth service&#039;s meta data ====&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/oauth/services?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The service&#039;s identifier.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object describing an OAuth service&#039;s meta data as specified in [[#OAuthServiceMetaData | OAuth service meta data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;OAuthServiceMetaData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | OAuth service meta data&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || The numeric identifier of the OAuth account.&lt;br /&gt;
|-&lt;br /&gt;
| displayName || String || The account display name&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Messaging Services ==&lt;br /&gt;
&lt;br /&gt;
Messaging Services represent a messaging backend. The messaging services add a new folder module &amp;quot;messaging&amp;quot;. &lt;br /&gt;
&lt;br /&gt;
A *Messaging Service* Object has the following structure:&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MessagingService&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Messaging Service&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id            || String      || Identifies a messagingService. Usually a String in reverse domain name notation. Example: &amp;quot;com.openexchange.messaging.twitter&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| displayName   || String      || Human readable display name of the service. Example: &amp;quot;Twitter&amp;quot; &lt;br /&gt;
|-&lt;br /&gt;
| formDescription || Array      || A description for dynamic form fields. Same as in PubSub &lt;br /&gt;
|-&lt;br /&gt;
| messagingActions || Array     || An array of Strings a dynamic set of actions that are possible with messages of this service. Described in detail later on. &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The available JSON calls are:&lt;br /&gt;
&lt;br /&gt;
GET /ajax/messaging/service?action=all&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module. &lt;br /&gt;
   &lt;br /&gt;
Response: A standard response object containing an array of messaging service objects. &lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
GET /ajax/messaging/service?action=get&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module. &lt;br /&gt;
* id - The ID of the messaging service to load&lt;br /&gt;
&lt;br /&gt;
Response: A standard response object containing a messaging service object.&lt;br /&gt;
&lt;br /&gt;
== Messaging Accounts ==&lt;br /&gt;
&lt;br /&gt;
A messaging account represents the concrete configuration of an account of a given messaging service.&lt;br /&gt;
A *messaging account* has the following structure:&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MessagingService&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Messaging Account&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number      || Identifies a given messaging account. This is not writeable and is generated by the server &lt;br /&gt;
|-&lt;br /&gt;
| messagingService || String  || The messaging service id of the messaging service this account belongs to &lt;br /&gt;
|-&lt;br /&gt;
| displayName || String || User chosen String to identify a given account. Will also be translated into the folder name of the folder representing the accounts content &lt;br /&gt;
|-&lt;br /&gt;
| configuration || Object || Configuration data according to the formDescription of the relevant messagingService &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The available JSON calls are:&lt;br /&gt;
&lt;br /&gt;
PUT /ajax/messaging/account?action=new&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON Object describing the account to be created.&lt;br /&gt;
Response: A response object containing the new account id as its data.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
PUT /ajax/messaging/account?action=update&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON Object describing the update to the account. Note that the &amp;quot;id&amp;quot; and &amp;quot;messagingService&amp;quot; must always be set.&lt;br /&gt;
Response: A response object containing the number 1 as its data on success.&lt;br /&gt;
&lt;br /&gt;
GET /ajax/messaging/account?action=get&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module.&lt;br /&gt;
* messagingService - The messaging service id that the account belongs to&lt;br /&gt;
* id - An account ID to load&lt;br /&gt;
&lt;br /&gt;
Response: A response object containing the JSON Object representing the loaded account as its data.&lt;br /&gt;
&lt;br /&gt;
GET /ajax/messaging/account?action=delete&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module.&lt;br /&gt;
* messagingService - The messaging service id that the account belongs to&lt;br /&gt;
* id - An account ID to delete&lt;br /&gt;
&lt;br /&gt;
Response: A response object containing 1 as its data on success.&lt;br /&gt;
&lt;br /&gt;
GET /ajax/messaging/account?action=all&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module&lt;br /&gt;
* messagingService - (optional) list only those accounts that belong to the given messagingService.&lt;br /&gt;
 &lt;br /&gt;
Response: A response object containing a JSON array of account objects in its data section.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Messaging Messages ==&lt;br /&gt;
&lt;br /&gt;
A Messaging Message represents a single message. It consists of some metadata, headers and a content. The content attribute varies by the content-type header. &lt;br /&gt;
If the content type is text/* it is a string, if it is a multipart/* it is an array of objects, each representing a part of the multipart. If it is anything else&lt;br /&gt;
it is considered binary and is a Base64 encoded string (ToDo : This is not smart enough yet. I suppose we&#039;ll have to include encoding options for binaries much like in our EAVJSONProposal).&lt;br /&gt;
&lt;br /&gt;
The folder id of a message follows a predefined format:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
[messagingService]://[accountId]/[path]&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
for an imaginary example consider: &amp;quot;com.openexchange.messaging.twitter://535/defaultTimeline/directMessages&amp;quot;&lt;br /&gt;
&lt;br /&gt;
The structure of a Messaging Message is as follows:&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MessagingService&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Messaging Message&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
|id            ||String       || The id of this message. Only unique in the given folder. &lt;br /&gt;
|-&lt;br /&gt;
|folder        ||String       || The folder id. &lt;br /&gt;
|-&lt;br /&gt;
|threadLevel   ||Number       || The nesting level of this message according to the conversation it&#039;s belonged to. May not be set. &lt;br /&gt;
|-&lt;br /&gt;
|flags         ||Number       || Bitmask showing the state of this message. The same as in the module &amp;quot;mail&amp;quot;. &lt;br /&gt;
|-&lt;br /&gt;
|receivedDate  ||Time         || The time this message was received. &lt;br /&gt;
|-&lt;br /&gt;
|colorLabel    ||Number       || An arbitrary number marking this message in a certain color. The same as the colorLabel common to all groupware objects (see HTTP API)&lt;br /&gt;
|-&lt;br /&gt;
|user          ||Array        || An array of strings. Represents user flags. &lt;br /&gt;
|-&lt;br /&gt;
|size          ||Number       || The binary size of this message in bytes. &lt;br /&gt;
|-&lt;br /&gt;
|picture    || String       || A string depicting the URL to a picture for this message &lt;br /&gt;
|-&lt;br /&gt;
|url           || String      || A string that contains a link to the messages origin. Currently used in RSS messages.&lt;br /&gt;
|-&lt;br /&gt;
|headers       ||JSONObject   || A JSON Object of header data. Usually the value is either a String or an Array (if the headers has more than one value). Certain headers are rendered as more complex structures, see the section &amp;quot;Complex Headers&amp;quot;. &lt;br /&gt;
|-&lt;br /&gt;
|content       ||String or Array || See introductory note for Messaging Messages. &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
The structure of a Multipart Part (an element of the content array in a multipart/* message) is a s follows:&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MessagingService&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Multipart Element&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
|sectionId     || String       || The sectionId of this part.&lt;br /&gt;
|-&lt;br /&gt;
|headers       || JSONObject   || Same as above. &lt;br /&gt;
|-&lt;br /&gt;
|content       || String or Array || Same as above. &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Some *Complex Headers* have a structure differing from simple key/value(s) pairs. These are:&lt;br /&gt;
&lt;br /&gt;
=== Content-Type ===&lt;br /&gt;
&lt;br /&gt;
The Content-Type header is represented as a JSON Object with the following structure:&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MessagingService&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Content Type Header&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| type         || String          || The type string (eg. text/plain). This governs the rendering of the content of a message. &lt;br /&gt;
|-&lt;br /&gt;
| params       || Object          || An Object with the keys &amp;quot;charset&amp;quot;, containing the charset of this message and &amp;quot;name&amp;quot; pointing to the filename this part or message should have. &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
When setting the content-type header in a messaging messages generated on the client the header may also be sent in it&#039;s short form. The short form is the type followed by a semi-colon separated list of key=value pairs&lt;br /&gt;
of the params. For example: &amp;quot;text/plain;charset=utf-8;name=something.txt&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Address Headers ===&lt;br /&gt;
&lt;br /&gt;
Address headers ( From, To,Cc,Bcc,Reply-To,Resent-Reply-To,Disposition-Notification-To,Resent-To,Sender,Resent-Sender,Resent-To,Resent-Cc,Resent-Bcc ) are formatted as an array of objects, or in case of &amp;quot;From&amp;quot; as a single object, with the attributes *address* and *personal*:&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MessagingService&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Address Headers&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| address         || String     || The technical part of the address&lt;br /&gt;
|-&lt;br /&gt;
| personal       || String      || A displayable description of the addressee. May be unset.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
When setting an address header the header may also be sent by clients in the short form &amp;lt;code&amp;gt;&amp;quot;personal &amp;amp;lt;address&amp;amp;gt;&amp;quot;&amp;lt;/code&amp;gt;, for example &amp;lt;code&amp;gt;&amp;quot;Clark Kent &amp;amp;lt;clark.kent@dailyplanet.com&amp;amp;gt;&amp;quot;&amp;lt;/code&amp;gt;. &lt;br /&gt;
&lt;br /&gt;
=== List renderings of Messaging Messages ===&lt;br /&gt;
&lt;br /&gt;
Actions returning lists of messages usually return only a selection of attributes of a message driven by a &amp;quot;columns&amp;quot; parameter. The columns that are addressable point either to attributes of the top-level message or its headers. &lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MessagingService&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Header Equivalence&lt;br /&gt;
! Column     !! Refers To&lt;br /&gt;
|-&lt;br /&gt;
|   *column*    |     *refers to*     &lt;br /&gt;
|-&lt;br /&gt;
| id            || The id attribute    &lt;br /&gt;
|-&lt;br /&gt;
| folderId      || The folder attribute &lt;br /&gt;
|-&lt;br /&gt;
| contentType   || The &amp;quot;Content-Type&amp;quot; header &lt;br /&gt;
|-&lt;br /&gt;
| from          || The &amp;quot;From&amp;quot; header &lt;br /&gt;
|-&lt;br /&gt;
| to            || The &amp;quot;To&amp;quot; header &lt;br /&gt;
|-&lt;br /&gt;
| cc            || The &amp;quot;Cc&amp;quot; header &lt;br /&gt;
|-&lt;br /&gt;
| bcc           || The &amp;quot;Bcc&amp;quot; header &lt;br /&gt;
|-&lt;br /&gt;
| subject       || The &amp;quot;Subject&amp;quot; header &lt;br /&gt;
|-&lt;br /&gt;
| size          || The size attribute &lt;br /&gt;
|-&lt;br /&gt;
| sentDate      || The &amp;quot;Date&amp;quot; header &lt;br /&gt;
|-&lt;br /&gt;
| receivedDate  || The receivedDate attribute &lt;br /&gt;
|-&lt;br /&gt;
| flags         || The flags attribute &lt;br /&gt;
|-&lt;br /&gt;
| threadLevel   || The threadLevel attribute &lt;br /&gt;
|-&lt;br /&gt;
| dispositionNotificationTo || The &amp;quot;Disposition-Notification-To&amp;quot; header. &lt;br /&gt;
|-&lt;br /&gt;
| priority      || The &amp;quot;X-Priority&amp;quot; header &lt;br /&gt;
|-&lt;br /&gt;
| colorLabel    || The colorLabel attribute &lt;br /&gt;
|-&lt;br /&gt;
| url             || The url attribute &lt;br /&gt;
|-&lt;br /&gt;
| body          || The content attribute &lt;br /&gt;
|-&lt;br /&gt;
| headers       || The headers attribute &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== JSON calls ===&lt;br /&gt;
&lt;br /&gt;
GET /ajax/messaging/message?action=get&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module&lt;br /&gt;
* id - The ID of the message to load&lt;br /&gt;
* peek - (optional) if set to &amp;quot;true&amp;quot; the read/unread state of the message will not change. Defaults to false.&lt;br /&gt;
* folder - The folder id&lt;br /&gt;
   &lt;br /&gt;
Response: An Object representing the loaded message.&lt;br /&gt;
&lt;br /&gt;
PUT /ajax/messaging/message?action=send&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module&lt;br /&gt;
* recipients - (optional) If set the message is sent to the given list of recipients, otherwise this defaults to the &amp;quot;To&amp;quot; header of the message.&lt;br /&gt;
   &lt;br /&gt;
Request Body: The Request Body should contain the JSON Object representing the message to be sent.&lt;br /&gt;
Response: &amp;quot;1&amp;quot; as the data of a regular response on success.&lt;br /&gt;
&lt;br /&gt;
GET or PUT /ajax/messaging/message?action=perform&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module&lt;br /&gt;
* action - The messaging action to invoke&lt;br /&gt;
* id - The id of the message the action should be invoked on. Only used on actions of type &amp;quot;storage&amp;quot;.&lt;br /&gt;
* folder - The folder id.&lt;br /&gt;
   &lt;br /&gt;
Request Body: On actions of type &amp;quot;message&amp;quot; the body should contain the JSON representation of the message the action should be applied to.&lt;br /&gt;
Response: Either 1 if no further user interaction is needed or a messaging message that, after having the user modify it has to be supplied back to the follower action of this action.&lt;br /&gt;
&lt;br /&gt;
Thus, to invoke a messaging action of type &amp;quot;storage&amp;quot; the folder and id are needed. Messaging actions of type &amp;quot;message&amp;quot; need a folder and message in the body. &lt;br /&gt;
Messaging actions of type &amp;quot;none&amp;quot; need a messaging message and account. &lt;br /&gt;
&lt;br /&gt;
==== List style requests ====&lt;br /&gt;
&lt;br /&gt;
GET /ajax/messaging/message?action=all&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module&lt;br /&gt;
* columns - A comma-separated list of column names.&lt;br /&gt;
* sort - (optional) A column to sort by.&lt;br /&gt;
* order - (optional) The order direction. &amp;quot;asc&amp;quot; for ascending or &amp;quot;desc&amp;quot; for descending. Defaults to &amp;quot;asc&amp;quot;&lt;br /&gt;
* folder - The folder id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of arrays with the sub arrays containing the values of the fields asked for by the the columns parameter.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
PUT /ajax/messaging/messages?action=list&lt;br /&gt;
&lt;br /&gt;
* session - A session ID previously obtained from the login module&lt;br /&gt;
* columns - A comma-separated list of column names.&lt;br /&gt;
&lt;br /&gt;
Request Body: An array of arrays with the folder and id as elements each identifying a message. &lt;br /&gt;
&lt;br /&gt;
Response: An array of arrays with the sub arrays containing the values of the fields asked for by the columns parameter.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=8993</id>
		<title>ThemeChanges</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=8993"/>
		<updated>2011-09-26T13:39:37Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: added diff showing all theme changes&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;=Changes from 6.20 to Public Patch Release 2011-09-22 for 6.20 (Rev 27) =&lt;br /&gt;
&lt;br /&gt;
===Diff file with all changes===&lt;br /&gt;
[[File:6.20_to_6.20_rev27_2011-09-22.diff]]&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
No CSS files removed.&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/bgimages.css&lt;br /&gt;
 - theme/css/global.css&lt;br /&gt;
 - theme/css/popus.css &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.bg-toolbar-compact {&lt;br /&gt;
    background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header-handle {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 24px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    line-height: 22px;&lt;br /&gt;
    padding-left: 10px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit/IE9 */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr=&#039;#ffffff&#039;, endColorstr=&#039;#efefef&#039;);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button,&lt;br /&gt;
.ox-portal-widget .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.ox-button.ox-button-disabled,&lt;br /&gt;
.ox-button.default.ox-button-disabled&lt;br /&gt;
.ox-button.dark.ox-button-disabled {&lt;br /&gt;
    color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover, .ox-button:focus {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in popup.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
#wizzardPublishImageTank .linkstyle {&lt;br /&gt;
	cursor: default !important;&lt;br /&gt;
	text-decoration: none !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span,&lt;br /&gt;
#wizzardPublishImageTank .linkstyle a {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.2 to 6.20 =&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files in this release.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/newwindow.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .topheader-l {&lt;br /&gt;
  background-image: url(../img/border/topheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-tl {&lt;br /&gt;
  background-image: url(../img/border/topheader-tl.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-t {&lt;br /&gt;
  background-image: url(../img/border/topheader-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-tr {&lt;br /&gt;
  background-image: url(../img/border/topheader-tr.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-r {&lt;br /&gt;
  background-image: url(../img/border/topheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }		&lt;br /&gt;
&lt;br /&gt;
 .topheaderactive-t {&lt;br /&gt;
  background-image: url(../img/border/topheaderactive-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .calbody-r {&lt;br /&gt;
  background-image: url(../img/border/calbody-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .oxheader-l {&lt;br /&gt;
  background-image: url(../img/border/oxheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
			&lt;br /&gt;
 .oxheader-r {&lt;br /&gt;
  background-image: url(../img/border/oxheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .cpbody-size {&lt;br /&gt;
  left: 4px;&lt;br /&gt;
  right: 4px;&lt;br /&gt;
  width: 4px;&lt;br /&gt;
  top: 1px;&lt;br /&gt;
  bottom: 1px;&lt;br /&gt;
  height: 1px;&lt;br /&gt;
 }	&lt;br /&gt;
&lt;br /&gt;
 .cpbottom-size {&lt;br /&gt;
  left: 12px;&lt;br /&gt;
  right: 12px;&lt;br /&gt;
  width: 12px;&lt;br /&gt;
  top: 20px;&lt;br /&gt;
  bottom: 20px;&lt;br /&gt;
  height: 20px;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .expandButton {&lt;br /&gt;
  background-image:url(&amp;quot;../img/arrows/arrow_gray_down.gif&amp;quot;);	&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .sp-toggle&lt;br /&gt;
 {&lt;br /&gt;
  background-image:url(../img/border/spback.gif);&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in branding.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 #header {&lt;br /&gt;
  top: 0px !important; /* change this to branding height */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #header-decorator {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #notheader {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in calendar.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.kwSeparationBackGround {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.offTimeBackground {&lt;br /&gt;
    background-color : #E4E8FA;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.workTimeBackground {&lt;br /&gt;
    background-color : #F2F6FA;&lt;br /&gt;
}&lt;br /&gt;
.wholeDayBackground {&lt;br /&gt;
    background-color: #dddddd;&lt;br /&gt;
}&lt;br /&gt;
.appointmentTitleBG {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appointmentViewHeadBG {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
    border-top: 1px solid;  &lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.strokeCalendar {&lt;br /&gt;
    border-color : #D1D8DD !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.sectionStrokeCalendar {&lt;br /&gt;
    border-color : #a5b5bf !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSliderBox {&lt;br /&gt;
    border-top: 1px solid #3066c5;&lt;br /&gt;
    border-bottom: 1px solid #3066c5;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSlider {&lt;br /&gt;
    border: 1px solid #999;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_control_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .leftColumn .rowSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .dataGrid .appointment.isSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
 /* customs */&lt;br /&gt;
&lt;br /&gt;
#cwwtimecontent &amp;gt; tbody &amp;gt; tr &amp;gt; td &amp;gt; table &amp;gt; tbody &amp;gt; tr &amp;gt; td:first-child {&lt;br /&gt;
    background-color: #ff0000;&lt;br /&gt;
    width: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cww_timeline {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cww-timeline-font {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
    color: #333;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cwwheaderresize &amp;gt; table {&lt;br /&gt;
    height: 100%;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appInWeekView, .appInMonthView, .showAppointmentTextMonthFull {&lt;br /&gt;
	background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.todayBackground {&lt;br /&gt;
    background-color: #fc0 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in iframe.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
html, body {&lt;br /&gt;
    font-family: Arial, Helvetica, sans-serif; &lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.plainTextContent {&lt;br /&gt;
    font-family: monospace, Courier New;&lt;br /&gt;
    line-height: 1.5em;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Rainbow quoting */&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote {&lt;br /&gt;
	border-left: 2px solid #364e9b !important; /* blue */&lt;br /&gt;
	background-color: #f5f7ff;&lt;br /&gt;
    color: #1a254a !important;&lt;br /&gt;
    margin-right: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote {&lt;br /&gt;
    border-color: #366a9b !important; /* cyan */&lt;br /&gt;
    background-color: #e6f3ff;&lt;br /&gt;
    color: #1e3b56 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #3c7027 !important; /* green */&lt;br /&gt;
    background-color: #edffe6;&lt;br /&gt;
    color: #192e10 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #efc000 !important; /* orange */&lt;br /&gt;
    background-color: #fffae6;&lt;br /&gt;
    color: #713200 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #5c1111 !important; /* red*/&lt;br /&gt;
    background-color: #ffeeee;&lt;br /&gt;
    color: #751000 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #801062 !important; /* pink */&lt;br /&gt;
    background-color: #ffeffb;&lt;br /&gt;
    color: #3c072e !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #240a4f !important; /* violet */&lt;br /&gt;
    background-color: #f1e9ff;&lt;br /&gt;
    color: #3a1081 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #333 !important; /* gray */&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    color: #333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #555 !important; /* black */&lt;br /&gt;
    background-color: #fff;&lt;br /&gt;
    color: #111 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in popuo.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.popupHeaderBackground {&lt;br /&gt;
	background-color: #bbb !important;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivOver {&lt;br /&gt;
	background-color:#bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActive {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActiveNoPadding {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.popup-header, .listDialogue td.listDialogueHeader {&lt;br /&gt;
	font-weight: bold;&lt;br /&gt;
	color: #000;&lt;br /&gt;
	background-image: url(../img/panels/miniviewHeader_b.gif);	&lt;br /&gt;
	background-color: #bbb;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
body {&lt;br /&gt;
	background-color: #cccccc; /* was #a9b2c5 */&lt;br /&gt;
	font-family: Arial, Helvetica, sans-serif;&lt;br /&gt;
	font-size: 9pt;&lt;br /&gt;
	color:#000;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.webkit body {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 50%, 0% 100%, from(#ccc), to(#333)); /* ccc to 555 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.firefox body {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #eee, #555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.font-style-person, .font-color-person {&lt;br /&gt;
    color: #344F70;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cpheader-color {&lt;br /&gt;
	background-color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.topHeaderBG, .topheader-color {&lt;br /&gt;
	background-color: #444;	/* was #65769b */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.background-color-content, .cpbody-color {&lt;br /&gt;
	background-color: #f5f5f5 !important;&lt;br /&gt;
}&lt;br /&gt;
(was .background-color-content, .cpbody-color, .calbody-color)&lt;br /&gt;
&lt;br /&gt;
.background-color-PMG-selection-elements {&lt;br /&gt;
	background-color: #bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.entrySelDiv {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*live grid selection*/&lt;br /&gt;
.selected {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.selectedfocused {&lt;br /&gt;
	border-color: #607090 !important;&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont {&lt;br /&gt;
	background-color: white !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont, .mailDetailAttachmentsContSel {&lt;br /&gt;
    border-color: #C0C0C0 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dndOver {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
	border-color: #bdd3eb !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.browsercheck {&lt;br /&gt;
	background-image: url(../img/browsercheck.png);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#sidepanel_dragpoint_background {&lt;br /&gt;
    background-color: #ddd;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit #sidepanel_dragpoint_background {&lt;br /&gt;
    -webkit-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox #sidepanel_dragpoint_background {&lt;br /&gt;
    -moz-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #sidesplit {&lt;br /&gt;
    border-right: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #mainarea {&lt;br /&gt;
    border-left: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dropdownbox .comboboxColumn2 {&lt;br /&gt;
    background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
#menu_search_mail_context, #menu_search_context {&lt;br /&gt;
	background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl {&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-sidepanel-title {&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl a {&lt;br /&gt;
	color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    background-color: #666; /* was #455069 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTabCurrent, div.oxTabControl td.oxTabCurrent:hover {&lt;br /&gt;
    color: #000;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-top: 2px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*&lt;br /&gt;
 * Portal &lt;br /&gt;
 */&lt;br /&gt;
&lt;br /&gt;
.ox-portal {&lt;br /&gt;
    background-color: white; /* body: A9B2C5 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top , #FFFFFF, #DDDDDD);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#DDDDDD));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-placeholder {&lt;br /&gt;
    border: 2px dashed #888;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget */&lt;br /&gt;
.ox-portal-widget {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    padding: 0px 0px 8px 0px;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -moz-border-radius: 8px;&lt;br /&gt;
    -moz-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -webkit-border-radius: 8px;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* IE gets no radius, no shadow */&lt;br /&gt;
.IE .ox-portal-widget {&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget header */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit */&lt;br /&gt;
.firefox .ox-portal-header {&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-header {&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* close/remove button */&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* controls */&lt;br /&gt;
.ox-portal-topbar {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-bottom: 1px solid #aaa;&lt;br /&gt;
    color: #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar i {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	font-style: normal;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar b {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	color: #999;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar a {&lt;br /&gt;
    color: #00f;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    text-decoration: underline;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls, .ox-quick-config {&lt;br /&gt;
	background-color: #444;&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-controls, .firefox .ox-quick-config {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-controls, .webkit .ox-quick-config {&lt;br /&gt;
	background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config table {&lt;br /&gt;
	margin: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config td, .ox-quick-config th {&lt;br /&gt;
	padding: 0px 20px 5px 0px;&lt;br /&gt;
	vertical-align: top;&lt;br /&gt;
	white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config th {&lt;br /&gt;
    color: #8AC2FF;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    text-align: left;&lt;br /&gt;
    padding-bottom: 2px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls label, .ox-quick-config label {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout {&lt;br /&gt;
	width: 90px;&lt;br /&gt;
	height: 60px;&lt;br /&gt;
    background-image: url(../img/portal/layouts.png);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    margin: 2px 22px 2px 2px;&lt;br /&gt;
    border: 0px none;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.one {&lt;br /&gt;
	background-position: 0px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.two {&lt;br /&gt;
    background-position: -90px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.three {&lt;br /&gt;
    background-position: -180px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.four {&lt;br /&gt;
    background-position: -270px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.five {&lt;br /&gt;
    background-position: -360px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.active, .ox-portal-layout.active:hover {&lt;br /&gt;
	background-color: #67789D;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
	-webkit-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout:hover {&lt;br /&gt;
	background-color: #888;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* &lt;br /&gt;
 * Button&lt;br /&gt;
 */&lt;br /&gt;
.ox-button {&lt;br /&gt;
	font-size: 8pt;&lt;br /&gt;
	line-height: 1.5em;&lt;br /&gt;
    border-radius: 5px;&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
    color: black;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    padding: 5px 1em 5px 1em;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    display: inline-block;&lt;br /&gt;
    vertical-align: middle;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark {&lt;br /&gt;
    background-color: #333;&lt;br /&gt;
    border: 1px solid #222;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* firefox */&lt;br /&gt;
.ox-button.firefox {&lt;br /&gt;
	-moz-border-radius: 5px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.firefox {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #555555, #333333);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.firefox:hover {&lt;br /&gt;
	-moz-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* webkit */&lt;br /&gt;
.ox-button.webkit {&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.webkit {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#555555), to(#333333));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.webkit:hover {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows */&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-decorator {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px; &lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    background-color: black; &lt;br /&gt;
    opacity: 0.10;&lt;br /&gt;
    filter: alpha(opacity=10);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-container {&lt;br /&gt;
    position: absolute; &lt;br /&gt;
    top: 0px; &lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 50%; &lt;br /&gt;
    margin-left: 0px; /* use to center */&lt;br /&gt;
    width: 0px; /* live parameter; override with !important */&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    visibility: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-container {&lt;br /&gt;
    -moz-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-container {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE .ox-embedded-container {&lt;br /&gt;
    border: 1px solid #333;&lt;br /&gt;
    border-width: 0px 1px 0px 1px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-title {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    line-height: 12px;&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    text-align: center;&lt;br /&gt;
    padding: 9px 20px 8px 10px;&lt;br /&gt;
    color: #ccc;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    border-bottom: 1px solid #333;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-title {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111, #444);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-title {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111), to(#444));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 7px;&lt;br /&gt;
    right: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close img {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/x.png);&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-iframe {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 30px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows: dock */&lt;br /&gt;
&lt;br /&gt;
.ox-dock {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    color: black;&lt;br /&gt;
    border-top: 1px solid #333;&lt;br /&gt;
    height: 33px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    z-index: 65000;&lt;br /&gt;
    display: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-tab {&lt;br /&gt;
    background-color: #222;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    border: 1px solid black;&lt;br /&gt;
    border-width: 0px 1px 1px 1px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    padding: 4px 10px 4px 10px;&lt;br /&gt;
    margin: 0px 0px 0px 5px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    height: 1.5em;&lt;br /&gt;
    color: white;&lt;br /&gt;
    border-radius: 0px 0px 8px 8px;&lt;br /&gt;
        &lt;br /&gt;
    position: relative;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    overflow: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-tab {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #333333);&lt;br /&gt;
    -moz-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-tab {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#333333));&lt;br /&gt;
    -webkit-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-selected {&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-selected {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #666);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-selected {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#666));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Context-menu button */&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.weekDivMonthView .background-color-content{&lt;br /&gt;
    background-color: #ffdaab !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/icons/16/calendar_dis.png&lt;br /&gt;
 - theme/icons/16/calendar.png&lt;br /&gt;
 - theme/icons/16/contacts_dis.png&lt;br /&gt;
 - theme/icons/16/contacts.png&lt;br /&gt;
 - theme/icons/16/draft_dis.png&lt;br /&gt;
 - theme/icons/16/draft.png&lt;br /&gt;
 - theme/icons/16/facebook.png&lt;br /&gt;
 - theme/icons/16/folder_closed_dis.png&lt;br /&gt;
 - theme/icons/16/folder_opened_dis.png&lt;br /&gt;
 - theme/icons/16/forward.png&lt;br /&gt;
 - theme/icons/16/garbage_dis.png&lt;br /&gt;
 - theme/icons/16/garbage.png&lt;br /&gt;
 - theme/icons/16/ham_dis.png&lt;br /&gt;
 - theme/icons/16/ham.png&lt;br /&gt;
 - theme/icons/16/inbox_dis.png&lt;br /&gt;
 - theme/icons/16/inbox.png&lt;br /&gt;
 - theme/icons/16/infostore_dis.png&lt;br /&gt;
 - theme/icons/16/infostore.png&lt;br /&gt;
 - theme/icons/16/mail_dis.png&lt;br /&gt;
 - theme/icons/16/mail.png&lt;br /&gt;
 - theme/icons/16/outbox_dis.png&lt;br /&gt;
 - theme/icons/16/outbox.png&lt;br /&gt;
 - theme/icons/16/public_dis.png&lt;br /&gt;
 - theme/icons/16/public.png&lt;br /&gt;
 - theme/icons/16/rss.png&lt;br /&gt;
 - theme/icons/16/shared_dis.png&lt;br /&gt;
 - theme/icons/16/shared_globe.png&lt;br /&gt;
 - theme/icons/16/shared.png&lt;br /&gt;
 - theme/icons/16/spam_dis.png&lt;br /&gt;
 - theme/icons/16/spam.png&lt;br /&gt;
 - theme/icons/16/tasks_dis.png&lt;br /&gt;
 - theme/icons/16/tasks.png&lt;br /&gt;
 - theme/icons/16/twitter.png&lt;br /&gt;
 - theme/icons/16/user_dis.png&lt;br /&gt;
&lt;br /&gt;
 - theme/icons/24/calendar_move.png&lt;br /&gt;
 - theme/icons/24/distributionlist_extcontact.png&lt;br /&gt;
 - theme/icons/24/ham.png&lt;br /&gt;
 - theme/icons/24/mark_as_done.png&lt;br /&gt;
 - theme/icons/24/mark_as.png&lt;br /&gt;
 - theme/icons/24/spam.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/arrows/arrow_white_down.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/slider_background.png&lt;br /&gt;
 - theme/img/calendar/slider_control_background.png&lt;br /&gt;
&lt;br /&gt;
 - themes/portal/layouts.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/browsercheck.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.gif&lt;br /&gt;
 changed to a png image&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/calbody-r.png&lt;br /&gt;
 - theme/img/border/cpbody-l.png&lt;br /&gt;
 - theme/img/border/cpbody-r.png&lt;br /&gt;
 - theme/img/border/cpbottom-b.png&lt;br /&gt;
 - theme/img/border/cpbottom-bl.png&lt;br /&gt;
 - theme/img/border/cpbottom-l.png&lt;br /&gt;
 - theme/img/border/cpbottom-r.png&lt;br /&gt;
 - theme/img/border/cpheader-l.png&lt;br /&gt;
 - theme/img/border/cpheader-r.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-ll.png&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-rr.png&lt;br /&gt;
 - theme/img/border/popup/popup-border-imagemap.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31.gif&lt;br /&gt;
 All icons have changed from gif to png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/infostore/mimetypes/vcard.gif&lt;br /&gt;
&lt;br /&gt;
 - theme/img/panels/miniviewHeader_b.gif&lt;br /&gt;
&lt;br /&gt;
 - themes/img/x.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1_sel.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31_sel.gif&lt;br /&gt;
 All icons with the _sel ending have been removed&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.1 to 6.18.2=&lt;br /&gt;
&lt;br /&gt;
===New CSS file===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/branding.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
- theme/css/global.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-person {&lt;br /&gt;
    		color: #215696;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	#window-header-decorator {&lt;br /&gt;
    		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
    		background-repeat: repeat-x;&lt;br /&gt;
    		background-color: #ddd;&lt;br /&gt;
    		border-bottom: 1px solid #bbb;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
		background-repeat: repeat-x;&lt;br /&gt;
		border-top: 0px none;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable.border-color-design {&lt;br /&gt;
		border-color: #aaa !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse, div.oxTabControlToggle {&lt;br /&gt;
		background-repeat: no-repeat;&lt;br /&gt;
		background-position: 3px 5px;&lt;br /&gt;
		width: 15px;&lt;br /&gt;
		height: 15px;&lt;br /&gt;
		float: right;&lt;br /&gt;
		margin: 5px 9px;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_down.gif);&lt;br /&gt;
		cursor: s-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggle {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_up.gif);&lt;br /&gt;
		cursor: n-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl {&lt;br /&gt;
	    background-color: #65769B;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.ox-sidepanel-view-title {&lt;br /&gt;
		color: white;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl a {&lt;br /&gt;
		color: #eee;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    		background-color: #455069;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Change elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color:#404962;  &lt;br /&gt;
		font-weight : bold; &lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color: #333;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	#notheader {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	#header-decorator {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.tr_h {&lt;br /&gt;
    		background-color: #e3e3e3 !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.tr_h {&lt;br /&gt;
		background-color: #eaeaea !important;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_down.gif&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_up.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_down.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_right.gif&lt;br /&gt;
 - theme/img/folder/shared_dis.gif &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
All icons under the folder /themes/[theme name]/ will be separated by their size. You will find three different sub-folders here: 16 (for 16x16 pixel icons), 24 and 36. Some icons may be available in several folders. Some icons can also be found in their old location under /themes/[theme name]/img/. In the future, all icons will be found in the new icons folder and not in the img folder.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
16/attachment_add.png&lt;br /&gt;
16/attachment_open.png&lt;br /&gt;
16/attachment_remove.png&lt;br /&gt;
16/calendar_move.png&lt;br /&gt;
16/confirmation_change.png&lt;br /&gt;
16/contact_copy.png&lt;br /&gt;
16/contact_move.png&lt;br /&gt;
16/current_version.png&lt;br /&gt;
16/delete_folder.png&lt;br /&gt;
16/delete.png&lt;br /&gt;
16/distributionlist_extcontact.png&lt;br /&gt;
16/dummy.gif&lt;br /&gt;
16/duplicate_contacts.png&lt;br /&gt;
16/folder_closed.png&lt;br /&gt;
16/folder_opened.png&lt;br /&gt;
16/infostore_move.png&lt;br /&gt;
16/lock.png&lt;br /&gt;
16/mail_copy.png&lt;br /&gt;
16/mail_move.png&lt;br /&gt;
16/mail_source.png&lt;br /&gt;
16/mark_as.png&lt;br /&gt;
16/member_add.png&lt;br /&gt;
16/member_remove.png&lt;br /&gt;
16/mod_calendar.png&lt;br /&gt;
16/mod_configuration.png&lt;br /&gt;
16/mod_contacts.png&lt;br /&gt;
16/mod_infostore.png&lt;br /&gt;
16/mod_mail.png&lt;br /&gt;
16/mod_portal.png&lt;br /&gt;
16/mod_tasks.png&lt;br /&gt;
16/print.png&lt;br /&gt;
16/save.png&lt;br /&gt;
16/search.png&lt;br /&gt;
16/send_as_attachment.png&lt;br /&gt;
16/send_as_link.png&lt;br /&gt;
16/task_copy.png&lt;br /&gt;
16/task_move.png&lt;br /&gt;
16/teamchange.png&lt;br /&gt;
16/unlock.png&lt;br /&gt;
16/user.png&lt;br /&gt;
16/userrights_delete.png&lt;br /&gt;
16/userrights.png&lt;br /&gt;
16/userrights_read.png&lt;br /&gt;
16/userrights_remove.png&lt;br /&gt;
16/userrights_write.png&lt;br /&gt;
&lt;br /&gt;
24/attachment_add.png&lt;br /&gt;
24/attachment_remove.png&lt;br /&gt;
24/cancel.png&lt;br /&gt;
24/card_view.png&lt;br /&gt;
24/category_add.png&lt;br /&gt;
24/category_remove.png&lt;br /&gt;
24/confirmation_change.png&lt;br /&gt;
24/delete.png&lt;br /&gt;
24/detail_view.png&lt;br /&gt;
24/distributionlist.png&lt;br /&gt;
24/draft.png&lt;br /&gt;
24/dummy.gif&lt;br /&gt;
24/edit.png&lt;br /&gt;
24/externalview_add.png&lt;br /&gt;
24/externalview_disable.png&lt;br /&gt;
24/externalview_edit.png&lt;br /&gt;
24/externalview_enable.png&lt;br /&gt;
24/externalview_remove.png&lt;br /&gt;
24/forward.png&lt;br /&gt;
24/h_split_view.png&lt;br /&gt;
24/inbox.png&lt;br /&gt;
24/list_view.png&lt;br /&gt;
24/mail_copy.png&lt;br /&gt;
24/mail_move.png&lt;br /&gt;
24/mail_send.png&lt;br /&gt;
24/mail_write.png&lt;br /&gt;
24/member_add.png&lt;br /&gt;
24/member_remove.png&lt;br /&gt;
24/mod_calendar.png&lt;br /&gt;
24/mod_configuration.png&lt;br /&gt;
24/mod_contacts.png&lt;br /&gt;
24/mod_foldertree.png&lt;br /&gt;
24/mod_infostore.png&lt;br /&gt;
24/mod_mail.png&lt;br /&gt;
24/mod_portal.png&lt;br /&gt;
24/mod_tasks.png&lt;br /&gt;
24/options.png&lt;br /&gt;
24/picture_add.png&lt;br /&gt;
24/picture_remove.png&lt;br /&gt;
24/print.png&lt;br /&gt;
24/reply_all.png&lt;br /&gt;
24/reply.png&lt;br /&gt;
24/save_as_link.png&lt;br /&gt;
24/save.png&lt;br /&gt;
24/tag_10.png&lt;br /&gt;
24/tag_1.png&lt;br /&gt;
24/tag_2.png&lt;br /&gt;
24/tag_3.png&lt;br /&gt;
24/tag_4.png&lt;br /&gt;
24/tag_5.png&lt;br /&gt;
24/tag_6.png&lt;br /&gt;
24/tag_7.png&lt;br /&gt;
24/tag_8.png&lt;br /&gt;
24/tag_9.png&lt;br /&gt;
24/tag_remove.png&lt;br /&gt;
24/task_copy.png&lt;br /&gt;
24/task_move.png&lt;br /&gt;
24/teamchange.png&lt;br /&gt;
24/v_split_view.png&lt;br /&gt;
&lt;br /&gt;
32/attachment_add.png&lt;br /&gt;
32/attachment_remove.png&lt;br /&gt;
32/cancel.png&lt;br /&gt;
32/category_add.png&lt;br /&gt;
32/category_remove.png&lt;br /&gt;
32/confirmation_change.png&lt;br /&gt;
32/delete.png&lt;br /&gt;
32/distributionlist.png&lt;br /&gt;
32/draft.png&lt;br /&gt;
32/dummy.gif&lt;br /&gt;
32/edit.png&lt;br /&gt;
32/externalview_add.png&lt;br /&gt;
32/externalview_disable.png&lt;br /&gt;
32/externalview_edit.png&lt;br /&gt;
32/externalview_enable.png&lt;br /&gt;
32/externalview_remove.png&lt;br /&gt;
32/forward.png&lt;br /&gt;
32/import.png&lt;br /&gt;
32/mail_copy.png&lt;br /&gt;
32/mail_move.png&lt;br /&gt;
32/mail_send.png&lt;br /&gt;
32/mail_write.png&lt;br /&gt;
32/member_add.png&lt;br /&gt;
32/member_remove.png&lt;br /&gt;
32/mod_calendar.png&lt;br /&gt;
32/mod_configuration.png&lt;br /&gt;
32/mod_contacts.png&lt;br /&gt;
32/mod_infostore.png&lt;br /&gt;
32/mod_mail.png&lt;br /&gt;
32/mod_portal.png&lt;br /&gt;
32/mod_tasks.png&lt;br /&gt;
32/options.png&lt;br /&gt;
32/picture_add.png&lt;br /&gt;
32/picture_remove.png&lt;br /&gt;
32/print.png&lt;br /&gt;
32/reply_all.png&lt;br /&gt;
32/reply.png&lt;br /&gt;
32/save_as_link.png&lt;br /&gt;
32/save.png&lt;br /&gt;
32/tag_10.png&lt;br /&gt;
32/tag_1.png&lt;br /&gt;
32/tag_2.png&lt;br /&gt;
32/tag_3.png&lt;br /&gt;
32/tag_4.png&lt;br /&gt;
32/tag_5.png&lt;br /&gt;
32/tag_6.png&lt;br /&gt;
32/tag_7.png&lt;br /&gt;
32/tag_8.png&lt;br /&gt;
32/tag_9.png&lt;br /&gt;
32/tag_remove.png&lt;br /&gt;
32/task_copy.png&lt;br /&gt;
32/task_move.png&lt;br /&gt;
32/teamchange.png&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/toolbar/toolbar_bg.gif&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=File:6.20_to_6.20_rev27_2011-09-22.diff&amp;diff=8992</id>
		<title>File:6.20 to 6.20 rev27 2011-09-22.diff</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=File:6.20_to_6.20_rev27_2011-09-22.diff&amp;diff=8992"/>
		<updated>2011-09-26T13:36:35Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Diff showing the changes.&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;Diff showing the changes.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=8991</id>
		<title>ThemeChanges</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=8991"/>
		<updated>2011-09-23T15:34:26Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Changes from 6.20 to Public Patch Release 2011-09-22 for 6.20 (Rev 27 built 2011-09-22) */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;=Changes from 6.20 to Public Patch Release 2011-09-22 for 6.20 (Rev 27) =&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
No CSS files removed.&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/bgimages.css&lt;br /&gt;
 - theme/css/global.css&lt;br /&gt;
 - theme/css/popus.css &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.bg-toolbar-compact {&lt;br /&gt;
    background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header-handle {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 24px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    line-height: 22px;&lt;br /&gt;
    padding-left: 10px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit/IE9 */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr=&#039;#ffffff&#039;, endColorstr=&#039;#efefef&#039;);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button,&lt;br /&gt;
.ox-portal-widget .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.ox-button.ox-button-disabled,&lt;br /&gt;
.ox-button.default.ox-button-disabled&lt;br /&gt;
.ox-button.dark.ox-button-disabled {&lt;br /&gt;
    color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover, .ox-button:focus {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in popup.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
#wizzardPublishImageTank .linkstyle {&lt;br /&gt;
	cursor: default !important;&lt;br /&gt;
	text-decoration: none !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span,&lt;br /&gt;
#wizzardPublishImageTank .linkstyle a {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.2 to 6.20 =&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files in this release.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/newwindow.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .topheader-l {&lt;br /&gt;
  background-image: url(../img/border/topheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-tl {&lt;br /&gt;
  background-image: url(../img/border/topheader-tl.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-t {&lt;br /&gt;
  background-image: url(../img/border/topheader-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-tr {&lt;br /&gt;
  background-image: url(../img/border/topheader-tr.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-r {&lt;br /&gt;
  background-image: url(../img/border/topheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }		&lt;br /&gt;
&lt;br /&gt;
 .topheaderactive-t {&lt;br /&gt;
  background-image: url(../img/border/topheaderactive-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .calbody-r {&lt;br /&gt;
  background-image: url(../img/border/calbody-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .oxheader-l {&lt;br /&gt;
  background-image: url(../img/border/oxheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
			&lt;br /&gt;
 .oxheader-r {&lt;br /&gt;
  background-image: url(../img/border/oxheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .cpbody-size {&lt;br /&gt;
  left: 4px;&lt;br /&gt;
  right: 4px;&lt;br /&gt;
  width: 4px;&lt;br /&gt;
  top: 1px;&lt;br /&gt;
  bottom: 1px;&lt;br /&gt;
  height: 1px;&lt;br /&gt;
 }	&lt;br /&gt;
&lt;br /&gt;
 .cpbottom-size {&lt;br /&gt;
  left: 12px;&lt;br /&gt;
  right: 12px;&lt;br /&gt;
  width: 12px;&lt;br /&gt;
  top: 20px;&lt;br /&gt;
  bottom: 20px;&lt;br /&gt;
  height: 20px;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .expandButton {&lt;br /&gt;
  background-image:url(&amp;quot;../img/arrows/arrow_gray_down.gif&amp;quot;);	&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .sp-toggle&lt;br /&gt;
 {&lt;br /&gt;
  background-image:url(../img/border/spback.gif);&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in branding.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 #header {&lt;br /&gt;
  top: 0px !important; /* change this to branding height */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #header-decorator {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #notheader {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in calendar.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.kwSeparationBackGround {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.offTimeBackground {&lt;br /&gt;
    background-color : #E4E8FA;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.workTimeBackground {&lt;br /&gt;
    background-color : #F2F6FA;&lt;br /&gt;
}&lt;br /&gt;
.wholeDayBackground {&lt;br /&gt;
    background-color: #dddddd;&lt;br /&gt;
}&lt;br /&gt;
.appointmentTitleBG {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appointmentViewHeadBG {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
    border-top: 1px solid;  &lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.strokeCalendar {&lt;br /&gt;
    border-color : #D1D8DD !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.sectionStrokeCalendar {&lt;br /&gt;
    border-color : #a5b5bf !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSliderBox {&lt;br /&gt;
    border-top: 1px solid #3066c5;&lt;br /&gt;
    border-bottom: 1px solid #3066c5;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSlider {&lt;br /&gt;
    border: 1px solid #999;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_control_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .leftColumn .rowSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .dataGrid .appointment.isSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
 /* customs */&lt;br /&gt;
&lt;br /&gt;
#cwwtimecontent &amp;gt; tbody &amp;gt; tr &amp;gt; td &amp;gt; table &amp;gt; tbody &amp;gt; tr &amp;gt; td:first-child {&lt;br /&gt;
    background-color: #ff0000;&lt;br /&gt;
    width: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cww_timeline {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cww-timeline-font {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
    color: #333;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cwwheaderresize &amp;gt; table {&lt;br /&gt;
    height: 100%;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appInWeekView, .appInMonthView, .showAppointmentTextMonthFull {&lt;br /&gt;
	background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.todayBackground {&lt;br /&gt;
    background-color: #fc0 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in iframe.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
html, body {&lt;br /&gt;
    font-family: Arial, Helvetica, sans-serif; &lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.plainTextContent {&lt;br /&gt;
    font-family: monospace, Courier New;&lt;br /&gt;
    line-height: 1.5em;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Rainbow quoting */&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote {&lt;br /&gt;
	border-left: 2px solid #364e9b !important; /* blue */&lt;br /&gt;
	background-color: #f5f7ff;&lt;br /&gt;
    color: #1a254a !important;&lt;br /&gt;
    margin-right: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote {&lt;br /&gt;
    border-color: #366a9b !important; /* cyan */&lt;br /&gt;
    background-color: #e6f3ff;&lt;br /&gt;
    color: #1e3b56 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #3c7027 !important; /* green */&lt;br /&gt;
    background-color: #edffe6;&lt;br /&gt;
    color: #192e10 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #efc000 !important; /* orange */&lt;br /&gt;
    background-color: #fffae6;&lt;br /&gt;
    color: #713200 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #5c1111 !important; /* red*/&lt;br /&gt;
    background-color: #ffeeee;&lt;br /&gt;
    color: #751000 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #801062 !important; /* pink */&lt;br /&gt;
    background-color: #ffeffb;&lt;br /&gt;
    color: #3c072e !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #240a4f !important; /* violet */&lt;br /&gt;
    background-color: #f1e9ff;&lt;br /&gt;
    color: #3a1081 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #333 !important; /* gray */&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    color: #333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #555 !important; /* black */&lt;br /&gt;
    background-color: #fff;&lt;br /&gt;
    color: #111 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in popuo.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.popupHeaderBackground {&lt;br /&gt;
	background-color: #bbb !important;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivOver {&lt;br /&gt;
	background-color:#bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActive {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActiveNoPadding {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.popup-header, .listDialogue td.listDialogueHeader {&lt;br /&gt;
	font-weight: bold;&lt;br /&gt;
	color: #000;&lt;br /&gt;
	background-image: url(../img/panels/miniviewHeader_b.gif);	&lt;br /&gt;
	background-color: #bbb;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
body {&lt;br /&gt;
	background-color: #cccccc; /* was #a9b2c5 */&lt;br /&gt;
	font-family: Arial, Helvetica, sans-serif;&lt;br /&gt;
	font-size: 9pt;&lt;br /&gt;
	color:#000;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.webkit body {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 50%, 0% 100%, from(#ccc), to(#333)); /* ccc to 555 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.firefox body {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #eee, #555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.font-style-person, .font-color-person {&lt;br /&gt;
    color: #344F70;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cpheader-color {&lt;br /&gt;
	background-color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.topHeaderBG, .topheader-color {&lt;br /&gt;
	background-color: #444;	/* was #65769b */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.background-color-content, .cpbody-color {&lt;br /&gt;
	background-color: #f5f5f5 !important;&lt;br /&gt;
}&lt;br /&gt;
(was .background-color-content, .cpbody-color, .calbody-color)&lt;br /&gt;
&lt;br /&gt;
.background-color-PMG-selection-elements {&lt;br /&gt;
	background-color: #bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.entrySelDiv {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*live grid selection*/&lt;br /&gt;
.selected {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.selectedfocused {&lt;br /&gt;
	border-color: #607090 !important;&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont {&lt;br /&gt;
	background-color: white !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont, .mailDetailAttachmentsContSel {&lt;br /&gt;
    border-color: #C0C0C0 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dndOver {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
	border-color: #bdd3eb !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.browsercheck {&lt;br /&gt;
	background-image: url(../img/browsercheck.png);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#sidepanel_dragpoint_background {&lt;br /&gt;
    background-color: #ddd;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit #sidepanel_dragpoint_background {&lt;br /&gt;
    -webkit-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox #sidepanel_dragpoint_background {&lt;br /&gt;
    -moz-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #sidesplit {&lt;br /&gt;
    border-right: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #mainarea {&lt;br /&gt;
    border-left: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dropdownbox .comboboxColumn2 {&lt;br /&gt;
    background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
#menu_search_mail_context, #menu_search_context {&lt;br /&gt;
	background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl {&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-sidepanel-title {&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl a {&lt;br /&gt;
	color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    background-color: #666; /* was #455069 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTabCurrent, div.oxTabControl td.oxTabCurrent:hover {&lt;br /&gt;
    color: #000;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-top: 2px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*&lt;br /&gt;
 * Portal &lt;br /&gt;
 */&lt;br /&gt;
&lt;br /&gt;
.ox-portal {&lt;br /&gt;
    background-color: white; /* body: A9B2C5 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top , #FFFFFF, #DDDDDD);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#DDDDDD));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-placeholder {&lt;br /&gt;
    border: 2px dashed #888;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget */&lt;br /&gt;
.ox-portal-widget {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    padding: 0px 0px 8px 0px;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -moz-border-radius: 8px;&lt;br /&gt;
    -moz-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -webkit-border-radius: 8px;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* IE gets no radius, no shadow */&lt;br /&gt;
.IE .ox-portal-widget {&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget header */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit */&lt;br /&gt;
.firefox .ox-portal-header {&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-header {&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* close/remove button */&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* controls */&lt;br /&gt;
.ox-portal-topbar {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-bottom: 1px solid #aaa;&lt;br /&gt;
    color: #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar i {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	font-style: normal;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar b {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	color: #999;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar a {&lt;br /&gt;
    color: #00f;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    text-decoration: underline;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls, .ox-quick-config {&lt;br /&gt;
	background-color: #444;&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-controls, .firefox .ox-quick-config {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-controls, .webkit .ox-quick-config {&lt;br /&gt;
	background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config table {&lt;br /&gt;
	margin: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config td, .ox-quick-config th {&lt;br /&gt;
	padding: 0px 20px 5px 0px;&lt;br /&gt;
	vertical-align: top;&lt;br /&gt;
	white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config th {&lt;br /&gt;
    color: #8AC2FF;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    text-align: left;&lt;br /&gt;
    padding-bottom: 2px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls label, .ox-quick-config label {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout {&lt;br /&gt;
	width: 90px;&lt;br /&gt;
	height: 60px;&lt;br /&gt;
    background-image: url(../img/portal/layouts.png);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    margin: 2px 22px 2px 2px;&lt;br /&gt;
    border: 0px none;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.one {&lt;br /&gt;
	background-position: 0px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.two {&lt;br /&gt;
    background-position: -90px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.three {&lt;br /&gt;
    background-position: -180px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.four {&lt;br /&gt;
    background-position: -270px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.five {&lt;br /&gt;
    background-position: -360px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.active, .ox-portal-layout.active:hover {&lt;br /&gt;
	background-color: #67789D;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
	-webkit-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout:hover {&lt;br /&gt;
	background-color: #888;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* &lt;br /&gt;
 * Button&lt;br /&gt;
 */&lt;br /&gt;
.ox-button {&lt;br /&gt;
	font-size: 8pt;&lt;br /&gt;
	line-height: 1.5em;&lt;br /&gt;
    border-radius: 5px;&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
    color: black;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    padding: 5px 1em 5px 1em;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    display: inline-block;&lt;br /&gt;
    vertical-align: middle;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark {&lt;br /&gt;
    background-color: #333;&lt;br /&gt;
    border: 1px solid #222;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* firefox */&lt;br /&gt;
.ox-button.firefox {&lt;br /&gt;
	-moz-border-radius: 5px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.firefox {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #555555, #333333);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.firefox:hover {&lt;br /&gt;
	-moz-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* webkit */&lt;br /&gt;
.ox-button.webkit {&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.webkit {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#555555), to(#333333));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.webkit:hover {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows */&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-decorator {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px; &lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    background-color: black; &lt;br /&gt;
    opacity: 0.10;&lt;br /&gt;
    filter: alpha(opacity=10);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-container {&lt;br /&gt;
    position: absolute; &lt;br /&gt;
    top: 0px; &lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 50%; &lt;br /&gt;
    margin-left: 0px; /* use to center */&lt;br /&gt;
    width: 0px; /* live parameter; override with !important */&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    visibility: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-container {&lt;br /&gt;
    -moz-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-container {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE .ox-embedded-container {&lt;br /&gt;
    border: 1px solid #333;&lt;br /&gt;
    border-width: 0px 1px 0px 1px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-title {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    line-height: 12px;&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    text-align: center;&lt;br /&gt;
    padding: 9px 20px 8px 10px;&lt;br /&gt;
    color: #ccc;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    border-bottom: 1px solid #333;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-title {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111, #444);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-title {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111), to(#444));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 7px;&lt;br /&gt;
    right: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close img {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/x.png);&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-iframe {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 30px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows: dock */&lt;br /&gt;
&lt;br /&gt;
.ox-dock {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    color: black;&lt;br /&gt;
    border-top: 1px solid #333;&lt;br /&gt;
    height: 33px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    z-index: 65000;&lt;br /&gt;
    display: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-tab {&lt;br /&gt;
    background-color: #222;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    border: 1px solid black;&lt;br /&gt;
    border-width: 0px 1px 1px 1px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    padding: 4px 10px 4px 10px;&lt;br /&gt;
    margin: 0px 0px 0px 5px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    height: 1.5em;&lt;br /&gt;
    color: white;&lt;br /&gt;
    border-radius: 0px 0px 8px 8px;&lt;br /&gt;
        &lt;br /&gt;
    position: relative;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    overflow: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-tab {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #333333);&lt;br /&gt;
    -moz-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-tab {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#333333));&lt;br /&gt;
    -webkit-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-selected {&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-selected {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #666);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-selected {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#666));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Context-menu button */&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.weekDivMonthView .background-color-content{&lt;br /&gt;
    background-color: #ffdaab !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/icons/16/calendar_dis.png&lt;br /&gt;
 - theme/icons/16/calendar.png&lt;br /&gt;
 - theme/icons/16/contacts_dis.png&lt;br /&gt;
 - theme/icons/16/contacts.png&lt;br /&gt;
 - theme/icons/16/draft_dis.png&lt;br /&gt;
 - theme/icons/16/draft.png&lt;br /&gt;
 - theme/icons/16/facebook.png&lt;br /&gt;
 - theme/icons/16/folder_closed_dis.png&lt;br /&gt;
 - theme/icons/16/folder_opened_dis.png&lt;br /&gt;
 - theme/icons/16/forward.png&lt;br /&gt;
 - theme/icons/16/garbage_dis.png&lt;br /&gt;
 - theme/icons/16/garbage.png&lt;br /&gt;
 - theme/icons/16/ham_dis.png&lt;br /&gt;
 - theme/icons/16/ham.png&lt;br /&gt;
 - theme/icons/16/inbox_dis.png&lt;br /&gt;
 - theme/icons/16/inbox.png&lt;br /&gt;
 - theme/icons/16/infostore_dis.png&lt;br /&gt;
 - theme/icons/16/infostore.png&lt;br /&gt;
 - theme/icons/16/mail_dis.png&lt;br /&gt;
 - theme/icons/16/mail.png&lt;br /&gt;
 - theme/icons/16/outbox_dis.png&lt;br /&gt;
 - theme/icons/16/outbox.png&lt;br /&gt;
 - theme/icons/16/public_dis.png&lt;br /&gt;
 - theme/icons/16/public.png&lt;br /&gt;
 - theme/icons/16/rss.png&lt;br /&gt;
 - theme/icons/16/shared_dis.png&lt;br /&gt;
 - theme/icons/16/shared_globe.png&lt;br /&gt;
 - theme/icons/16/shared.png&lt;br /&gt;
 - theme/icons/16/spam_dis.png&lt;br /&gt;
 - theme/icons/16/spam.png&lt;br /&gt;
 - theme/icons/16/tasks_dis.png&lt;br /&gt;
 - theme/icons/16/tasks.png&lt;br /&gt;
 - theme/icons/16/twitter.png&lt;br /&gt;
 - theme/icons/16/user_dis.png&lt;br /&gt;
&lt;br /&gt;
 - theme/icons/24/calendar_move.png&lt;br /&gt;
 - theme/icons/24/distributionlist_extcontact.png&lt;br /&gt;
 - theme/icons/24/ham.png&lt;br /&gt;
 - theme/icons/24/mark_as_done.png&lt;br /&gt;
 - theme/icons/24/mark_as.png&lt;br /&gt;
 - theme/icons/24/spam.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/arrows/arrow_white_down.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/slider_background.png&lt;br /&gt;
 - theme/img/calendar/slider_control_background.png&lt;br /&gt;
&lt;br /&gt;
 - themes/portal/layouts.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/browsercheck.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.gif&lt;br /&gt;
 changed to a png image&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/calbody-r.png&lt;br /&gt;
 - theme/img/border/cpbody-l.png&lt;br /&gt;
 - theme/img/border/cpbody-r.png&lt;br /&gt;
 - theme/img/border/cpbottom-b.png&lt;br /&gt;
 - theme/img/border/cpbottom-bl.png&lt;br /&gt;
 - theme/img/border/cpbottom-l.png&lt;br /&gt;
 - theme/img/border/cpbottom-r.png&lt;br /&gt;
 - theme/img/border/cpheader-l.png&lt;br /&gt;
 - theme/img/border/cpheader-r.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-ll.png&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-rr.png&lt;br /&gt;
 - theme/img/border/popup/popup-border-imagemap.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31.gif&lt;br /&gt;
 All icons have changed from gif to png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/infostore/mimetypes/vcard.gif&lt;br /&gt;
&lt;br /&gt;
 - theme/img/panels/miniviewHeader_b.gif&lt;br /&gt;
&lt;br /&gt;
 - themes/img/x.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1_sel.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31_sel.gif&lt;br /&gt;
 All icons with the _sel ending have been removed&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.1 to 6.18.2=&lt;br /&gt;
&lt;br /&gt;
===New CSS file===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/branding.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
- theme/css/global.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-person {&lt;br /&gt;
    		color: #215696;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	#window-header-decorator {&lt;br /&gt;
    		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
    		background-repeat: repeat-x;&lt;br /&gt;
    		background-color: #ddd;&lt;br /&gt;
    		border-bottom: 1px solid #bbb;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
		background-repeat: repeat-x;&lt;br /&gt;
		border-top: 0px none;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable.border-color-design {&lt;br /&gt;
		border-color: #aaa !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse, div.oxTabControlToggle {&lt;br /&gt;
		background-repeat: no-repeat;&lt;br /&gt;
		background-position: 3px 5px;&lt;br /&gt;
		width: 15px;&lt;br /&gt;
		height: 15px;&lt;br /&gt;
		float: right;&lt;br /&gt;
		margin: 5px 9px;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_down.gif);&lt;br /&gt;
		cursor: s-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggle {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_up.gif);&lt;br /&gt;
		cursor: n-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl {&lt;br /&gt;
	    background-color: #65769B;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.ox-sidepanel-view-title {&lt;br /&gt;
		color: white;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl a {&lt;br /&gt;
		color: #eee;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    		background-color: #455069;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Change elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color:#404962;  &lt;br /&gt;
		font-weight : bold; &lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color: #333;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	#notheader {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	#header-decorator {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.tr_h {&lt;br /&gt;
    		background-color: #e3e3e3 !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.tr_h {&lt;br /&gt;
		background-color: #eaeaea !important;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_down.gif&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_up.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_down.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_right.gif&lt;br /&gt;
 - theme/img/folder/shared_dis.gif &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
All icons under the folder /themes/[theme name]/ will be separated by their size. You will find three different sub-folders here: 16 (for 16x16 pixel icons), 24 and 36. Some icons may be available in several folders. Some icons can also be found in their old location under /themes/[theme name]/img/. In the future, all icons will be found in the new icons folder and not in the img folder.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
16/attachment_add.png&lt;br /&gt;
16/attachment_open.png&lt;br /&gt;
16/attachment_remove.png&lt;br /&gt;
16/calendar_move.png&lt;br /&gt;
16/confirmation_change.png&lt;br /&gt;
16/contact_copy.png&lt;br /&gt;
16/contact_move.png&lt;br /&gt;
16/current_version.png&lt;br /&gt;
16/delete_folder.png&lt;br /&gt;
16/delete.png&lt;br /&gt;
16/distributionlist_extcontact.png&lt;br /&gt;
16/dummy.gif&lt;br /&gt;
16/duplicate_contacts.png&lt;br /&gt;
16/folder_closed.png&lt;br /&gt;
16/folder_opened.png&lt;br /&gt;
16/infostore_move.png&lt;br /&gt;
16/lock.png&lt;br /&gt;
16/mail_copy.png&lt;br /&gt;
16/mail_move.png&lt;br /&gt;
16/mail_source.png&lt;br /&gt;
16/mark_as.png&lt;br /&gt;
16/member_add.png&lt;br /&gt;
16/member_remove.png&lt;br /&gt;
16/mod_calendar.png&lt;br /&gt;
16/mod_configuration.png&lt;br /&gt;
16/mod_contacts.png&lt;br /&gt;
16/mod_infostore.png&lt;br /&gt;
16/mod_mail.png&lt;br /&gt;
16/mod_portal.png&lt;br /&gt;
16/mod_tasks.png&lt;br /&gt;
16/print.png&lt;br /&gt;
16/save.png&lt;br /&gt;
16/search.png&lt;br /&gt;
16/send_as_attachment.png&lt;br /&gt;
16/send_as_link.png&lt;br /&gt;
16/task_copy.png&lt;br /&gt;
16/task_move.png&lt;br /&gt;
16/teamchange.png&lt;br /&gt;
16/unlock.png&lt;br /&gt;
16/user.png&lt;br /&gt;
16/userrights_delete.png&lt;br /&gt;
16/userrights.png&lt;br /&gt;
16/userrights_read.png&lt;br /&gt;
16/userrights_remove.png&lt;br /&gt;
16/userrights_write.png&lt;br /&gt;
&lt;br /&gt;
24/attachment_add.png&lt;br /&gt;
24/attachment_remove.png&lt;br /&gt;
24/cancel.png&lt;br /&gt;
24/card_view.png&lt;br /&gt;
24/category_add.png&lt;br /&gt;
24/category_remove.png&lt;br /&gt;
24/confirmation_change.png&lt;br /&gt;
24/delete.png&lt;br /&gt;
24/detail_view.png&lt;br /&gt;
24/distributionlist.png&lt;br /&gt;
24/draft.png&lt;br /&gt;
24/dummy.gif&lt;br /&gt;
24/edit.png&lt;br /&gt;
24/externalview_add.png&lt;br /&gt;
24/externalview_disable.png&lt;br /&gt;
24/externalview_edit.png&lt;br /&gt;
24/externalview_enable.png&lt;br /&gt;
24/externalview_remove.png&lt;br /&gt;
24/forward.png&lt;br /&gt;
24/h_split_view.png&lt;br /&gt;
24/inbox.png&lt;br /&gt;
24/list_view.png&lt;br /&gt;
24/mail_copy.png&lt;br /&gt;
24/mail_move.png&lt;br /&gt;
24/mail_send.png&lt;br /&gt;
24/mail_write.png&lt;br /&gt;
24/member_add.png&lt;br /&gt;
24/member_remove.png&lt;br /&gt;
24/mod_calendar.png&lt;br /&gt;
24/mod_configuration.png&lt;br /&gt;
24/mod_contacts.png&lt;br /&gt;
24/mod_foldertree.png&lt;br /&gt;
24/mod_infostore.png&lt;br /&gt;
24/mod_mail.png&lt;br /&gt;
24/mod_portal.png&lt;br /&gt;
24/mod_tasks.png&lt;br /&gt;
24/options.png&lt;br /&gt;
24/picture_add.png&lt;br /&gt;
24/picture_remove.png&lt;br /&gt;
24/print.png&lt;br /&gt;
24/reply_all.png&lt;br /&gt;
24/reply.png&lt;br /&gt;
24/save_as_link.png&lt;br /&gt;
24/save.png&lt;br /&gt;
24/tag_10.png&lt;br /&gt;
24/tag_1.png&lt;br /&gt;
24/tag_2.png&lt;br /&gt;
24/tag_3.png&lt;br /&gt;
24/tag_4.png&lt;br /&gt;
24/tag_5.png&lt;br /&gt;
24/tag_6.png&lt;br /&gt;
24/tag_7.png&lt;br /&gt;
24/tag_8.png&lt;br /&gt;
24/tag_9.png&lt;br /&gt;
24/tag_remove.png&lt;br /&gt;
24/task_copy.png&lt;br /&gt;
24/task_move.png&lt;br /&gt;
24/teamchange.png&lt;br /&gt;
24/v_split_view.png&lt;br /&gt;
&lt;br /&gt;
32/attachment_add.png&lt;br /&gt;
32/attachment_remove.png&lt;br /&gt;
32/cancel.png&lt;br /&gt;
32/category_add.png&lt;br /&gt;
32/category_remove.png&lt;br /&gt;
32/confirmation_change.png&lt;br /&gt;
32/delete.png&lt;br /&gt;
32/distributionlist.png&lt;br /&gt;
32/draft.png&lt;br /&gt;
32/dummy.gif&lt;br /&gt;
32/edit.png&lt;br /&gt;
32/externalview_add.png&lt;br /&gt;
32/externalview_disable.png&lt;br /&gt;
32/externalview_edit.png&lt;br /&gt;
32/externalview_enable.png&lt;br /&gt;
32/externalview_remove.png&lt;br /&gt;
32/forward.png&lt;br /&gt;
32/import.png&lt;br /&gt;
32/mail_copy.png&lt;br /&gt;
32/mail_move.png&lt;br /&gt;
32/mail_send.png&lt;br /&gt;
32/mail_write.png&lt;br /&gt;
32/member_add.png&lt;br /&gt;
32/member_remove.png&lt;br /&gt;
32/mod_calendar.png&lt;br /&gt;
32/mod_configuration.png&lt;br /&gt;
32/mod_contacts.png&lt;br /&gt;
32/mod_infostore.png&lt;br /&gt;
32/mod_mail.png&lt;br /&gt;
32/mod_portal.png&lt;br /&gt;
32/mod_tasks.png&lt;br /&gt;
32/options.png&lt;br /&gt;
32/picture_add.png&lt;br /&gt;
32/picture_remove.png&lt;br /&gt;
32/print.png&lt;br /&gt;
32/reply_all.png&lt;br /&gt;
32/reply.png&lt;br /&gt;
32/save_as_link.png&lt;br /&gt;
32/save.png&lt;br /&gt;
32/tag_10.png&lt;br /&gt;
32/tag_1.png&lt;br /&gt;
32/tag_2.png&lt;br /&gt;
32/tag_3.png&lt;br /&gt;
32/tag_4.png&lt;br /&gt;
32/tag_5.png&lt;br /&gt;
32/tag_6.png&lt;br /&gt;
32/tag_7.png&lt;br /&gt;
32/tag_8.png&lt;br /&gt;
32/tag_9.png&lt;br /&gt;
32/tag_remove.png&lt;br /&gt;
32/task_copy.png&lt;br /&gt;
32/task_move.png&lt;br /&gt;
32/teamchange.png&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/toolbar/toolbar_bg.gif&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=8990</id>
		<title>ThemeChanges</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=8990"/>
		<updated>2011-09-23T15:33:58Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Changes from 6.20 to Public Patch Release 2011-09-22 for 6.20 (Rev 27) */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;=Changes from 6.20 to Public Patch Release 2011-09-22 for 6.20 (Rev 27 built 2011-09-22) =&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
No CSS files removed.&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/bgimages.css&lt;br /&gt;
 - theme/css/global.css&lt;br /&gt;
 - theme/css/popus.css &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.bg-toolbar-compact {&lt;br /&gt;
    background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header-handle {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 24px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    line-height: 22px;&lt;br /&gt;
    padding-left: 10px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit/IE9 */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr=&#039;#ffffff&#039;, endColorstr=&#039;#efefef&#039;);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button,&lt;br /&gt;
.ox-portal-widget .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.ox-button.ox-button-disabled,&lt;br /&gt;
.ox-button.default.ox-button-disabled&lt;br /&gt;
.ox-button.dark.ox-button-disabled {&lt;br /&gt;
    color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover, .ox-button:focus {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in popup.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
#wizzardPublishImageTank .linkstyle {&lt;br /&gt;
	cursor: default !important;&lt;br /&gt;
	text-decoration: none !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span,&lt;br /&gt;
#wizzardPublishImageTank .linkstyle a {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.2 to 6.20 =&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files in this release.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/newwindow.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .topheader-l {&lt;br /&gt;
  background-image: url(../img/border/topheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-tl {&lt;br /&gt;
  background-image: url(../img/border/topheader-tl.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-t {&lt;br /&gt;
  background-image: url(../img/border/topheader-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-tr {&lt;br /&gt;
  background-image: url(../img/border/topheader-tr.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-r {&lt;br /&gt;
  background-image: url(../img/border/topheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }		&lt;br /&gt;
&lt;br /&gt;
 .topheaderactive-t {&lt;br /&gt;
  background-image: url(../img/border/topheaderactive-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .calbody-r {&lt;br /&gt;
  background-image: url(../img/border/calbody-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .oxheader-l {&lt;br /&gt;
  background-image: url(../img/border/oxheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
			&lt;br /&gt;
 .oxheader-r {&lt;br /&gt;
  background-image: url(../img/border/oxheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .cpbody-size {&lt;br /&gt;
  left: 4px;&lt;br /&gt;
  right: 4px;&lt;br /&gt;
  width: 4px;&lt;br /&gt;
  top: 1px;&lt;br /&gt;
  bottom: 1px;&lt;br /&gt;
  height: 1px;&lt;br /&gt;
 }	&lt;br /&gt;
&lt;br /&gt;
 .cpbottom-size {&lt;br /&gt;
  left: 12px;&lt;br /&gt;
  right: 12px;&lt;br /&gt;
  width: 12px;&lt;br /&gt;
  top: 20px;&lt;br /&gt;
  bottom: 20px;&lt;br /&gt;
  height: 20px;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .expandButton {&lt;br /&gt;
  background-image:url(&amp;quot;../img/arrows/arrow_gray_down.gif&amp;quot;);	&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .sp-toggle&lt;br /&gt;
 {&lt;br /&gt;
  background-image:url(../img/border/spback.gif);&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in branding.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 #header {&lt;br /&gt;
  top: 0px !important; /* change this to branding height */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #header-decorator {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #notheader {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in calendar.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.kwSeparationBackGround {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.offTimeBackground {&lt;br /&gt;
    background-color : #E4E8FA;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.workTimeBackground {&lt;br /&gt;
    background-color : #F2F6FA;&lt;br /&gt;
}&lt;br /&gt;
.wholeDayBackground {&lt;br /&gt;
    background-color: #dddddd;&lt;br /&gt;
}&lt;br /&gt;
.appointmentTitleBG {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appointmentViewHeadBG {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
    border-top: 1px solid;  &lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.strokeCalendar {&lt;br /&gt;
    border-color : #D1D8DD !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.sectionStrokeCalendar {&lt;br /&gt;
    border-color : #a5b5bf !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSliderBox {&lt;br /&gt;
    border-top: 1px solid #3066c5;&lt;br /&gt;
    border-bottom: 1px solid #3066c5;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSlider {&lt;br /&gt;
    border: 1px solid #999;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_control_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .leftColumn .rowSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .dataGrid .appointment.isSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
 /* customs */&lt;br /&gt;
&lt;br /&gt;
#cwwtimecontent &amp;gt; tbody &amp;gt; tr &amp;gt; td &amp;gt; table &amp;gt; tbody &amp;gt; tr &amp;gt; td:first-child {&lt;br /&gt;
    background-color: #ff0000;&lt;br /&gt;
    width: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cww_timeline {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cww-timeline-font {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
    color: #333;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cwwheaderresize &amp;gt; table {&lt;br /&gt;
    height: 100%;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appInWeekView, .appInMonthView, .showAppointmentTextMonthFull {&lt;br /&gt;
	background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.todayBackground {&lt;br /&gt;
    background-color: #fc0 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in iframe.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
html, body {&lt;br /&gt;
    font-family: Arial, Helvetica, sans-serif; &lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.plainTextContent {&lt;br /&gt;
    font-family: monospace, Courier New;&lt;br /&gt;
    line-height: 1.5em;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Rainbow quoting */&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote {&lt;br /&gt;
	border-left: 2px solid #364e9b !important; /* blue */&lt;br /&gt;
	background-color: #f5f7ff;&lt;br /&gt;
    color: #1a254a !important;&lt;br /&gt;
    margin-right: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote {&lt;br /&gt;
    border-color: #366a9b !important; /* cyan */&lt;br /&gt;
    background-color: #e6f3ff;&lt;br /&gt;
    color: #1e3b56 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #3c7027 !important; /* green */&lt;br /&gt;
    background-color: #edffe6;&lt;br /&gt;
    color: #192e10 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #efc000 !important; /* orange */&lt;br /&gt;
    background-color: #fffae6;&lt;br /&gt;
    color: #713200 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #5c1111 !important; /* red*/&lt;br /&gt;
    background-color: #ffeeee;&lt;br /&gt;
    color: #751000 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #801062 !important; /* pink */&lt;br /&gt;
    background-color: #ffeffb;&lt;br /&gt;
    color: #3c072e !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #240a4f !important; /* violet */&lt;br /&gt;
    background-color: #f1e9ff;&lt;br /&gt;
    color: #3a1081 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #333 !important; /* gray */&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    color: #333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #555 !important; /* black */&lt;br /&gt;
    background-color: #fff;&lt;br /&gt;
    color: #111 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in popuo.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.popupHeaderBackground {&lt;br /&gt;
	background-color: #bbb !important;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivOver {&lt;br /&gt;
	background-color:#bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActive {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActiveNoPadding {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.popup-header, .listDialogue td.listDialogueHeader {&lt;br /&gt;
	font-weight: bold;&lt;br /&gt;
	color: #000;&lt;br /&gt;
	background-image: url(../img/panels/miniviewHeader_b.gif);	&lt;br /&gt;
	background-color: #bbb;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
body {&lt;br /&gt;
	background-color: #cccccc; /* was #a9b2c5 */&lt;br /&gt;
	font-family: Arial, Helvetica, sans-serif;&lt;br /&gt;
	font-size: 9pt;&lt;br /&gt;
	color:#000;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.webkit body {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 50%, 0% 100%, from(#ccc), to(#333)); /* ccc to 555 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.firefox body {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #eee, #555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.font-style-person, .font-color-person {&lt;br /&gt;
    color: #344F70;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cpheader-color {&lt;br /&gt;
	background-color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.topHeaderBG, .topheader-color {&lt;br /&gt;
	background-color: #444;	/* was #65769b */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.background-color-content, .cpbody-color {&lt;br /&gt;
	background-color: #f5f5f5 !important;&lt;br /&gt;
}&lt;br /&gt;
(was .background-color-content, .cpbody-color, .calbody-color)&lt;br /&gt;
&lt;br /&gt;
.background-color-PMG-selection-elements {&lt;br /&gt;
	background-color: #bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.entrySelDiv {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*live grid selection*/&lt;br /&gt;
.selected {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.selectedfocused {&lt;br /&gt;
	border-color: #607090 !important;&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont {&lt;br /&gt;
	background-color: white !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont, .mailDetailAttachmentsContSel {&lt;br /&gt;
    border-color: #C0C0C0 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dndOver {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
	border-color: #bdd3eb !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.browsercheck {&lt;br /&gt;
	background-image: url(../img/browsercheck.png);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#sidepanel_dragpoint_background {&lt;br /&gt;
    background-color: #ddd;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit #sidepanel_dragpoint_background {&lt;br /&gt;
    -webkit-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox #sidepanel_dragpoint_background {&lt;br /&gt;
    -moz-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #sidesplit {&lt;br /&gt;
    border-right: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #mainarea {&lt;br /&gt;
    border-left: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dropdownbox .comboboxColumn2 {&lt;br /&gt;
    background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
#menu_search_mail_context, #menu_search_context {&lt;br /&gt;
	background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl {&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-sidepanel-title {&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl a {&lt;br /&gt;
	color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    background-color: #666; /* was #455069 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTabCurrent, div.oxTabControl td.oxTabCurrent:hover {&lt;br /&gt;
    color: #000;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-top: 2px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*&lt;br /&gt;
 * Portal &lt;br /&gt;
 */&lt;br /&gt;
&lt;br /&gt;
.ox-portal {&lt;br /&gt;
    background-color: white; /* body: A9B2C5 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top , #FFFFFF, #DDDDDD);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#DDDDDD));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-placeholder {&lt;br /&gt;
    border: 2px dashed #888;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget */&lt;br /&gt;
.ox-portal-widget {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    padding: 0px 0px 8px 0px;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -moz-border-radius: 8px;&lt;br /&gt;
    -moz-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -webkit-border-radius: 8px;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* IE gets no radius, no shadow */&lt;br /&gt;
.IE .ox-portal-widget {&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget header */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit */&lt;br /&gt;
.firefox .ox-portal-header {&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-header {&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* close/remove button */&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* controls */&lt;br /&gt;
.ox-portal-topbar {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-bottom: 1px solid #aaa;&lt;br /&gt;
    color: #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar i {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	font-style: normal;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar b {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	color: #999;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar a {&lt;br /&gt;
    color: #00f;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    text-decoration: underline;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls, .ox-quick-config {&lt;br /&gt;
	background-color: #444;&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-controls, .firefox .ox-quick-config {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-controls, .webkit .ox-quick-config {&lt;br /&gt;
	background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config table {&lt;br /&gt;
	margin: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config td, .ox-quick-config th {&lt;br /&gt;
	padding: 0px 20px 5px 0px;&lt;br /&gt;
	vertical-align: top;&lt;br /&gt;
	white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config th {&lt;br /&gt;
    color: #8AC2FF;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    text-align: left;&lt;br /&gt;
    padding-bottom: 2px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls label, .ox-quick-config label {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout {&lt;br /&gt;
	width: 90px;&lt;br /&gt;
	height: 60px;&lt;br /&gt;
    background-image: url(../img/portal/layouts.png);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    margin: 2px 22px 2px 2px;&lt;br /&gt;
    border: 0px none;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.one {&lt;br /&gt;
	background-position: 0px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.two {&lt;br /&gt;
    background-position: -90px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.three {&lt;br /&gt;
    background-position: -180px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.four {&lt;br /&gt;
    background-position: -270px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.five {&lt;br /&gt;
    background-position: -360px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.active, .ox-portal-layout.active:hover {&lt;br /&gt;
	background-color: #67789D;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
	-webkit-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout:hover {&lt;br /&gt;
	background-color: #888;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* &lt;br /&gt;
 * Button&lt;br /&gt;
 */&lt;br /&gt;
.ox-button {&lt;br /&gt;
	font-size: 8pt;&lt;br /&gt;
	line-height: 1.5em;&lt;br /&gt;
    border-radius: 5px;&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
    color: black;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    padding: 5px 1em 5px 1em;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    display: inline-block;&lt;br /&gt;
    vertical-align: middle;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark {&lt;br /&gt;
    background-color: #333;&lt;br /&gt;
    border: 1px solid #222;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* firefox */&lt;br /&gt;
.ox-button.firefox {&lt;br /&gt;
	-moz-border-radius: 5px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.firefox {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #555555, #333333);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.firefox:hover {&lt;br /&gt;
	-moz-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* webkit */&lt;br /&gt;
.ox-button.webkit {&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.webkit {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#555555), to(#333333));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.webkit:hover {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows */&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-decorator {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px; &lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    background-color: black; &lt;br /&gt;
    opacity: 0.10;&lt;br /&gt;
    filter: alpha(opacity=10);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-container {&lt;br /&gt;
    position: absolute; &lt;br /&gt;
    top: 0px; &lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 50%; &lt;br /&gt;
    margin-left: 0px; /* use to center */&lt;br /&gt;
    width: 0px; /* live parameter; override with !important */&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    visibility: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-container {&lt;br /&gt;
    -moz-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-container {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE .ox-embedded-container {&lt;br /&gt;
    border: 1px solid #333;&lt;br /&gt;
    border-width: 0px 1px 0px 1px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-title {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    line-height: 12px;&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    text-align: center;&lt;br /&gt;
    padding: 9px 20px 8px 10px;&lt;br /&gt;
    color: #ccc;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    border-bottom: 1px solid #333;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-title {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111, #444);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-title {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111), to(#444));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 7px;&lt;br /&gt;
    right: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close img {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/x.png);&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-iframe {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 30px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows: dock */&lt;br /&gt;
&lt;br /&gt;
.ox-dock {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    color: black;&lt;br /&gt;
    border-top: 1px solid #333;&lt;br /&gt;
    height: 33px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    z-index: 65000;&lt;br /&gt;
    display: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-tab {&lt;br /&gt;
    background-color: #222;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    border: 1px solid black;&lt;br /&gt;
    border-width: 0px 1px 1px 1px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    padding: 4px 10px 4px 10px;&lt;br /&gt;
    margin: 0px 0px 0px 5px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    height: 1.5em;&lt;br /&gt;
    color: white;&lt;br /&gt;
    border-radius: 0px 0px 8px 8px;&lt;br /&gt;
        &lt;br /&gt;
    position: relative;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    overflow: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-tab {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #333333);&lt;br /&gt;
    -moz-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-tab {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#333333));&lt;br /&gt;
    -webkit-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-selected {&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-selected {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #666);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-selected {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#666));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Context-menu button */&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.weekDivMonthView .background-color-content{&lt;br /&gt;
    background-color: #ffdaab !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/icons/16/calendar_dis.png&lt;br /&gt;
 - theme/icons/16/calendar.png&lt;br /&gt;
 - theme/icons/16/contacts_dis.png&lt;br /&gt;
 - theme/icons/16/contacts.png&lt;br /&gt;
 - theme/icons/16/draft_dis.png&lt;br /&gt;
 - theme/icons/16/draft.png&lt;br /&gt;
 - theme/icons/16/facebook.png&lt;br /&gt;
 - theme/icons/16/folder_closed_dis.png&lt;br /&gt;
 - theme/icons/16/folder_opened_dis.png&lt;br /&gt;
 - theme/icons/16/forward.png&lt;br /&gt;
 - theme/icons/16/garbage_dis.png&lt;br /&gt;
 - theme/icons/16/garbage.png&lt;br /&gt;
 - theme/icons/16/ham_dis.png&lt;br /&gt;
 - theme/icons/16/ham.png&lt;br /&gt;
 - theme/icons/16/inbox_dis.png&lt;br /&gt;
 - theme/icons/16/inbox.png&lt;br /&gt;
 - theme/icons/16/infostore_dis.png&lt;br /&gt;
 - theme/icons/16/infostore.png&lt;br /&gt;
 - theme/icons/16/mail_dis.png&lt;br /&gt;
 - theme/icons/16/mail.png&lt;br /&gt;
 - theme/icons/16/outbox_dis.png&lt;br /&gt;
 - theme/icons/16/outbox.png&lt;br /&gt;
 - theme/icons/16/public_dis.png&lt;br /&gt;
 - theme/icons/16/public.png&lt;br /&gt;
 - theme/icons/16/rss.png&lt;br /&gt;
 - theme/icons/16/shared_dis.png&lt;br /&gt;
 - theme/icons/16/shared_globe.png&lt;br /&gt;
 - theme/icons/16/shared.png&lt;br /&gt;
 - theme/icons/16/spam_dis.png&lt;br /&gt;
 - theme/icons/16/spam.png&lt;br /&gt;
 - theme/icons/16/tasks_dis.png&lt;br /&gt;
 - theme/icons/16/tasks.png&lt;br /&gt;
 - theme/icons/16/twitter.png&lt;br /&gt;
 - theme/icons/16/user_dis.png&lt;br /&gt;
&lt;br /&gt;
 - theme/icons/24/calendar_move.png&lt;br /&gt;
 - theme/icons/24/distributionlist_extcontact.png&lt;br /&gt;
 - theme/icons/24/ham.png&lt;br /&gt;
 - theme/icons/24/mark_as_done.png&lt;br /&gt;
 - theme/icons/24/mark_as.png&lt;br /&gt;
 - theme/icons/24/spam.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/arrows/arrow_white_down.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/slider_background.png&lt;br /&gt;
 - theme/img/calendar/slider_control_background.png&lt;br /&gt;
&lt;br /&gt;
 - themes/portal/layouts.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/browsercheck.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.gif&lt;br /&gt;
 changed to a png image&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/calbody-r.png&lt;br /&gt;
 - theme/img/border/cpbody-l.png&lt;br /&gt;
 - theme/img/border/cpbody-r.png&lt;br /&gt;
 - theme/img/border/cpbottom-b.png&lt;br /&gt;
 - theme/img/border/cpbottom-bl.png&lt;br /&gt;
 - theme/img/border/cpbottom-l.png&lt;br /&gt;
 - theme/img/border/cpbottom-r.png&lt;br /&gt;
 - theme/img/border/cpheader-l.png&lt;br /&gt;
 - theme/img/border/cpheader-r.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-ll.png&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-rr.png&lt;br /&gt;
 - theme/img/border/popup/popup-border-imagemap.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31.gif&lt;br /&gt;
 All icons have changed from gif to png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/infostore/mimetypes/vcard.gif&lt;br /&gt;
&lt;br /&gt;
 - theme/img/panels/miniviewHeader_b.gif&lt;br /&gt;
&lt;br /&gt;
 - themes/img/x.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1_sel.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31_sel.gif&lt;br /&gt;
 All icons with the _sel ending have been removed&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.1 to 6.18.2=&lt;br /&gt;
&lt;br /&gt;
===New CSS file===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/branding.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
- theme/css/global.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-person {&lt;br /&gt;
    		color: #215696;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	#window-header-decorator {&lt;br /&gt;
    		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
    		background-repeat: repeat-x;&lt;br /&gt;
    		background-color: #ddd;&lt;br /&gt;
    		border-bottom: 1px solid #bbb;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
		background-repeat: repeat-x;&lt;br /&gt;
		border-top: 0px none;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable.border-color-design {&lt;br /&gt;
		border-color: #aaa !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse, div.oxTabControlToggle {&lt;br /&gt;
		background-repeat: no-repeat;&lt;br /&gt;
		background-position: 3px 5px;&lt;br /&gt;
		width: 15px;&lt;br /&gt;
		height: 15px;&lt;br /&gt;
		float: right;&lt;br /&gt;
		margin: 5px 9px;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_down.gif);&lt;br /&gt;
		cursor: s-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggle {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_up.gif);&lt;br /&gt;
		cursor: n-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl {&lt;br /&gt;
	    background-color: #65769B;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.ox-sidepanel-view-title {&lt;br /&gt;
		color: white;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl a {&lt;br /&gt;
		color: #eee;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    		background-color: #455069;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Change elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color:#404962;  &lt;br /&gt;
		font-weight : bold; &lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color: #333;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	#notheader {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	#header-decorator {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.tr_h {&lt;br /&gt;
    		background-color: #e3e3e3 !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.tr_h {&lt;br /&gt;
		background-color: #eaeaea !important;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_down.gif&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_up.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_down.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_right.gif&lt;br /&gt;
 - theme/img/folder/shared_dis.gif &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
All icons under the folder /themes/[theme name]/ will be separated by their size. You will find three different sub-folders here: 16 (for 16x16 pixel icons), 24 and 36. Some icons may be available in several folders. Some icons can also be found in their old location under /themes/[theme name]/img/. In the future, all icons will be found in the new icons folder and not in the img folder.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
16/attachment_add.png&lt;br /&gt;
16/attachment_open.png&lt;br /&gt;
16/attachment_remove.png&lt;br /&gt;
16/calendar_move.png&lt;br /&gt;
16/confirmation_change.png&lt;br /&gt;
16/contact_copy.png&lt;br /&gt;
16/contact_move.png&lt;br /&gt;
16/current_version.png&lt;br /&gt;
16/delete_folder.png&lt;br /&gt;
16/delete.png&lt;br /&gt;
16/distributionlist_extcontact.png&lt;br /&gt;
16/dummy.gif&lt;br /&gt;
16/duplicate_contacts.png&lt;br /&gt;
16/folder_closed.png&lt;br /&gt;
16/folder_opened.png&lt;br /&gt;
16/infostore_move.png&lt;br /&gt;
16/lock.png&lt;br /&gt;
16/mail_copy.png&lt;br /&gt;
16/mail_move.png&lt;br /&gt;
16/mail_source.png&lt;br /&gt;
16/mark_as.png&lt;br /&gt;
16/member_add.png&lt;br /&gt;
16/member_remove.png&lt;br /&gt;
16/mod_calendar.png&lt;br /&gt;
16/mod_configuration.png&lt;br /&gt;
16/mod_contacts.png&lt;br /&gt;
16/mod_infostore.png&lt;br /&gt;
16/mod_mail.png&lt;br /&gt;
16/mod_portal.png&lt;br /&gt;
16/mod_tasks.png&lt;br /&gt;
16/print.png&lt;br /&gt;
16/save.png&lt;br /&gt;
16/search.png&lt;br /&gt;
16/send_as_attachment.png&lt;br /&gt;
16/send_as_link.png&lt;br /&gt;
16/task_copy.png&lt;br /&gt;
16/task_move.png&lt;br /&gt;
16/teamchange.png&lt;br /&gt;
16/unlock.png&lt;br /&gt;
16/user.png&lt;br /&gt;
16/userrights_delete.png&lt;br /&gt;
16/userrights.png&lt;br /&gt;
16/userrights_read.png&lt;br /&gt;
16/userrights_remove.png&lt;br /&gt;
16/userrights_write.png&lt;br /&gt;
&lt;br /&gt;
24/attachment_add.png&lt;br /&gt;
24/attachment_remove.png&lt;br /&gt;
24/cancel.png&lt;br /&gt;
24/card_view.png&lt;br /&gt;
24/category_add.png&lt;br /&gt;
24/category_remove.png&lt;br /&gt;
24/confirmation_change.png&lt;br /&gt;
24/delete.png&lt;br /&gt;
24/detail_view.png&lt;br /&gt;
24/distributionlist.png&lt;br /&gt;
24/draft.png&lt;br /&gt;
24/dummy.gif&lt;br /&gt;
24/edit.png&lt;br /&gt;
24/externalview_add.png&lt;br /&gt;
24/externalview_disable.png&lt;br /&gt;
24/externalview_edit.png&lt;br /&gt;
24/externalview_enable.png&lt;br /&gt;
24/externalview_remove.png&lt;br /&gt;
24/forward.png&lt;br /&gt;
24/h_split_view.png&lt;br /&gt;
24/inbox.png&lt;br /&gt;
24/list_view.png&lt;br /&gt;
24/mail_copy.png&lt;br /&gt;
24/mail_move.png&lt;br /&gt;
24/mail_send.png&lt;br /&gt;
24/mail_write.png&lt;br /&gt;
24/member_add.png&lt;br /&gt;
24/member_remove.png&lt;br /&gt;
24/mod_calendar.png&lt;br /&gt;
24/mod_configuration.png&lt;br /&gt;
24/mod_contacts.png&lt;br /&gt;
24/mod_foldertree.png&lt;br /&gt;
24/mod_infostore.png&lt;br /&gt;
24/mod_mail.png&lt;br /&gt;
24/mod_portal.png&lt;br /&gt;
24/mod_tasks.png&lt;br /&gt;
24/options.png&lt;br /&gt;
24/picture_add.png&lt;br /&gt;
24/picture_remove.png&lt;br /&gt;
24/print.png&lt;br /&gt;
24/reply_all.png&lt;br /&gt;
24/reply.png&lt;br /&gt;
24/save_as_link.png&lt;br /&gt;
24/save.png&lt;br /&gt;
24/tag_10.png&lt;br /&gt;
24/tag_1.png&lt;br /&gt;
24/tag_2.png&lt;br /&gt;
24/tag_3.png&lt;br /&gt;
24/tag_4.png&lt;br /&gt;
24/tag_5.png&lt;br /&gt;
24/tag_6.png&lt;br /&gt;
24/tag_7.png&lt;br /&gt;
24/tag_8.png&lt;br /&gt;
24/tag_9.png&lt;br /&gt;
24/tag_remove.png&lt;br /&gt;
24/task_copy.png&lt;br /&gt;
24/task_move.png&lt;br /&gt;
24/teamchange.png&lt;br /&gt;
24/v_split_view.png&lt;br /&gt;
&lt;br /&gt;
32/attachment_add.png&lt;br /&gt;
32/attachment_remove.png&lt;br /&gt;
32/cancel.png&lt;br /&gt;
32/category_add.png&lt;br /&gt;
32/category_remove.png&lt;br /&gt;
32/confirmation_change.png&lt;br /&gt;
32/delete.png&lt;br /&gt;
32/distributionlist.png&lt;br /&gt;
32/draft.png&lt;br /&gt;
32/dummy.gif&lt;br /&gt;
32/edit.png&lt;br /&gt;
32/externalview_add.png&lt;br /&gt;
32/externalview_disable.png&lt;br /&gt;
32/externalview_edit.png&lt;br /&gt;
32/externalview_enable.png&lt;br /&gt;
32/externalview_remove.png&lt;br /&gt;
32/forward.png&lt;br /&gt;
32/import.png&lt;br /&gt;
32/mail_copy.png&lt;br /&gt;
32/mail_move.png&lt;br /&gt;
32/mail_send.png&lt;br /&gt;
32/mail_write.png&lt;br /&gt;
32/member_add.png&lt;br /&gt;
32/member_remove.png&lt;br /&gt;
32/mod_calendar.png&lt;br /&gt;
32/mod_configuration.png&lt;br /&gt;
32/mod_contacts.png&lt;br /&gt;
32/mod_infostore.png&lt;br /&gt;
32/mod_mail.png&lt;br /&gt;
32/mod_portal.png&lt;br /&gt;
32/mod_tasks.png&lt;br /&gt;
32/options.png&lt;br /&gt;
32/picture_add.png&lt;br /&gt;
32/picture_remove.png&lt;br /&gt;
32/print.png&lt;br /&gt;
32/reply_all.png&lt;br /&gt;
32/reply.png&lt;br /&gt;
32/save_as_link.png&lt;br /&gt;
32/save.png&lt;br /&gt;
32/tag_10.png&lt;br /&gt;
32/tag_1.png&lt;br /&gt;
32/tag_2.png&lt;br /&gt;
32/tag_3.png&lt;br /&gt;
32/tag_4.png&lt;br /&gt;
32/tag_5.png&lt;br /&gt;
32/tag_6.png&lt;br /&gt;
32/tag_7.png&lt;br /&gt;
32/tag_8.png&lt;br /&gt;
32/tag_9.png&lt;br /&gt;
32/tag_remove.png&lt;br /&gt;
32/task_copy.png&lt;br /&gt;
32/task_move.png&lt;br /&gt;
32/teamchange.png&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/toolbar/toolbar_bg.gif&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=8989</id>
		<title>ThemeChanges</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=ThemeChanges&amp;diff=8989"/>
		<updated>2011-09-23T15:27:24Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Changes from 6.20 to Public Patch Release 2011-09-22 for 6.20 (Rev 27 built 2011-09-22)&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;=Changes from 6.20 to Public Patch Release 2011-09-22 for 6.20 (Rev 27 built 2011-09-22) =&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
No CSS files removed.&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/bgimages.css&lt;br /&gt;
 - theme/css/global.css&lt;br /&gt;
 - theme/css/popus.css &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.bg-toolbar-compact {&lt;br /&gt;
    background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header-handle {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 24px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    line-height: 22px;&lt;br /&gt;
    padding-left: 10px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit/IE9 */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr=&#039;#ffffff&#039;, endColorstr=&#039;#efefef&#039;);&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button,&lt;br /&gt;
.ox-portal-widget .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
.ox-button.ox-button-disabled,&lt;br /&gt;
.ox-button.default.ox-button-disabled&lt;br /&gt;
.ox-button.dark.ox-button-disabled {&lt;br /&gt;
    color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover, .ox-button:focus {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed elements in popup.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
#wizzardPublishImageTank .linkstyle {&lt;br /&gt;
	cursor: default !important;&lt;br /&gt;
	text-decoration: none !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
**********&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span,&lt;br /&gt;
#wizzardPublishImageTank .linkstyle a {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
   ... changed into ...&lt;br /&gt;
&lt;br /&gt;
#wizzardPublishImageTank .linkstyle span {&lt;br /&gt;
	cursor: pointer !important;&lt;br /&gt;
}&lt;br /&gt;
**********&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.2 to 6.20 =&lt;br /&gt;
&lt;br /&gt;
===New CSS files=== &lt;br /&gt;
No new CSS files in this release.&lt;br /&gt;
&lt;br /&gt;
===Removed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/newwindow.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .topheader-l {&lt;br /&gt;
  background-image: url(../img/border/topheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-tl {&lt;br /&gt;
  background-image: url(../img/border/topheader-tl.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .topheader-t {&lt;br /&gt;
  background-image: url(../img/border/topheader-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-tr {&lt;br /&gt;
  background-image: url(../img/border/topheader-tr.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
		&lt;br /&gt;
 .topheader-r {&lt;br /&gt;
  background-image: url(../img/border/topheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }		&lt;br /&gt;
&lt;br /&gt;
 .topheaderactive-t {&lt;br /&gt;
  background-image: url(../img/border/topheaderactive-t.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-x;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .calbody-r {&lt;br /&gt;
  background-image: url(../img/border/calbody-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .oxheader-l {&lt;br /&gt;
  background-image: url(../img/border/oxheader-l.png);&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
			&lt;br /&gt;
 .oxheader-r {&lt;br /&gt;
  background-image: url(../img/border/oxheader-r.png);&lt;br /&gt;
  background-position: 100% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in bgimages.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 .cpbody-size {&lt;br /&gt;
  left: 4px;&lt;br /&gt;
  right: 4px;&lt;br /&gt;
  width: 4px;&lt;br /&gt;
  top: 1px;&lt;br /&gt;
  bottom: 1px;&lt;br /&gt;
  height: 1px;&lt;br /&gt;
 }	&lt;br /&gt;
&lt;br /&gt;
 .cpbottom-size {&lt;br /&gt;
  left: 12px;&lt;br /&gt;
  right: 12px;&lt;br /&gt;
  width: 12px;&lt;br /&gt;
  top: 20px;&lt;br /&gt;
  bottom: 20px;&lt;br /&gt;
  height: 20px;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .expandButton {&lt;br /&gt;
  background-image:url(&amp;quot;../img/arrows/arrow_gray_down.gif&amp;quot;);	&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 .sp-toggle&lt;br /&gt;
 {&lt;br /&gt;
  background-image:url(../img/border/spback.gif);&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in branding.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 #header {&lt;br /&gt;
  top: 0px !important; /* change this to branding height */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #header-decorator {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
 #notheader {&lt;br /&gt;
  top: 30px !important; /* change this to branding height PLUS 30 */&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in calendar.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.kwSeparationBackGround {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.offTimeBackground {&lt;br /&gt;
    background-color : #E4E8FA;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.workTimeBackground {&lt;br /&gt;
    background-color : #F2F6FA;&lt;br /&gt;
}&lt;br /&gt;
.wholeDayBackground {&lt;br /&gt;
    background-color: #dddddd;&lt;br /&gt;
}&lt;br /&gt;
.appointmentTitleBG {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appointmentViewHeadBG {&lt;br /&gt;
    background-color: transparent;&lt;br /&gt;
    border-top: 1px solid;  &lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.strokeCalendar {&lt;br /&gt;
    border-color : #D1D8DD !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.sectionStrokeCalendar {&lt;br /&gt;
    border-color : #a5b5bf !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSliderBox {&lt;br /&gt;
    border-top: 1px solid #3066c5;&lt;br /&gt;
    border-bottom: 1px solid #3066c5;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.zoomSlider {&lt;br /&gt;
    border: 1px solid #999;&lt;br /&gt;
    background-image: url(&amp;quot;../img/calendar/slider_control_background.png&amp;quot;);&lt;br /&gt;
    background-repeat: repeat-x;&lt;br /&gt;
    -moz-border-radius: 5px;&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .leftColumn .rowSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.calendarGrid .dataGrid .appointment.isSelected {&lt;br /&gt;
    background-color: #BDD3EB !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
 /* customs */&lt;br /&gt;
&lt;br /&gt;
#cwwtimecontent &amp;gt; tbody &amp;gt; tr &amp;gt; td &amp;gt; table &amp;gt; tbody &amp;gt; tr &amp;gt; td:first-child {&lt;br /&gt;
    background-color: #ff0000;&lt;br /&gt;
    width: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cww_timeline {&lt;br /&gt;
    background-color: #FFFFFF;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cww-timeline-font {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
    color: #333;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#cwwheaderresize &amp;gt; table {&lt;br /&gt;
    height: 100%;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.appInWeekView, .appInMonthView, .showAppointmentTextMonthFull {&lt;br /&gt;
	background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.todayBackground {&lt;br /&gt;
    background-color: #fc0 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in iframe.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
html, body {&lt;br /&gt;
    font-family: Arial, Helvetica, sans-serif; &lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.plainTextContent {&lt;br /&gt;
    font-family: monospace, Courier New;&lt;br /&gt;
    line-height: 1.5em;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Rainbow quoting */&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote {&lt;br /&gt;
	border-left: 2px solid #364e9b !important; /* blue */&lt;br /&gt;
	background-color: #f5f7ff;&lt;br /&gt;
    color: #1a254a !important;&lt;br /&gt;
    margin-right: 0px !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote {&lt;br /&gt;
    border-color: #366a9b !important; /* cyan */&lt;br /&gt;
    background-color: #e6f3ff;&lt;br /&gt;
    color: #1e3b56 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #3c7027 !important; /* green */&lt;br /&gt;
    background-color: #edffe6;&lt;br /&gt;
    color: #192e10 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #efc000 !important; /* orange */&lt;br /&gt;
    background-color: #fffae6;&lt;br /&gt;
    color: #713200 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #5c1111 !important; /* red*/&lt;br /&gt;
    background-color: #ffeeee;&lt;br /&gt;
    color: #751000 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #801062 !important; /* pink */&lt;br /&gt;
    background-color: #ffeffb;&lt;br /&gt;
    color: #3c072e !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #240a4f !important; /* violet */&lt;br /&gt;
    background-color: #f1e9ff;&lt;br /&gt;
    color: #3a1081 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #333 !important; /* gray */&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    color: #333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
body.colored-quotes .plainTextContent blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote blockquote {&lt;br /&gt;
    border-color: #555 !important; /* black */&lt;br /&gt;
    background-color: #fff;&lt;br /&gt;
    color: #111 !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in popuo.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.popupHeaderBackground {&lt;br /&gt;
	background-color: #bbb !important;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivOver {&lt;br /&gt;
	background-color:#bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActive {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.PopupEntryDivActiveNoPadding {&lt;br /&gt;
	background-color:#bdd3eb !important;&lt;br /&gt;
	border-color:#bdd3eb;&lt;br /&gt;
	cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
.popup-header, .listDialogue td.listDialogueHeader {&lt;br /&gt;
	font-weight: bold;&lt;br /&gt;
	color: #000;&lt;br /&gt;
	background-image: url(../img/panels/miniviewHeader_b.gif);	&lt;br /&gt;
	background-color: #bbb;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New and changed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
body {&lt;br /&gt;
	background-color: #cccccc; /* was #a9b2c5 */&lt;br /&gt;
	font-family: Arial, Helvetica, sans-serif;&lt;br /&gt;
	font-size: 9pt;&lt;br /&gt;
	color:#000;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.webkit body {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 50%, 0% 100%, from(#ccc), to(#333)); /* ccc to 555 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
html.firefox body {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #eee, #555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.font-style-person, .font-color-person {&lt;br /&gt;
    color: #344F70;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.cpheader-color {&lt;br /&gt;
	background-color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.topHeaderBG, .topheader-color {&lt;br /&gt;
	background-color: #444;	/* was #65769b */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.background-color-content, .cpbody-color {&lt;br /&gt;
	background-color: #f5f5f5 !important;&lt;br /&gt;
}&lt;br /&gt;
(was .background-color-content, .cpbody-color, .calbody-color)&lt;br /&gt;
&lt;br /&gt;
.background-color-PMG-selection-elements {&lt;br /&gt;
	background-color: #bdd3eb !important; /* was #C6CCD9 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.entrySelDiv {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*live grid selection*/&lt;br /&gt;
.selected {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.selectedfocused {&lt;br /&gt;
	border-color: #607090 !important;&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont {&lt;br /&gt;
	background-color: white !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.mailDetailAttachmentsCont, .mailDetailAttachmentsContSel {&lt;br /&gt;
    border-color: #C0C0C0 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dndOver {&lt;br /&gt;
	background-color: #bdd3eb;&lt;br /&gt;
	border-color: #bdd3eb !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.browsercheck {&lt;br /&gt;
	background-image: url(../img/browsercheck.png);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
#sidepanel_dragpoint_background {&lt;br /&gt;
    background-color: #ddd;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit #sidepanel_dragpoint_background {&lt;br /&gt;
    -webkit-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox #sidepanel_dragpoint_background {&lt;br /&gt;
    -moz-box-shadow: inset 0 0 2px 0 black;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #sidesplit {&lt;br /&gt;
    border-right: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE #mainarea {&lt;br /&gt;
    border-left: 1px solid #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.dropdownbox .comboboxColumn2 {&lt;br /&gt;
    background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
#menu_search_mail_context, #menu_search_context {&lt;br /&gt;
	background-color: #333333 !important;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl {&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-sidepanel-title {&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl a {&lt;br /&gt;
	color: #eee;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    background-color: #666; /* was #455069 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
div.oxTabControl td.oxTabCurrent, div.oxTabControl td.oxTabCurrent:hover {&lt;br /&gt;
    color: #000;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-top: 2px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/*&lt;br /&gt;
 * Portal &lt;br /&gt;
 */&lt;br /&gt;
&lt;br /&gt;
.ox-portal {&lt;br /&gt;
    background-color: white; /* body: A9B2C5 */&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top , #FFFFFF, #DDDDDD);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#DDDDDD));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-placeholder {&lt;br /&gt;
    border: 2px dashed #888;&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget */&lt;br /&gt;
.ox-portal-widget {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    padding: 0px 0px 8px 0px;&lt;br /&gt;
    margin: 0px 0px 15px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -moz-border-radius: 8px;&lt;br /&gt;
    -moz-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-widget {&lt;br /&gt;
    -border-radius: 8px;&lt;br /&gt;
    -webkit-border-radius: 8px;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 3px 0px #555;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* IE gets no radius, no shadow */&lt;br /&gt;
.IE .ox-portal-widget {&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* portal widget header */&lt;br /&gt;
.ox-portal-header {&lt;br /&gt;
    background-color: #efefef;&lt;br /&gt;
    border-bottom: 1px solid #ccc;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    font-size: 9pt;&lt;br /&gt;
    color: #555;&lt;br /&gt;
    padding: 2px 8px 2px 8px;&lt;br /&gt;
    cursor: move;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* upper border radius and background gradient for Firefox/WebKit */&lt;br /&gt;
.firefox .ox-portal-header {&lt;br /&gt;
    -moz-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-header {&lt;br /&gt;
    -webkit-border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    border-radius: 8px 8px 0px 0px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* close/remove button */&lt;br /&gt;
.ox-portal-close {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/portal/btn_close.gif);&lt;br /&gt;
    margin: 2px 0px 0px 0px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* controls */&lt;br /&gt;
.ox-portal-topbar {&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    border-bottom: 1px solid #aaa;&lt;br /&gt;
    color: #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar i {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	font-style: normal;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar b {&lt;br /&gt;
	font-size: 12pt;&lt;br /&gt;
	color: #999;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-topbar a {&lt;br /&gt;
    color: #00f;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    text-decoration: underline;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls, .ox-quick-config {&lt;br /&gt;
	background-color: #444;&lt;br /&gt;
	color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-portal-controls, .firefox .ox-quick-config {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-portal-controls, .webkit .ox-quick-config {&lt;br /&gt;
	background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config table {&lt;br /&gt;
	margin: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config td, .ox-quick-config th {&lt;br /&gt;
	padding: 0px 20px 5px 0px;&lt;br /&gt;
	vertical-align: top;&lt;br /&gt;
	white-space: nowrap;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-quick-config th {&lt;br /&gt;
    color: #8AC2FF;&lt;br /&gt;
    font-weight: normal;&lt;br /&gt;
    text-align: left;&lt;br /&gt;
    padding-bottom: 2px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-controls label, .ox-quick-config label {&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout {&lt;br /&gt;
	width: 90px;&lt;br /&gt;
	height: 60px;&lt;br /&gt;
    background-image: url(../img/portal/layouts.png);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    margin: 2px 22px 2px 2px;&lt;br /&gt;
    border: 0px none;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.one {&lt;br /&gt;
	background-position: 0px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.two {&lt;br /&gt;
    background-position: -90px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.three {&lt;br /&gt;
    background-position: -180px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.four {&lt;br /&gt;
    background-position: -270px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.five {&lt;br /&gt;
    background-position: -360px 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout.active, .ox-portal-layout.active:hover {&lt;br /&gt;
	background-color: #67789D;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
	-webkit-box-shadow: 0px 0px 15px 1px #A5C1FE;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-portal-layout:hover {&lt;br /&gt;
	background-color: #888;&lt;br /&gt;
	-moz-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 10px 0px #fff;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* &lt;br /&gt;
 * Button&lt;br /&gt;
 */&lt;br /&gt;
.ox-button {&lt;br /&gt;
	font-size: 8pt;&lt;br /&gt;
	line-height: 1.5em;&lt;br /&gt;
    border-radius: 5px;&lt;br /&gt;
    background-color: #f5f5f5;&lt;br /&gt;
    border: 1px solid #ccc;&lt;br /&gt;
    color: black;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    padding: 5px 1em 5px 1em;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    display: inline-block;&lt;br /&gt;
    vertical-align: middle;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark {&lt;br /&gt;
    background-color: #333;&lt;br /&gt;
    border: 1px solid #222;&lt;br /&gt;
    color: white;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button:hover {&lt;br /&gt;
	border-color: #888;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* firefox */&lt;br /&gt;
.ox-button.firefox {&lt;br /&gt;
	-moz-border-radius: 5px;&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #ffffff, #efefef);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.firefox {&lt;br /&gt;
	background-image: -moz-linear-gradient(center top, #555555, #333333);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.firefox:hover {&lt;br /&gt;
	-moz-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* webkit */&lt;br /&gt;
.ox-button.webkit {&lt;br /&gt;
    -webkit-border-radius: 5px;&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(white), to(#EFEFEF));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.dark.webkit {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#555555), to(#333333));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-button.webkit:hover {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 4px #aaa;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows */&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-decorator {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px; &lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    background-color: black; &lt;br /&gt;
    opacity: 0.10;&lt;br /&gt;
    filter: alpha(opacity=10);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-container {&lt;br /&gt;
    position: absolute; &lt;br /&gt;
    top: 0px; &lt;br /&gt;
    bottom: 34px;&lt;br /&gt;
    left: 50%; &lt;br /&gt;
    margin-left: 0px; /* use to center */&lt;br /&gt;
    width: 0px; /* live parameter; override with !important */&lt;br /&gt;
    background-color: white;&lt;br /&gt;
    visibility: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-container {&lt;br /&gt;
    -moz-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-container {&lt;br /&gt;
    -webkit-box-shadow: 0px 0px 25px 1px #111;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.IE .ox-embedded-container {&lt;br /&gt;
    border: 1px solid #333;&lt;br /&gt;
    border-width: 0px 1px 0px 1px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-title {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 0px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    line-height: 12px;&lt;br /&gt;
    font-weight: bold;&lt;br /&gt;
    text-align: center;&lt;br /&gt;
    padding: 9px 20px 8px 10px;&lt;br /&gt;
    color: #ccc;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    border-bottom: 1px solid #333;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-embedded-title {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111, #444);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-embedded-title {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111), to(#444));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 7px;&lt;br /&gt;
    right: 10px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-close img {&lt;br /&gt;
    width: 14px;&lt;br /&gt;
    height: 14px;&lt;br /&gt;
    background-image: url(../img/x.png);&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-embedded-iframe {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    top: 30px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* embedded windows: dock */&lt;br /&gt;
&lt;br /&gt;
.ox-dock {&lt;br /&gt;
    position: absolute;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    background-color: #444;&lt;br /&gt;
    color: black;&lt;br /&gt;
    border-top: 1px solid #333;&lt;br /&gt;
    height: 33px;&lt;br /&gt;
    right: 0px;&lt;br /&gt;
    bottom: 0px;&lt;br /&gt;
    left: 0px;&lt;br /&gt;
    z-index: 65000;&lt;br /&gt;
    display: none;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top , #111111, #555555);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#111111), to(#555555));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-tab {&lt;br /&gt;
    background-color: #222;&lt;br /&gt;
    background-image: none;&lt;br /&gt;
    border: 1px solid black;&lt;br /&gt;
    border-width: 0px 1px 1px 1px;&lt;br /&gt;
    font-size: 12px;&lt;br /&gt;
    padding: 4px 10px 4px 10px;&lt;br /&gt;
    margin: 0px 0px 0px 5px;&lt;br /&gt;
    cursor: pointer;&lt;br /&gt;
    height: 1.5em;&lt;br /&gt;
    color: white;&lt;br /&gt;
    border-radius: 0px 0px 8px 8px;&lt;br /&gt;
        &lt;br /&gt;
    position: relative;&lt;br /&gt;
    white-space: nowrap;&lt;br /&gt;
    overflow: hidden;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-tab {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #333333);&lt;br /&gt;
    -moz-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-tab {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#333333));&lt;br /&gt;
    -webkit-border-radius: 0px 0px 8px 8px;&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.ox-dock-selected {&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.firefox .ox-dock-selected {&lt;br /&gt;
    background-image: -moz-linear-gradient(center top, #000000, #666);&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
.webkit .ox-dock-selected {&lt;br /&gt;
    background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#000000), to(#666));&lt;br /&gt;
}&lt;br /&gt;
&lt;br /&gt;
/* Context-menu button */&lt;br /&gt;
&lt;br /&gt;
.context-button .ox-button, .context-button.ox-button {&lt;br /&gt;
    padding: 0px 3px 0px 3px;&lt;br /&gt;
    width: 20px;&lt;br /&gt;
    height: 16px;&lt;br /&gt;
    background-image: url(../img/arrows/arrow-down.gif);&lt;br /&gt;
    background-repeat: no-repeat;&lt;br /&gt;
    background-position: 5px 5px;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
.weekDivMonthView .background-color-content{&lt;br /&gt;
    background-color: #ffdaab !important;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/icons/16/calendar_dis.png&lt;br /&gt;
 - theme/icons/16/calendar.png&lt;br /&gt;
 - theme/icons/16/contacts_dis.png&lt;br /&gt;
 - theme/icons/16/contacts.png&lt;br /&gt;
 - theme/icons/16/draft_dis.png&lt;br /&gt;
 - theme/icons/16/draft.png&lt;br /&gt;
 - theme/icons/16/facebook.png&lt;br /&gt;
 - theme/icons/16/folder_closed_dis.png&lt;br /&gt;
 - theme/icons/16/folder_opened_dis.png&lt;br /&gt;
 - theme/icons/16/forward.png&lt;br /&gt;
 - theme/icons/16/garbage_dis.png&lt;br /&gt;
 - theme/icons/16/garbage.png&lt;br /&gt;
 - theme/icons/16/ham_dis.png&lt;br /&gt;
 - theme/icons/16/ham.png&lt;br /&gt;
 - theme/icons/16/inbox_dis.png&lt;br /&gt;
 - theme/icons/16/inbox.png&lt;br /&gt;
 - theme/icons/16/infostore_dis.png&lt;br /&gt;
 - theme/icons/16/infostore.png&lt;br /&gt;
 - theme/icons/16/mail_dis.png&lt;br /&gt;
 - theme/icons/16/mail.png&lt;br /&gt;
 - theme/icons/16/outbox_dis.png&lt;br /&gt;
 - theme/icons/16/outbox.png&lt;br /&gt;
 - theme/icons/16/public_dis.png&lt;br /&gt;
 - theme/icons/16/public.png&lt;br /&gt;
 - theme/icons/16/rss.png&lt;br /&gt;
 - theme/icons/16/shared_dis.png&lt;br /&gt;
 - theme/icons/16/shared_globe.png&lt;br /&gt;
 - theme/icons/16/shared.png&lt;br /&gt;
 - theme/icons/16/spam_dis.png&lt;br /&gt;
 - theme/icons/16/spam.png&lt;br /&gt;
 - theme/icons/16/tasks_dis.png&lt;br /&gt;
 - theme/icons/16/tasks.png&lt;br /&gt;
 - theme/icons/16/twitter.png&lt;br /&gt;
 - theme/icons/16/user_dis.png&lt;br /&gt;
&lt;br /&gt;
 - theme/icons/24/calendar_move.png&lt;br /&gt;
 - theme/icons/24/distributionlist_extcontact.png&lt;br /&gt;
 - theme/icons/24/ham.png&lt;br /&gt;
 - theme/icons/24/mark_as_done.png&lt;br /&gt;
 - theme/icons/24/mark_as.png&lt;br /&gt;
 - theme/icons/24/spam.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/arrows/arrow_white_down.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/slider_background.png&lt;br /&gt;
 - theme/img/calendar/slider_control_background.png&lt;br /&gt;
&lt;br /&gt;
 - themes/portal/layouts.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/browsercheck.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.gif&lt;br /&gt;
 changed to a png image&lt;br /&gt;
 - themes/img/arrows/arrow_double_white_left.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/calbody-r.png&lt;br /&gt;
 - theme/img/border/cpbody-l.png&lt;br /&gt;
 - theme/img/border/cpbody-r.png&lt;br /&gt;
 - theme/img/border/cpbottom-b.png&lt;br /&gt;
 - theme/img/border/cpbottom-bl.png&lt;br /&gt;
 - theme/img/border/cpbottom-l.png&lt;br /&gt;
 - theme/img/border/cpbottom-r.png&lt;br /&gt;
 - theme/img/border/cpheader-l.png&lt;br /&gt;
 - theme/img/border/cpheader-r.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-ll.png&lt;br /&gt;
 - theme/img/border/popup/hover-top-tab-rr.png&lt;br /&gt;
 - theme/img/border/popup/popup-border-imagemap.png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31.gif&lt;br /&gt;
 All icons have changed from gif to png&lt;br /&gt;
&lt;br /&gt;
 - theme/img/infostore/mimetypes/vcard.gif&lt;br /&gt;
&lt;br /&gt;
 - theme/img/panels/miniviewHeader_b.gif&lt;br /&gt;
&lt;br /&gt;
 - themes/img/x.png&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Removed icons===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_1_sel.gif&lt;br /&gt;
 to&lt;br /&gt;
 - theme/img/calendar/dayicons/mod_calendar_31_sel.gif&lt;br /&gt;
 All icons with the _sel ending have been removed&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=Changes from 6.18.1 to 6.18.2=&lt;br /&gt;
&lt;br /&gt;
===New CSS file===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/css/branding.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed CSS files===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
- theme/css/global.css&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===New elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-person {&lt;br /&gt;
    		color: #215696;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	#window-header-decorator {&lt;br /&gt;
    		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
    		background-repeat: repeat-x;&lt;br /&gt;
    		background-color: #ddd;&lt;br /&gt;
    		border-bottom: 1px solid #bbb;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar30.png);&lt;br /&gt;
		background-repeat: repeat-x;&lt;br /&gt;
		border-top: 0px none;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.headercontenttable.border-color-design {&lt;br /&gt;
		border-color: #aaa !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse, div.oxTabControlToggle {&lt;br /&gt;
		background-repeat: no-repeat;&lt;br /&gt;
		background-position: 3px 5px;&lt;br /&gt;
		width: 15px;&lt;br /&gt;
		height: 15px;&lt;br /&gt;
		float: right;&lt;br /&gt;
		margin: 5px 9px;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggleReverse {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_down.gif);&lt;br /&gt;
		cursor: s-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControlToggle {&lt;br /&gt;
		background-image: url(../img/arrows/arrow_double_white_up.gif);&lt;br /&gt;
		cursor: n-resize;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl {&lt;br /&gt;
	    background-color: #65769B;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	.ox-sidepanel-view-title {&lt;br /&gt;
		color: white;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl a {&lt;br /&gt;
		color: #eee;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
	div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
    		background-color: #455069;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Change elements in global.css===&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color:#404962;  &lt;br /&gt;
		font-weight : bold; &lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.font-style-headline {&lt;br /&gt;
		color: #333;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	#notheader {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	#header-decorator {&lt;br /&gt;
		background-image: url(../img/toolbar/toolbar_bg.png);&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
----&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
	.tr_h {&lt;br /&gt;
    		background-color: #e3e3e3 !important;&lt;br /&gt;
	}&lt;br /&gt;
&lt;br /&gt;
changed to&lt;br /&gt;
&lt;br /&gt;
	.tr_h {&lt;br /&gt;
		background-color: #eaeaea !important;&lt;br /&gt;
	}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==ICONS==&lt;br /&gt;
&lt;br /&gt;
===New icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_down.gif&lt;br /&gt;
 - theme/img/arrows/arrow_double_white_up.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_down.gif&lt;br /&gt;
 - theme/img/arrows/menu_arrow_right.gif&lt;br /&gt;
 - theme/img/folder/shared_dis.gif &lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
All icons under the folder /themes/[theme name]/ will be separated by their size. You will find three different sub-folders here: 16 (for 16x16 pixel icons), 24 and 36. Some icons may be available in several folders. Some icons can also be found in their old location under /themes/[theme name]/img/. In the future, all icons will be found in the new icons folder and not in the img folder.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
16/attachment_add.png&lt;br /&gt;
16/attachment_open.png&lt;br /&gt;
16/attachment_remove.png&lt;br /&gt;
16/calendar_move.png&lt;br /&gt;
16/confirmation_change.png&lt;br /&gt;
16/contact_copy.png&lt;br /&gt;
16/contact_move.png&lt;br /&gt;
16/current_version.png&lt;br /&gt;
16/delete_folder.png&lt;br /&gt;
16/delete.png&lt;br /&gt;
16/distributionlist_extcontact.png&lt;br /&gt;
16/dummy.gif&lt;br /&gt;
16/duplicate_contacts.png&lt;br /&gt;
16/folder_closed.png&lt;br /&gt;
16/folder_opened.png&lt;br /&gt;
16/infostore_move.png&lt;br /&gt;
16/lock.png&lt;br /&gt;
16/mail_copy.png&lt;br /&gt;
16/mail_move.png&lt;br /&gt;
16/mail_source.png&lt;br /&gt;
16/mark_as.png&lt;br /&gt;
16/member_add.png&lt;br /&gt;
16/member_remove.png&lt;br /&gt;
16/mod_calendar.png&lt;br /&gt;
16/mod_configuration.png&lt;br /&gt;
16/mod_contacts.png&lt;br /&gt;
16/mod_infostore.png&lt;br /&gt;
16/mod_mail.png&lt;br /&gt;
16/mod_portal.png&lt;br /&gt;
16/mod_tasks.png&lt;br /&gt;
16/print.png&lt;br /&gt;
16/save.png&lt;br /&gt;
16/search.png&lt;br /&gt;
16/send_as_attachment.png&lt;br /&gt;
16/send_as_link.png&lt;br /&gt;
16/task_copy.png&lt;br /&gt;
16/task_move.png&lt;br /&gt;
16/teamchange.png&lt;br /&gt;
16/unlock.png&lt;br /&gt;
16/user.png&lt;br /&gt;
16/userrights_delete.png&lt;br /&gt;
16/userrights.png&lt;br /&gt;
16/userrights_read.png&lt;br /&gt;
16/userrights_remove.png&lt;br /&gt;
16/userrights_write.png&lt;br /&gt;
&lt;br /&gt;
24/attachment_add.png&lt;br /&gt;
24/attachment_remove.png&lt;br /&gt;
24/cancel.png&lt;br /&gt;
24/card_view.png&lt;br /&gt;
24/category_add.png&lt;br /&gt;
24/category_remove.png&lt;br /&gt;
24/confirmation_change.png&lt;br /&gt;
24/delete.png&lt;br /&gt;
24/detail_view.png&lt;br /&gt;
24/distributionlist.png&lt;br /&gt;
24/draft.png&lt;br /&gt;
24/dummy.gif&lt;br /&gt;
24/edit.png&lt;br /&gt;
24/externalview_add.png&lt;br /&gt;
24/externalview_disable.png&lt;br /&gt;
24/externalview_edit.png&lt;br /&gt;
24/externalview_enable.png&lt;br /&gt;
24/externalview_remove.png&lt;br /&gt;
24/forward.png&lt;br /&gt;
24/h_split_view.png&lt;br /&gt;
24/inbox.png&lt;br /&gt;
24/list_view.png&lt;br /&gt;
24/mail_copy.png&lt;br /&gt;
24/mail_move.png&lt;br /&gt;
24/mail_send.png&lt;br /&gt;
24/mail_write.png&lt;br /&gt;
24/member_add.png&lt;br /&gt;
24/member_remove.png&lt;br /&gt;
24/mod_calendar.png&lt;br /&gt;
24/mod_configuration.png&lt;br /&gt;
24/mod_contacts.png&lt;br /&gt;
24/mod_foldertree.png&lt;br /&gt;
24/mod_infostore.png&lt;br /&gt;
24/mod_mail.png&lt;br /&gt;
24/mod_portal.png&lt;br /&gt;
24/mod_tasks.png&lt;br /&gt;
24/options.png&lt;br /&gt;
24/picture_add.png&lt;br /&gt;
24/picture_remove.png&lt;br /&gt;
24/print.png&lt;br /&gt;
24/reply_all.png&lt;br /&gt;
24/reply.png&lt;br /&gt;
24/save_as_link.png&lt;br /&gt;
24/save.png&lt;br /&gt;
24/tag_10.png&lt;br /&gt;
24/tag_1.png&lt;br /&gt;
24/tag_2.png&lt;br /&gt;
24/tag_3.png&lt;br /&gt;
24/tag_4.png&lt;br /&gt;
24/tag_5.png&lt;br /&gt;
24/tag_6.png&lt;br /&gt;
24/tag_7.png&lt;br /&gt;
24/tag_8.png&lt;br /&gt;
24/tag_9.png&lt;br /&gt;
24/tag_remove.png&lt;br /&gt;
24/task_copy.png&lt;br /&gt;
24/task_move.png&lt;br /&gt;
24/teamchange.png&lt;br /&gt;
24/v_split_view.png&lt;br /&gt;
&lt;br /&gt;
32/attachment_add.png&lt;br /&gt;
32/attachment_remove.png&lt;br /&gt;
32/cancel.png&lt;br /&gt;
32/category_add.png&lt;br /&gt;
32/category_remove.png&lt;br /&gt;
32/confirmation_change.png&lt;br /&gt;
32/delete.png&lt;br /&gt;
32/distributionlist.png&lt;br /&gt;
32/draft.png&lt;br /&gt;
32/dummy.gif&lt;br /&gt;
32/edit.png&lt;br /&gt;
32/externalview_add.png&lt;br /&gt;
32/externalview_disable.png&lt;br /&gt;
32/externalview_edit.png&lt;br /&gt;
32/externalview_enable.png&lt;br /&gt;
32/externalview_remove.png&lt;br /&gt;
32/forward.png&lt;br /&gt;
32/import.png&lt;br /&gt;
32/mail_copy.png&lt;br /&gt;
32/mail_move.png&lt;br /&gt;
32/mail_send.png&lt;br /&gt;
32/mail_write.png&lt;br /&gt;
32/member_add.png&lt;br /&gt;
32/member_remove.png&lt;br /&gt;
32/mod_calendar.png&lt;br /&gt;
32/mod_configuration.png&lt;br /&gt;
32/mod_contacts.png&lt;br /&gt;
32/mod_infostore.png&lt;br /&gt;
32/mod_mail.png&lt;br /&gt;
32/mod_portal.png&lt;br /&gt;
32/mod_tasks.png&lt;br /&gt;
32/options.png&lt;br /&gt;
32/picture_add.png&lt;br /&gt;
32/picture_remove.png&lt;br /&gt;
32/print.png&lt;br /&gt;
32/reply_all.png&lt;br /&gt;
32/reply.png&lt;br /&gt;
32/save_as_link.png&lt;br /&gt;
32/save.png&lt;br /&gt;
32/tag_10.png&lt;br /&gt;
32/tag_1.png&lt;br /&gt;
32/tag_2.png&lt;br /&gt;
32/tag_3.png&lt;br /&gt;
32/tag_4.png&lt;br /&gt;
32/tag_5.png&lt;br /&gt;
32/tag_6.png&lt;br /&gt;
32/tag_7.png&lt;br /&gt;
32/tag_8.png&lt;br /&gt;
32/tag_9.png&lt;br /&gt;
32/tag_remove.png&lt;br /&gt;
32/task_copy.png&lt;br /&gt;
32/task_move.png&lt;br /&gt;
32/teamchange.png&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Changed icons===&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 - theme/img/toolbar/toolbar_bg.gif&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=Enable_TinyMCE_spellcheck_module&amp;diff=8975</id>
		<title>Enable TinyMCE spellcheck module</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=Enable_TinyMCE_spellcheck_module&amp;diff=8975"/>
		<updated>2011-09-21T12:04:12Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Installation of the TinyMCE spellchecker module */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
By default there is no spell check available in the Open-Xchange application itself because most of the modern browsers usually offer a spellcheck module. TinyMCE, the HTML editor which is used by Open-Xchange for HTML editing while writing an eMail, offers a wide set of functions and features which can be added to the HTML editor UI. This example will describe how you can enable the TinyMCE based spellcheck functionality within the Open-Xchange mail module.&lt;br /&gt;
&lt;br /&gt;
= Requirements =&lt;br /&gt;
&lt;br /&gt;
* An installed Open-Xchange Server&lt;br /&gt;
&lt;br /&gt;
* ASpell with the according dictionaries needs to be installed&lt;br /&gt;
&lt;br /&gt;
* PHP5 must be enabled in your Apache configuration&lt;br /&gt;
&lt;br /&gt;
= Installation and Configuration of the TinyMCE Spellcheck module =&lt;br /&gt;
&lt;br /&gt;
Please note: Open-Xchange cannot support the spellcheck module itself and the according infrastructure (aspell, PHP), as those modules won&#039;t be maintained and tracked by Open-Xchange. On machines with lot of users this service may produce heavy load due to many request so we highly recommend to cluster it or, even better, to use the native spellcheck plugins of modern browsers.&lt;br /&gt;
&lt;br /&gt;
== Installation of the TinyMCE spellchecker module ==&lt;br /&gt;
&lt;br /&gt;
Please visit the TinyMCE website and download the latest TinyMCE &amp;quot;PHP Spellchecker&amp;quot;  plugin at http://www.tinymce.com/download/download.php (at the bottom of the list). This article uses Version 2.0.5.&lt;br /&gt;
&lt;br /&gt;
Extract the downloaded archive and move the extracted directory &amp;quot;spellchecker&amp;quot; to the TinyMCE location on the Open-Xchange installation:&lt;br /&gt;
&lt;br /&gt;
 $ mv spellchecker /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/.&lt;br /&gt;
&lt;br /&gt;
== Enable the spellchecker button in the Open-Xchange HTML editor ==&lt;br /&gt;
&lt;br /&gt;
This can be accomplished by adding a properties file to directory &amp;quot;/opt/open-xchange/etc/groupware/settings&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
 $ vim /opt/open-xchange/etc/groupware/settings/spellchecker.properties&lt;br /&gt;
 &lt;br /&gt;
 modules/mail/spellcheck=true&lt;br /&gt;
&lt;br /&gt;
== Setup the backend communication ==&lt;br /&gt;
&lt;br /&gt;
Finally we need to tell the spellchecker module which binary it should execute in order to get spelling suggestions. By default GoogleSpell is activated for remote suggestion, but as this would mean that every eMail which should be checked will be send to Google, we recommend to use a local aspell instance for this purpose. To do so, install aspell and the according dictionaries as we told you in the requirements section, and modify /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/spellchecker/config.php to specify the aspell binary location. Please use the following example, and just replace [REPLACE_WITH_PATH_TO_ASPELL_BIN] with the location of the aspell binary (for example /usr/bin/aspell):&lt;br /&gt;
&lt;br /&gt;
  &amp;lt;?php&lt;br /&gt;
  /**&lt;br /&gt;
   * config.php&lt;br /&gt;
   *&lt;br /&gt;
   * @package MCManager.includes&lt;br /&gt;
   */&lt;br /&gt;
         // General settings&lt;br /&gt;
         //$config[&#039;general.engine&#039;] = &#039;GoogleSpell&#039;;&lt;br /&gt;
         //$config[&#039;general.engine&#039;] = &#039;PSpell&#039;;&lt;br /&gt;
         $config[&#039;general.engine&#039;] = &#039;PSpellShell&#039;;&lt;br /&gt;
         //$config[&#039;general.remote_rpc_url&#039;] = &#039;http://some.other.site/some/url/rpc.php&#039;;&lt;br /&gt;
 &lt;br /&gt;
         // PSpell settings&lt;br /&gt;
         $config[&#039;PSpell.mode&#039;] = PSPELL_FAST;&lt;br /&gt;
         $config[&#039;PSpell.spelling&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
         $config[&#039;PSpell.jargon&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
         $config[&#039;PSpell.encoding&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
         // PSpellShell settings&lt;br /&gt;
         $config[&#039;PSpellShell.mode&#039;] = PSPELL_FAST;&lt;br /&gt;
         $config[&#039;PSpellShell.aspell&#039;] = &#039;[REPLACE_WITH_PATH_TO_ASPELL_BIN]&#039;; // e.g. /usr/bin/aspell&lt;br /&gt;
         $config[&#039;PSpellShell.tmp&#039;] = &#039;/tmp&#039;;&lt;br /&gt;
 &lt;br /&gt;
         // Windows PSpellShell settings&lt;br /&gt;
         //$config[&#039;PSpellShell.aspell&#039;] = &#039;&amp;quot;c:\Program Files\Aspell\bin\aspell.exe&amp;quot;&#039;;&lt;br /&gt;
         //$config[&#039;PSpellShell.tmp&#039;] = &#039;c:/temp&#039;;&lt;br /&gt;
 ?&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=Enable_TinyMCE_spellcheck_module&amp;diff=8974</id>
		<title>Enable TinyMCE spellcheck module</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=Enable_TinyMCE_spellcheck_module&amp;diff=8974"/>
		<updated>2011-09-21T09:27:43Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: updated link&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
By default there is no spell check available in the Open-Xchange application itself because most of the modern browsers usually offer a spellcheck module. TinyMCE, the HTML editor which is used by Open-Xchange for HTML editing while writing an eMail, offers a wide set of functions and features which can be added to the HTML editor UI. This example will describe how you can enable the TinyMCE based spellcheck functionality within the Open-Xchange mail module.&lt;br /&gt;
&lt;br /&gt;
= Requirements =&lt;br /&gt;
&lt;br /&gt;
* An installed Open-Xchange Server&lt;br /&gt;
&lt;br /&gt;
* ASpell with the according dictionaries needs to be installed&lt;br /&gt;
&lt;br /&gt;
* PHP5 must be enabled in your Apache configuration&lt;br /&gt;
&lt;br /&gt;
= Installation and Configuration of the TinyMCE Spellcheck module =&lt;br /&gt;
&lt;br /&gt;
Please note: Open-Xchange cannot support the spellcheck module itself and the according infrastructure (aspell, PHP), as those modules won&#039;t be maintained and tracked by Open-Xchange. On machines with lot of users this service may produce heavy load due to many request so we highly recommend to cluster it or, even better, to use the native spellcheck plugins of modern browsers.&lt;br /&gt;
&lt;br /&gt;
== Installation of the TinyMCE spellchecker module ==&lt;br /&gt;
&lt;br /&gt;
Please visit the TinyMCE website and download the latest TinyMCE &amp;quot;PHP Spellchecker&amp;quot;  plugin at http://www.tinymce.com/download/download.php (at the bottom of the list). This article uses Version 2.0.3.&lt;br /&gt;
&lt;br /&gt;
Extract the downloaded archive and move the extracted directory &amp;quot;spellchecker&amp;quot; to the TinyMCE location on the Open-Xchange installation:&lt;br /&gt;
&lt;br /&gt;
 $ mv spellchecker /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/.&lt;br /&gt;
&lt;br /&gt;
== Enable the spellchecker button in the Open-Xchange HTML editor ==&lt;br /&gt;
&lt;br /&gt;
This can be accomplished by adding a properties file to directory &amp;quot;/opt/open-xchange/etc/groupware/settings&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
 $ vim /opt/open-xchange/etc/groupware/settings/spellchecker.properties&lt;br /&gt;
 &lt;br /&gt;
 modules/mail/spellcheck=true&lt;br /&gt;
&lt;br /&gt;
== Setup the backend communication ==&lt;br /&gt;
&lt;br /&gt;
Finally we need to tell the spellchecker module which binary it should execute in order to get spelling suggestions. By default GoogleSpell is activated for remote suggestion, but as this would mean that every eMail which should be checked will be send to Google, we recommend to use a local aspell instance for this purpose. To do so, install aspell and the according dictionaries as we told you in the requirements section, and modify /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/spellchecker/config.php to specify the aspell binary location. Please use the following example, and just replace [REPLACE_WITH_PATH_TO_ASPELL_BIN] with the location of the aspell binary (for example /usr/bin/aspell):&lt;br /&gt;
&lt;br /&gt;
  &amp;lt;?php&lt;br /&gt;
  /**&lt;br /&gt;
   * config.php&lt;br /&gt;
   *&lt;br /&gt;
   * @package MCManager.includes&lt;br /&gt;
   */&lt;br /&gt;
         // General settings&lt;br /&gt;
         //$config[&#039;general.engine&#039;] = &#039;GoogleSpell&#039;;&lt;br /&gt;
         //$config[&#039;general.engine&#039;] = &#039;PSpell&#039;;&lt;br /&gt;
         $config[&#039;general.engine&#039;] = &#039;PSpellShell&#039;;&lt;br /&gt;
         //$config[&#039;general.remote_rpc_url&#039;] = &#039;http://some.other.site/some/url/rpc.php&#039;;&lt;br /&gt;
 &lt;br /&gt;
         // PSpell settings&lt;br /&gt;
         $config[&#039;PSpell.mode&#039;] = PSPELL_FAST;&lt;br /&gt;
         $config[&#039;PSpell.spelling&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
         $config[&#039;PSpell.jargon&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
         $config[&#039;PSpell.encoding&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
         // PSpellShell settings&lt;br /&gt;
         $config[&#039;PSpellShell.mode&#039;] = PSPELL_FAST;&lt;br /&gt;
         $config[&#039;PSpellShell.aspell&#039;] = &#039;[REPLACE_WITH_PATH_TO_ASPELL_BIN]&#039;; // e.g. /usr/bin/aspell&lt;br /&gt;
         $config[&#039;PSpellShell.tmp&#039;] = &#039;/tmp&#039;;&lt;br /&gt;
 &lt;br /&gt;
         // Windows PSpellShell settings&lt;br /&gt;
         //$config[&#039;PSpellShell.aspell&#039;] = &#039;&amp;quot;c:\Program Files\Aspell\bin\aspell.exe&amp;quot;&#039;;&lt;br /&gt;
         //$config[&#039;PSpellShell.tmp&#039;] = &#039;c:/temp&#039;;&lt;br /&gt;
 ?&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=Enable_TinyMCE_spellcheck_module&amp;diff=8973</id>
		<title>Enable TinyMCE spellcheck module</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=Enable_TinyMCE_spellcheck_module&amp;diff=8973"/>
		<updated>2011-09-21T09:26:17Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Updated PHP Spellchecker documentation&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
By default there is no spell check available in the Open-Xchange application itself because most of the modern browsers usually offer a spellcheck module. TinyMCE, the HTML editor which is used by Open-Xchange for HTML editing while writing an eMail, offers a wide set of functions and features which can be added to the HTML editor UI. This example will describe how you can enable the TinyMCE based spellcheck functionality within the Open-Xchange mail module.&lt;br /&gt;
&lt;br /&gt;
= Requirements =&lt;br /&gt;
&lt;br /&gt;
* An installed Open-Xchange Server&lt;br /&gt;
&lt;br /&gt;
* ASpell with the according dictionaries needs to be installed&lt;br /&gt;
&lt;br /&gt;
* PHP5 must be enabled in your Apache configuration&lt;br /&gt;
&lt;br /&gt;
= Installation and Configuration of the TinyMCE Spellcheck module =&lt;br /&gt;
&lt;br /&gt;
Please note: Open-Xchange cannot support the spellcheck module itself and the according infrastructure (aspell, PHP), as those modules won&#039;t be maintained and tracked by Open-Xchange. On machines with lot of users this service may produce heavy load due to many request so we highly recommend to cluster it or, even better, to use the native spellcheck plugins of modern browsers.&lt;br /&gt;
&lt;br /&gt;
== Installation of the TinyMCE spellchecker module ==&lt;br /&gt;
&lt;br /&gt;
Please visit the TinyMCE website and download the latest TinyMCE &amp;quot;PHP Spellchecker&amp;quot;  plugin at http://www.tinymce.com/develop/changelog/?type=phpspell. This article will use Version 2.0.3.&lt;br /&gt;
&lt;br /&gt;
Extract the downloaded archive and move the extracted directory &amp;quot;spellchecker&amp;quot; to the TinyMCE location on the Open-Xchange installation:&lt;br /&gt;
&lt;br /&gt;
 $ mv spellchecker /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/.&lt;br /&gt;
&lt;br /&gt;
== Enable the spellchecker button in the Open-Xchange HTML editor ==&lt;br /&gt;
&lt;br /&gt;
This can be accomplished by adding a properties file to directory &amp;quot;/opt/open-xchange/etc/groupware/settings&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
 $ vim /opt/open-xchange/etc/groupware/settings/spellchecker.properties&lt;br /&gt;
 &lt;br /&gt;
 modules/mail/spellcheck=true&lt;br /&gt;
&lt;br /&gt;
== Setup the backend communication ==&lt;br /&gt;
&lt;br /&gt;
Finally we need to tell the spellchecker module which binary it should execute in order to get spelling suggestions. By default GoogleSpell is activated for remote suggestion, but as this would mean that every eMail which should be checked will be send to Google, we recommend to use a local aspell instance for this purpose. To do so, install aspell and the according dictionaries as we told you in the requirements section, and modify /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/spellchecker/config.php to specify the aspell binary location. Please use the following example, and just replace [REPLACE_WITH_PATH_TO_ASPELL_BIN] with the location of the aspell binary (for example /usr/bin/aspell):&lt;br /&gt;
&lt;br /&gt;
  &amp;lt;?php&lt;br /&gt;
  /**&lt;br /&gt;
   * config.php&lt;br /&gt;
   *&lt;br /&gt;
   * @package MCManager.includes&lt;br /&gt;
   */&lt;br /&gt;
         // General settings&lt;br /&gt;
         //$config[&#039;general.engine&#039;] = &#039;GoogleSpell&#039;;&lt;br /&gt;
         //$config[&#039;general.engine&#039;] = &#039;PSpell&#039;;&lt;br /&gt;
         $config[&#039;general.engine&#039;] = &#039;PSpellShell&#039;;&lt;br /&gt;
         //$config[&#039;general.remote_rpc_url&#039;] = &#039;http://some.other.site/some/url/rpc.php&#039;;&lt;br /&gt;
 &lt;br /&gt;
         // PSpell settings&lt;br /&gt;
         $config[&#039;PSpell.mode&#039;] = PSPELL_FAST;&lt;br /&gt;
         $config[&#039;PSpell.spelling&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
         $config[&#039;PSpell.jargon&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
         $config[&#039;PSpell.encoding&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
         // PSpellShell settings&lt;br /&gt;
         $config[&#039;PSpellShell.mode&#039;] = PSPELL_FAST;&lt;br /&gt;
         $config[&#039;PSpellShell.aspell&#039;] = &#039;[REPLACE_WITH_PATH_TO_ASPELL_BIN]&#039;; // e.g. /usr/bin/aspell&lt;br /&gt;
         $config[&#039;PSpellShell.tmp&#039;] = &#039;/tmp&#039;;&lt;br /&gt;
 &lt;br /&gt;
         // Windows PSpellShell settings&lt;br /&gt;
         //$config[&#039;PSpellShell.aspell&#039;] = &#039;&amp;quot;c:\Program Files\Aspell\bin\aspell.exe&amp;quot;&#039;;&lt;br /&gt;
         //$config[&#039;PSpellShell.tmp&#039;] = &#039;c:/temp&#039;;&lt;br /&gt;
 ?&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:OX6-Upsell&amp;diff=8160</id>
		<title>OX6:OX6-Upsell</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:OX6-Upsell&amp;diff=8160"/>
		<updated>2011-07-11T10:08:04Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Added new events&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Upsell Layer =&lt;br /&gt;
&lt;br /&gt;
== Introduction ==&lt;br /&gt;
&lt;br /&gt;
The Open-xchange Upsell packages provide the ability to show advertisements to an Open-Xchange user who is using a free for charge package like &amp;quot;Webmail&amp;quot; or &amp;quot;PIM&amp;quot;. It gives hosting companies the possibility to take advantage of selling premium OX services (Mobility OXtender etc.) via &amp;quot;in app&amp;quot; technology. &lt;br /&gt;
&lt;br /&gt;
When  a &amp;quot;freemail&amp;quot; user clicks on a feature like &amp;quot;Download Outlook Oxtender&amp;quot;, &amp;quot;Enable Mobility&amp;quot; or wants to &amp;quot;Access Infostore&amp;quot; an Upsell Layer is shown where the user learns more about the missing functionality in form of text, screenshots and a video explaining the feature.&lt;br /&gt;
&lt;br /&gt;
Based on the configuration the user can request a free trial of a package like &amp;quot;Premium Groupware&amp;quot; or / and can buy the package within the Upsell Dialogue with one simple click.&lt;br /&gt;
&lt;br /&gt;
It is also possible for hosting companies to easily integrate their own online shop into the Open-Xchange Upsell Layer.&lt;br /&gt;
&lt;br /&gt;
The customer never has to leave the application to upsell - it&#039;s a native IN APP upsell.&lt;br /&gt;
&lt;br /&gt;
[[File:upsell.png|290px|thumb|left|Upsell Layer Mobility]] &lt;br /&gt;
[[File:Upsell_infostore.png|290px|thumb|left|Upsell Layer Infostore]]&lt;br /&gt;
[[File:upsell_calendar.png|290px|thumb|left|Upsell Layer Calendar]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
We have implemented 3 different types how to process the upsell an user is requesting in the hosters backend:&lt;br /&gt;
&lt;br /&gt;
* Show the Upsell Layer window and trigger the upgrade via a generated email to an email address after user clicked &amp;quot;buy&amp;quot; or &amp;quot;trial&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
In this email there is the information which user from which contaxt wants to upgrade to which package. After receiving the email the hoster&#039;s sales team can put the customer into billing.&lt;br /&gt;
&lt;br /&gt;
* Show the Upsell Layer window and open a configurable URL including all needed parameters after the user clicked &amp;quot;buy&amp;quot; or &amp;quot;trial.&lt;br /&gt;
&lt;br /&gt;
This is the perfect automated way if the hoster wants to have a full automated upsell which he can easily integrate into his existing provisioning &amp;amp; billing system.&lt;br /&gt;
&lt;br /&gt;
* Directly display a configurable URL/Online SHOP (systemwide or/and per context configurable) within the upsell Layer window instead of standard OX upsell content.&lt;br /&gt;
&lt;br /&gt;
This is the perfect automated way for all hosters which have an online shop in place and wants to use it for the upsell, too.&lt;br /&gt;
 &lt;br /&gt;
&lt;br /&gt;
The upsell layer has full i18n (EN and DE are included) support integrated and offers following components for advertisement:&lt;br /&gt;
&lt;br /&gt;
* Text&lt;br /&gt;
* Video &lt;br /&gt;
* Screenshots&lt;br /&gt;
&lt;br /&gt;
to promote a certain feature for Open-Xchange.&lt;br /&gt;
&lt;br /&gt;
The important part of the upsell layer is the ability to pass all needed parameters from users session like username,id,cid etc. + the feature he wants to buy, to a third party online shop system or send these parameters via email in machine readable (configurable) format to a dedicated mailsystem which can process it via procmail or similar to trigger the upgrade process via the Open-Xchange API´s (SOAP,RMI,CLT).&lt;br /&gt;
&lt;br /&gt;
{{InstallPlugin|pluginname=open-xchange-upsell-multiple open-xchange-upsell-multiple-gui|sopath=updates}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
After installation of these packages, you have installed one server side plugin and one gui-plugin. If you have dedicated apaches running in your setup, only install the &amp;quot;open-xchange-upsell-multiple-gui&amp;quot; package on them. The upsell layer is now available to ALL contexts/users of this OX application server/gui instance. All UI plugin contents are installed under following directory (on Debian based installations):&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
/var/www/ox6/plugins/com.openexchange.upsell.multiple.gui/&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
It contains different subdirectories, for example:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
css  - All colors, styles are defined within this directory.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
lang - All translated PO files must be stored below this directory.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
templates - If you want to change/replace screenshots, videos, layouts etc. check this directory.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The server side plugin comes with some templates, for example to change the advertisement text which is sent to the user, or the mail which is sent to the upgrade processing email system. All of them are stored below /opt/open-xchange/etc/groupware&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
upsell_mail_body_ox_enduser.tmpl&lt;br /&gt;
upsell_mail_body_ox_enduser.tmpl_de_DE&lt;br /&gt;
upsell_mail_subject_ox_enduser.tmpl&lt;br /&gt;
upsell_mail_subject_ox_enduser.tmpl_de_DE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Configuration ==&lt;br /&gt;
&lt;br /&gt;
Once installed, all necessary configuration can be done in one single file. This file can be found at the following directory on the OX application server:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
/opt/open-xchange/etc/groupware/upsell.properties&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Switching between the 3 different types of the upsell layer, edit parameter:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Possible values: &amp;quot;direct&amp;quot;, &amp;quot;static&amp;quot; or &amp;quot;email&amp;quot;. &lt;br /&gt;
&lt;br /&gt;
direct = Redirect within IFRAME immediately to parameter &amp;quot;com.openexchange.upsell.multiple.method.static.shop_redir_url&amp;quot; or to the context specific URL value after clicking one of the upsell triggers.&lt;br /&gt;
&lt;br /&gt;
static = Redirect AFTER clicking a button within the shipped OX Upsell pages to parameter &amp;quot;com.openexchange.upsell.multiple.method.static.shop_redir_url&amp;quot; or to the context specific URL value after clicking one of the upsell triggers.&lt;br /&gt;
&lt;br /&gt;
email = Send email to specific address AFTER clicking a button within the shipped OX Upsell pages &lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Defining the redirect URL for method &amp;quot;static&amp;quot; and &amp;quot;direct&amp;quot; for all contexts which are not specially provisioned, edit parameter:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.static.shop_redir_url=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
http://shop.host.tld/store?src=ox&amp;amp;user=_USER_&amp;amp;userid=_USERID_&amp;amp;mail=_MAIL_&amp;amp;login=_LOGIN_&amp;amp;imaplogin=_IMAPLOGIN_&amp;amp;clicked_feat=_CLICKED_FEATURE_&amp;amp;lang=_LANG_&amp;amp;cid=_CID_&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
As you can see from the example, the server side upsell plugin will replace all placeholders (_USER_ , _USERID_ etc.) with the data from the users OX session while he is logged into OX. You can use following parameters in this URL: &lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&amp;quot;_USER_&amp;quot;&lt;br /&gt;
&amp;quot;_USERID_&amp;quot;&lt;br /&gt;
&amp;quot;_MAIL_&amp;quot;&lt;br /&gt;
&amp;quot;_LOGIN_&amp;quot;&lt;br /&gt;
&amp;quot;_IMAPLOGIN&amp;quot;&lt;br /&gt;
&amp;quot;_CLICKED_FEATURE_&amp;quot;&lt;br /&gt;
&amp;quot;_UPSELL_PLAN_&amp;quot; - Not in use.&lt;br /&gt;
&amp;quot;_CID_&amp;quot;&lt;br /&gt;
&amp;quot;_LANG_&amp;quot;&lt;br /&gt;
&amp;quot;_PURCHASE_TYPE_&amp;quot; - Only used if email or static method is used due to the OX upsell layout/buttons&lt;br /&gt;
&amp;quot;_INVITE_&amp;quot; - User checked &amp;quot;invite my friends&amp;quot; checkbox in upsell box&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
If you need a different URL than specified in this configuration for one or more OX Contexts, you must set the custom attribute:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&amp;quot;com.openexchange.upsell/url&amp;quot;&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
into the admin user of the context via SOAP,RMI OR Commandline Tools.&lt;br /&gt;
 &lt;br /&gt;
WARNING: Due to Database restriction, you can only set the URL without any PAR&lt;br /&gt;
AMETERS. PLEASE ONLY SET THE HOST+PATH to your WEBAPP. &lt;br /&gt;
&lt;br /&gt;
Following PARAMETERS will be automatically appended to the URL:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
src=ox&amp;amp;user=_USER_&amp;amp;invite=_INVITE_&amp;amp;mail=_MAIL_&amp;amp;purchase_type=_PURCHASE_TYPE_&amp;amp;login=_LOGIN_&amp;amp;imaplogin=_IMAPLOGIN_&amp;amp;clicked_feat=_CLICKED_FEATURE_&amp;amp;upsell_plan=_U&lt;br /&gt;
PSELL_PLAN_&amp;amp;cid=_CID_&amp;amp;lang=_LANG_&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
To set the custom attribute via Commandline Tools, use following example:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
changeuser -i 2 -c 424242667 --com.openexchange.upsell/url=&amp;quot;http://my.reseller1.com/path/to/webapp/or/php_page.php?&amp;quot;&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Defining the email address where upsell plugin will send all infos to for processing this request in a machine readable format:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.address=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The mail will be send to this email address. It should be processed by some script via procmail or similar to trigger an API call later on.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Email template to load for sending the machine readable mail, if not found, hardcoded text will be used:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.template=/opt/open-xchange/etc/groupware/upsell_mail_body.tmpl&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
All needed paramaters can be included in this email. You can use same placeholders as in the &amp;quot;REDIRECT URL&amp;quot;, which is explained above.&lt;br /&gt;
&lt;br /&gt;
Defining email subject to use when sending upsell request mails. See available placeholder above:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.subject=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
If you like, the upsell plugin can also send an info/advertisement email to ox enduser to inform about upsell after the machine readable mail was sent:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.oxuser.enabled=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Defining email template to load for ox enduser, if mail to enduser is configured:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.oxuser.template=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
If you need i18n support within email templates, create template with suffix &amp;quot;_&amp;lt;LANGUAGE_CODE&amp;gt;&amp;quot; . Example: /var/upsell_mail_body_ox_enduser.tmpl_de_DE&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
If you want to use the builtin upgrade methods, you must also configure the OX RMI API informations:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.rmi.host=&lt;br /&gt;
com.openexchange.upsell.multiple.rmi.masteradmin=&lt;br /&gt;
com.openexchange.upsell.multiple.rmi.masteradmin.pass=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Adding new feature  (e.g. video, screenshot)==&lt;br /&gt;
&lt;br /&gt;
* Open register.js (located in gui folder)&lt;br /&gt;
* Search for upsell.config.features&lt;br /&gt;
* add the following code ( description inline )&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
featurename: {&lt;br /&gt;
  name: [&amp;quot;trigger element&amp;quot;],&lt;br /&gt;
  title: _(&amp;quot;upsell window title&amp;quot;),&lt;br /&gt;
  product_name: _(&amp;quot;feature headline&amp;quot;),&lt;br /&gt;
  intro: _(&amp;quot;upsell description text&amp;quot;),&lt;br /&gt;
  list: {&lt;br /&gt;
    list_item_1:  _(&amp;quot;enumeration&amp;quot;),&lt;br /&gt;
    list_item_2:  _(&amp;quot;enumeration&amp;quot;),&lt;br /&gt;
    list_item_3:  _(&amp;quot;...&amp;quot;),&lt;br /&gt;
  },&lt;br /&gt;
  outro: _(&amp;quot;upsell text that shows at end&amp;quot;),&lt;br /&gt;
  videos: {&lt;br /&gt;
    video_1: {&lt;br /&gt;
      thumb: &amp;quot;name_of_video_thumbnail.png&amp;quot;,&lt;br /&gt;
      video: &amp;quot;name_of_video_file.swf&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  },&lt;br /&gt;
  images: {&lt;br /&gt;
    image_1: {&lt;br /&gt;
      thumb: &amp;quot;name_of_image_thumbnail.png&amp;quot;,&lt;br /&gt;
      image: &amp;quot;name_of_lightbox_image.png&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  },&lt;br /&gt;
  buttons: {&lt;br /&gt;
    trial: {&lt;br /&gt;
      content: _(&amp;quot;buttonlabel&amp;quot;),&lt;br /&gt;
      action: &amp;quot;put javascript actions here if any&amp;quot;&lt;br /&gt;
    },&lt;br /&gt;
  },&lt;br /&gt;
  checkboxes: {&lt;br /&gt;
    invite:{&lt;br /&gt;
      content: _(&amp;quot;checkboxlabel&amp;quot;),&lt;br /&gt;
      action: &amp;quot;put javascript actions here if any&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  }&lt;br /&gt;
},&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
* after the feature is implemented you should create the nessacarry files and place them as follow&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
-templates&lt;br /&gt;
--_featurename&lt;br /&gt;
---- language ( for example de_DE )&lt;br /&gt;
-------- flash ( for videos )&lt;br /&gt;
-------- img ( for images )&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Load required js/cs files  ==&lt;br /&gt;
&lt;br /&gt;
* to load additional files open register.js and add the following code&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
upsell = {&lt;br /&gt;
  files: {&lt;br /&gt;
    jss: {&lt;br /&gt;
      name: {&lt;br /&gt;
        script: &amp;quot;name.js&amp;quot;,&lt;br /&gt;
      },&lt;br /&gt;
    },&lt;br /&gt;
   css: {&lt;br /&gt;
     name: &amp;quot;name.css&amp;quot;,&lt;br /&gt;
   },&lt;br /&gt;
 },&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
* add name.js to jss/name.js&lt;br /&gt;
* add name.css to css/name.css&lt;br /&gt;
&lt;br /&gt;
== Change look and feel (e.g. branding, colors and sizes) ==&lt;br /&gt;
&lt;br /&gt;
* you should edit the existing css located in /var/www/ox6/plugins/com.openexchange.upsell.multiple.gui/css/upsell.css&lt;br /&gt;
* you can add / edit background in /var/www/ox6/plugins/com.openexchange.upsell.multiple.gui//img&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Possible triggers ==&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
modules/calendar/freebusy&lt;br /&gt;
modules/calendar/team&lt;br /&gt;
modules/calendar/mini_calender&lt;br /&gt;
modules/calendar/new/add_participants&lt;br /&gt;
modules/calendar/new/remove_participants&lt;br /&gt;
modules/calendar/new/add_attachment&lt;br /&gt;
modules/calendar/new/delete_attachment&lt;br /&gt;
modules/contacts/new/add_attachment&lt;br /&gt;
modules/contacts/new/delete_attachment&lt;br /&gt;
modules/contacts/social/refresh&lt;br /&gt;
modules/contacts/social/publish&lt;br /&gt;
modules/mail/save_to_infostore&lt;br /&gt;
modules/infostore/send_as_attachment&lt;br /&gt;
modules/infostore/send_as_link&lt;br /&gt;
modules/infostore/mail/save_to_infostore&lt;br /&gt;
modules/infostore/social/refresh&lt;br /&gt;
modules/infostore/social/publish&lt;br /&gt;
modules/tasks/new/add_participants&lt;br /&gt;
modules/tasks/new/remove_participants&lt;br /&gt;
modules/tasks/new/add_attachment&lt;br /&gt;
modules/tasks/new/delete_attachment&lt;br /&gt;
configuration/mail/accounts/new&lt;br /&gt;
modules/folders/users&lt;br /&gt;
&lt;br /&gt;
modules/infostore&lt;br /&gt;
modules/calender&lt;br /&gt;
modules/contacts&lt;br /&gt;
modules/mail&lt;br /&gt;
modules/portal&lt;br /&gt;
modules/tasks&lt;br /&gt;
modules/configuration&lt;br /&gt;
&lt;br /&gt;
modules/outlook&lt;br /&gt;
modules/outlook.updater&lt;br /&gt;
modules/mobility&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:OX6-Upsell&amp;diff=8158</id>
		<title>OX6:OX6-Upsell</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:OX6-Upsell&amp;diff=8158"/>
		<updated>2011-07-11T10:01:02Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Possible triggers */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Upsell Layer =&lt;br /&gt;
&lt;br /&gt;
== Introduction ==&lt;br /&gt;
&lt;br /&gt;
The Open-xchange Upsell packages provide the ability to show advertisements to an Open-Xchange user who is using a free for charge package like &amp;quot;Webmail&amp;quot; or &amp;quot;PIM&amp;quot;. It gives hosting companies the possibility to take advantage of selling premium OX services (Mobility OXtender etc.) via &amp;quot;in app&amp;quot; technology. &lt;br /&gt;
&lt;br /&gt;
When  a &amp;quot;freemail&amp;quot; user clicks on a feature like &amp;quot;Download Outlook Oxtender&amp;quot;, &amp;quot;Enable Mobility&amp;quot; or wants to &amp;quot;Access Infostore&amp;quot; an Upsell Layer is shown where the user learns more about the missing functionality in form of text, screenshots and a video explaining the feature.&lt;br /&gt;
&lt;br /&gt;
Based on the configuration the user can request a free trial of a package like &amp;quot;Premium Groupware&amp;quot; or / and can buy the package within the Upsell Dialogue with one simple click.&lt;br /&gt;
&lt;br /&gt;
It is also possible for hosting companies to easily integrate their own online shop into the Open-Xchange Upsell Layer.&lt;br /&gt;
&lt;br /&gt;
The customer never has to leave the application to upsell - it&#039;s a native IN APP upsell.&lt;br /&gt;
&lt;br /&gt;
[[File:upsell.png|290px|thumb|left|Upsell Layer Mobility]] &lt;br /&gt;
[[File:Upsell_infostore.png|290px|thumb|left|Upsell Layer Infostore]]&lt;br /&gt;
[[File:upsell_calendar.png|290px|thumb|left|Upsell Layer Calendar]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
We have implemented 3 different types how to process the upsell an user is requesting in the hosters backend:&lt;br /&gt;
&lt;br /&gt;
* Show the Upsell Layer window and trigger the upgrade via a generated email to an email address after user clicked &amp;quot;buy&amp;quot; or &amp;quot;trial&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
In this email there is the information which user from which contaxt wants to upgrade to which package. After receiving the email the hoster&#039;s sales team can put the customer into billing.&lt;br /&gt;
&lt;br /&gt;
* Show the Upsell Layer window and open a configurable URL including all needed parameters after the user clicked &amp;quot;buy&amp;quot; or &amp;quot;trial.&lt;br /&gt;
&lt;br /&gt;
This is the perfect automated way if the hoster wants to have a full automated upsell which he can easily integrate into his existing provisioning &amp;amp; billing system.&lt;br /&gt;
&lt;br /&gt;
* Directly display a configurable URL/Online SHOP (systemwide or/and per context configurable) within the upsell Layer window instead of standard OX upsell content.&lt;br /&gt;
&lt;br /&gt;
This is the perfect automated way for all hosters which have an online shop in place and wants to use it for the upsell, too.&lt;br /&gt;
 &lt;br /&gt;
&lt;br /&gt;
The upsell layer has full i18n (EN and DE are included) support integrated and offers following components for advertisement:&lt;br /&gt;
&lt;br /&gt;
* Text&lt;br /&gt;
* Video &lt;br /&gt;
* Screenshots&lt;br /&gt;
&lt;br /&gt;
to promote a certain feature for Open-Xchange.&lt;br /&gt;
&lt;br /&gt;
The important part of the upsell layer is the ability to pass all needed parameters from users session like username,id,cid etc. + the feature he wants to buy, to a third party online shop system or send these parameters via email in machine readable (configurable) format to a dedicated mailsystem which can process it via procmail or similar to trigger the upgrade process via the Open-Xchange API´s (SOAP,RMI,CLT).&lt;br /&gt;
&lt;br /&gt;
{{InstallPlugin|pluginname=open-xchange-upsell-multiple open-xchange-upsell-multiple-gui|sopath=updates}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
After installation of these packages, you have installed one server side plugin and one gui-plugin. If you have dedicated apaches running in your setup, only install the &amp;quot;open-xchange-upsell-multiple-gui&amp;quot; package on them. The upsell layer is now available to ALL contexts/users of this OX application server/gui instance. All UI plugin contents are installed under following directory (on Debian based installations):&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
/var/www/ox6/plugins/com.openexchange.upsell.multiple.gui/&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
It contains different subdirectories, for example:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
css  - All colors, styles are defined within this directory.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
lang - All translated PO files must be stored below this directory.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
templates - If you want to change/replace screenshots, videos, layouts etc. check this directory.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The server side plugin comes with some templates, for example to change the advertisement text which is sent to the user, or the mail which is sent to the upgrade processing email system. All of them are stored below /opt/open-xchange/etc/groupware&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
upsell_mail_body_ox_enduser.tmpl&lt;br /&gt;
upsell_mail_body_ox_enduser.tmpl_de_DE&lt;br /&gt;
upsell_mail_subject_ox_enduser.tmpl&lt;br /&gt;
upsell_mail_subject_ox_enduser.tmpl_de_DE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Configuration ==&lt;br /&gt;
&lt;br /&gt;
Once installed, all necessary configuration can be done in one single file. This file can be found at the following directory on the OX application server:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
/opt/open-xchange/etc/groupware/upsell.properties&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Switching between the 3 different types of the upsell layer, edit parameter:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Possible values: &amp;quot;direct&amp;quot;, &amp;quot;static&amp;quot; or &amp;quot;email&amp;quot;. &lt;br /&gt;
&lt;br /&gt;
direct = Redirect within IFRAME immediately to parameter &amp;quot;com.openexchange.upsell.multiple.method.static.shop_redir_url&amp;quot; or to the context specific URL value after clicking one of the upsell triggers.&lt;br /&gt;
&lt;br /&gt;
static = Redirect AFTER clicking a button within the shipped OX Upsell pages to parameter &amp;quot;com.openexchange.upsell.multiple.method.static.shop_redir_url&amp;quot; or to the context specific URL value after clicking one of the upsell triggers.&lt;br /&gt;
&lt;br /&gt;
email = Send email to specific address AFTER clicking a button within the shipped OX Upsell pages &lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Defining the redirect URL for method &amp;quot;static&amp;quot; and &amp;quot;direct&amp;quot; for all contexts which are not specially provisioned, edit parameter:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.static.shop_redir_url=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
http://shop.host.tld/store?src=ox&amp;amp;user=_USER_&amp;amp;userid=_USERID_&amp;amp;mail=_MAIL_&amp;amp;login=_LOGIN_&amp;amp;imaplogin=_IMAPLOGIN_&amp;amp;clicked_feat=_CLICKED_FEATURE_&amp;amp;lang=_LANG_&amp;amp;cid=_CID_&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
As you can see from the example, the server side upsell plugin will replace all placeholders (_USER_ , _USERID_ etc.) with the data from the users OX session while he is logged into OX. You can use following parameters in this URL: &lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&amp;quot;_USER_&amp;quot;&lt;br /&gt;
&amp;quot;_USERID_&amp;quot;&lt;br /&gt;
&amp;quot;_MAIL_&amp;quot;&lt;br /&gt;
&amp;quot;_LOGIN_&amp;quot;&lt;br /&gt;
&amp;quot;_IMAPLOGIN&amp;quot;&lt;br /&gt;
&amp;quot;_CLICKED_FEATURE_&amp;quot;&lt;br /&gt;
&amp;quot;_UPSELL_PLAN_&amp;quot; - Not in use.&lt;br /&gt;
&amp;quot;_CID_&amp;quot;&lt;br /&gt;
&amp;quot;_LANG_&amp;quot;&lt;br /&gt;
&amp;quot;_PURCHASE_TYPE_&amp;quot; - Only used if email or static method is used due to the OX upsell layout/buttons&lt;br /&gt;
&amp;quot;_INVITE_&amp;quot; - User checked &amp;quot;invite my friends&amp;quot; checkbox in upsell box&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
If you need a different URL than specified in this configuration for one or more OX Contexts, you must set the custom attribute:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&amp;quot;com.openexchange.upsell/url&amp;quot;&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
into the admin user of the context via SOAP,RMI OR Commandline Tools.&lt;br /&gt;
 &lt;br /&gt;
WARNING: Due to Database restriction, you can only set the URL without any PAR&lt;br /&gt;
AMETERS. PLEASE ONLY SET THE HOST+PATH to your WEBAPP. &lt;br /&gt;
&lt;br /&gt;
Following PARAMETERS will be automatically appended to the URL:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
src=ox&amp;amp;user=_USER_&amp;amp;invite=_INVITE_&amp;amp;mail=_MAIL_&amp;amp;purchase_type=_PURCHASE_TYPE_&amp;amp;login=_LOGIN_&amp;amp;imaplogin=_IMAPLOGIN_&amp;amp;clicked_feat=_CLICKED_FEATURE_&amp;amp;upsell_plan=_U&lt;br /&gt;
PSELL_PLAN_&amp;amp;cid=_CID_&amp;amp;lang=_LANG_&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
To set the custom attribute via Commandline Tools, use following example:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
changeuser -i 2 -c 424242667 --com.openexchange.upsell/url=&amp;quot;http://my.reseller1.com/path/to/webapp/or/php_page.php?&amp;quot;&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Defining the email address where upsell plugin will send all infos to for processing this request in a machine readable format:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.address=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The mail will be send to this email address. It should be processed by some script via procmail or similar to trigger an API call later on.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Email template to load for sending the machine readable mail, if not found, hardcoded text will be used:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.template=/opt/open-xchange/etc/groupware/upsell_mail_body.tmpl&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
All needed paramaters can be included in this email. You can use same placeholders as in the &amp;quot;REDIRECT URL&amp;quot;, which is explained above.&lt;br /&gt;
&lt;br /&gt;
Defining email subject to use when sending upsell request mails. See available placeholder above:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.subject=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
If you like, the upsell plugin can also send an info/advertisement email to ox enduser to inform about upsell after the machine readable mail was sent:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.oxuser.enabled=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Defining email template to load for ox enduser, if mail to enduser is configured:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.method.email.oxuser.template=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
If you need i18n support within email templates, create template with suffix &amp;quot;_&amp;lt;LANGUAGE_CODE&amp;gt;&amp;quot; . Example: /var/upsell_mail_body_ox_enduser.tmpl_de_DE&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
If you want to use the builtin upgrade methods, you must also configure the OX RMI API informations:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
com.openexchange.upsell.multiple.rmi.host=&lt;br /&gt;
com.openexchange.upsell.multiple.rmi.masteradmin=&lt;br /&gt;
com.openexchange.upsell.multiple.rmi.masteradmin.pass=&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Adding new feature  (e.g. video, screenshot)==&lt;br /&gt;
&lt;br /&gt;
* Open register.js (located in gui folder)&lt;br /&gt;
* Search for upsell.config.features&lt;br /&gt;
* add the following code ( description inline )&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
featurename: {&lt;br /&gt;
  name: [&amp;quot;trigger element&amp;quot;],&lt;br /&gt;
  title: _(&amp;quot;upsell window title&amp;quot;),&lt;br /&gt;
  product_name: _(&amp;quot;feature headline&amp;quot;),&lt;br /&gt;
  intro: _(&amp;quot;upsell description text&amp;quot;),&lt;br /&gt;
  list: {&lt;br /&gt;
    list_item_1:  _(&amp;quot;enumeration&amp;quot;),&lt;br /&gt;
    list_item_2:  _(&amp;quot;enumeration&amp;quot;),&lt;br /&gt;
    list_item_3:  _(&amp;quot;...&amp;quot;),&lt;br /&gt;
  },&lt;br /&gt;
  outro: _(&amp;quot;upsell text that shows at end&amp;quot;),&lt;br /&gt;
  videos: {&lt;br /&gt;
    video_1: {&lt;br /&gt;
      thumb: &amp;quot;name_of_video_thumbnail.png&amp;quot;,&lt;br /&gt;
      video: &amp;quot;name_of_video_file.swf&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  },&lt;br /&gt;
  images: {&lt;br /&gt;
    image_1: {&lt;br /&gt;
      thumb: &amp;quot;name_of_image_thumbnail.png&amp;quot;,&lt;br /&gt;
      image: &amp;quot;name_of_lightbox_image.png&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  },&lt;br /&gt;
  buttons: {&lt;br /&gt;
    trial: {&lt;br /&gt;
      content: _(&amp;quot;buttonlabel&amp;quot;),&lt;br /&gt;
      action: &amp;quot;put javascript actions here if any&amp;quot;&lt;br /&gt;
    },&lt;br /&gt;
  },&lt;br /&gt;
  checkboxes: {&lt;br /&gt;
    invite:{&lt;br /&gt;
      content: _(&amp;quot;checkboxlabel&amp;quot;),&lt;br /&gt;
      action: &amp;quot;put javascript actions here if any&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  }&lt;br /&gt;
},&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
* after the feature is implemented you should create the nessacarry files and place them as follow&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
-templates&lt;br /&gt;
--_featurename&lt;br /&gt;
---- language ( for example de_DE )&lt;br /&gt;
-------- flash ( for videos )&lt;br /&gt;
-------- img ( for images )&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Load required js/cs files  ==&lt;br /&gt;
&lt;br /&gt;
* to load additional files open register.js and add the following code&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
upsell = {&lt;br /&gt;
  files: {&lt;br /&gt;
    jss: {&lt;br /&gt;
      name: {&lt;br /&gt;
        script: &amp;quot;name.js&amp;quot;,&lt;br /&gt;
      },&lt;br /&gt;
    },&lt;br /&gt;
   css: {&lt;br /&gt;
     name: &amp;quot;name.css&amp;quot;,&lt;br /&gt;
   },&lt;br /&gt;
 },&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
* add name.js to jss/name.js&lt;br /&gt;
* add name.css to css/name.css&lt;br /&gt;
&lt;br /&gt;
== Change look and feel (e.g. branding, colors and sizes) ==&lt;br /&gt;
&lt;br /&gt;
* you should edit the existing css located in /var/www/ox6/plugins/com.openexchange.upsell.multiple.gui/css/upsell.css&lt;br /&gt;
* you can add / edit background in /var/www/ox6/plugins/com.openexchange.upsell.multiple.gui//img&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Possible triggers ==&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
modules/calendar/freebusy&lt;br /&gt;
modules/calendar/team&lt;br /&gt;
modules/calendar/mini_calender&lt;br /&gt;
modules/calendar/new/add_participants&lt;br /&gt;
modules/calendar/new/remove_participants&lt;br /&gt;
modules/calendar/new/add_attachment&lt;br /&gt;
modules/calendar/new/delete_attachment&lt;br /&gt;
modules/contacts/new/add_attachment&lt;br /&gt;
modules/contacts/new/delete_attachment&lt;br /&gt;
modules/mail/save_to_infostore&lt;br /&gt;
modules/infostore/send_as_attachment&lt;br /&gt;
modules/infostore/send_as_link&lt;br /&gt;
modules/infostore/mail/save_to_infostore&lt;br /&gt;
modules/tasks/new/add_participants&lt;br /&gt;
modules/tasks/new/remove_participants&lt;br /&gt;
modules/tasks/new/add_attachment&lt;br /&gt;
modules/tasks/new/delete_attachment&lt;br /&gt;
configuration/mail/accounts/new&lt;br /&gt;
modules/folders/users&lt;br /&gt;
&lt;br /&gt;
modules/infostore&lt;br /&gt;
modules/calender&lt;br /&gt;
modules/contacts&lt;br /&gt;
modules/mail&lt;br /&gt;
modules/portal&lt;br /&gt;
modules/tasks&lt;br /&gt;
modules/configuration&lt;br /&gt;
&lt;br /&gt;
modules/outlook&lt;br /&gt;
modules/outlook.updater&lt;br /&gt;
modules/mobility&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Theming_Description&amp;diff=6845</id>
		<title>OX6:Gui Theming Description</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Theming_Description&amp;diff=6845"/>
		<updated>2011-01-12T15:13:42Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Branding - how-to customize the headline are */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
The Open-Xchange application allows you to create your own theme with your own colors and images. This tutorial will explain each step to create such theme.&lt;br /&gt;
&lt;br /&gt;
== Tools ==&lt;br /&gt;
&lt;br /&gt;
A good tool for testing, debugging and experimenting is the Firefox plug-in Firebug. This powerful plug-in can help you to debug your CSS elements on the fly. You also require a image manipulation program like Photoshop, Gimp or Corel Draw.&lt;br /&gt;
&lt;br /&gt;
== Understanding CSS ==&lt;br /&gt;
&lt;br /&gt;
The full layout of each Open-Xchange theme consists of two major parts: the CSS elements (90%) and the layout images (10%). This means, most of the theme is done in CSS. The main structure of the Open-Xchange frontend is done in HTML and combined with a CSS theme and a set of images completes the theme. The CSS elements control the look, size, position and sometimes the effect of a HTML element. If you want to change these attributes of a HTML element, you only need to define a class within you CSS file for this given HTML element. In this class, you can set the color, the size, the position and sometimes the effect of one or more HTML elements.&lt;br /&gt;
&lt;br /&gt;
Some HTML elements have a fixed group of attributes which are set in a CSS file which is not part of the Open-Xchange theme. These fixed parts are required to make the layout work correct. However, you can always override these attributes in your CSS file if you want to or if you need to. &lt;br /&gt;
&lt;br /&gt;
== Where to start ==&lt;br /&gt;
&lt;br /&gt;
All themes will be stored in the following directory of the Open-Xchange Server:&lt;br /&gt;
&lt;br /&gt;
 /var/www/ox6/themes/&lt;br /&gt;
&lt;br /&gt;
Per default you will have at least two themes in this directory: a default theme and a alternative theme. The easiest way to start with your own theme is to copy the default theme with:&lt;br /&gt;
&lt;br /&gt;
 cp -r /var/www/ox6/themes/default /var/www/ox6/themes/[YOUR_THEME_NAME]&lt;br /&gt;
&lt;br /&gt;
Now, you should start modifying your theme, by editing the stylesheet files in /var/www/ox6/themes/[YOUR_THEME_NAME]/css, and exchanging the images from /var/www/ox6/themes/[YOUR_THEME_NAME]/images. The following screenshots will give you an overview of the stylesheet structure, and which tags have to be modified in order to get your theme customized&lt;br /&gt;
&lt;br /&gt;
= Version 6.18.2 =&lt;br /&gt;
&lt;br /&gt;
== Setup description ==&lt;br /&gt;
&lt;br /&gt;
After you have created your theme, you should make this theme available in the configuration interface for users of the Open-Xchange Server. To do that, you only have to manifest your theme in the following server configuration file, afterwards your users can select your theme:&lt;br /&gt;
&lt;br /&gt;
 groupware/settings/themes.properties&lt;br /&gt;
&lt;br /&gt;
You will find at least two already existing themes there. Just add your new theme. We call our new theme &amp;quot;Mantis&amp;quot; which is also the path within the theme folder of the GUI.&lt;br /&gt;
&lt;br /&gt;
 modules/themes/mantis=Mantis&lt;br /&gt;
&lt;br /&gt;
Afterwards, restart the Open-Xchange service groupware. Your users can now select your theme.&lt;br /&gt;
&lt;br /&gt;
== Getting started, the background and the shadow ==&lt;br /&gt;
&lt;br /&gt;
Lets start with the basics, the background and the shadows. Open the global.css and change the background color:&lt;br /&gt;
&lt;br /&gt;
 body {&lt;br /&gt;
  &#039;&#039;&#039;background-color: #f1f1f1;&#039;&#039;&#039;&lt;br /&gt;
  font-family: Arial, Helvetica, sans-serif;&lt;br /&gt;
  font-size: 9pt;&lt;br /&gt;
  color:#000;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
Save the file and reload your theme.&lt;br /&gt;
&lt;br /&gt;
[[Image:Background_theming.png|thumb|150px|none|Background]]&lt;br /&gt;
&lt;br /&gt;
In this screenshot, you can see that the background is now brighter but the corners of the subwindows are still blue. These blue elements are images which provide the shadow of the subwindows. In the next step we will replace this image with a new one which fits our colors. Open the image for the left shadow which can be found here&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/img/border/cpbody-r.png&lt;br /&gt;
&lt;br /&gt;
Basicly, this image is only 4 pixel wide and infinite heigh. It doesn&#039;t matter if you cut it down to 1x4 pixel or make a 500x4 pixel version. It will be unlimited repeated. A easy way to add a shadow, is to use a gradient tool and make a 4 pixel gradient from a dark gray to a lighter gray.&lt;br /&gt;
&lt;br /&gt;
You also have to add a extra line to your global.css CSS file which looks like this.&lt;br /&gt;
&lt;br /&gt;
 #ox-sidesplit {&lt;br /&gt;
  right: 1px !important;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
Just add it to the bottom of your file.&lt;br /&gt;
&lt;br /&gt;
Take your new &#039;&#039;&#039;cpbody-r.png&#039;&#039;&#039; file and copy it into the same folder and overwrite the &#039;&#039;&#039;cpbody-l.png&#039;&#039;&#039; file. Then open it and rotate it for 180°. The left shadow is the same as the right one which means you can easily copy these files.&lt;br /&gt;
&lt;br /&gt;
Another quick CSS change is needed to fix some custom elements. Open &lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/css/bgimages.css&lt;br /&gt;
&lt;br /&gt;
and change this line for the new created cpbody-l.png file.&lt;br /&gt;
&lt;br /&gt;
 .cpheader-l {&lt;br /&gt;
  &#039;&#039;&#039;background-image: url(&amp;quot;../img/border/cpbody-l.png&amp;quot;);&#039;&#039;&#039;&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
The last thing you have to do, is to change the panel-switcher or sometimes called panel toggler. It is the little arrow in the upper left corner if you have closed the folder panel. You have to change the background shadow, too. The file is located here:&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/img/border/spback.gif&lt;br /&gt;
&lt;br /&gt;
You also have to make a minor change in the &#039;&#039;&#039;bgimages.css&#039;&#039;&#039; file. Add the last line to this class which reduces the right position from -10 to -8.&lt;br /&gt;
&lt;br /&gt;
 .sp-toggle&lt;br /&gt;
 {&lt;br /&gt;
  background-image:url(../img/border/spback.gif);&lt;br /&gt;
  &#039;&#039;&#039;right: -8px !important;&#039;&#039;&#039;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
At this point, you are done with all shadows and borders and the background.&lt;br /&gt;
&lt;br /&gt;
== Panels and bars ==&lt;br /&gt;
&lt;br /&gt;
We start with the &amp;quot;module name bar&amp;quot; and the navigation panel. For this example, we change the background color with a image, a gradient image. Create a image you like and place it within your theme folder.&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/img/&lt;br /&gt;
&lt;br /&gt;
Now we have to add this image to our CSS files. Both bars or panels get their entries in the &#039;&#039;&#039;global.css&#039;&#039;&#039;. You can replace the existing entries with a new one. &lt;br /&gt;
&lt;br /&gt;
 .topHeaderBG, .topheader-color {&lt;br /&gt;
  background-image: url(&amp;quot;../img/background_g.png&amp;quot;);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
and&lt;br /&gt;
&lt;br /&gt;
 div.oxTabControl {&lt;br /&gt;
  background-color: #dae1e6;&lt;br /&gt;
  background-image: url(../img/background_g.png);&lt;br /&gt;
  background-position: 100% 0;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
You might need to change your font color for these bars in case you switched to a brighter background image or color. Both is set in the &#039;&#039;&#039;global.css&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
 .ox-sidepanel-title {&lt;br /&gt;
  color: black;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
and&lt;br /&gt;
&lt;br /&gt;
 div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
  background-color: #555;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
You also might change the hover effect of the panel bar to fit the new colors:&lt;br /&gt;
&lt;br /&gt;
 div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
  background-color: #ccc;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
== Icons ==&lt;br /&gt;
&lt;br /&gt;
Since version 8.18.2 the Open-Xchange GUI comes with a new icon set. The old icons where a common 16x16 pixel GIF file. The new set comes in three different sizes, 16x16 pixel, 24x24 pixel and 34x34 pixel. Right now, only the 16x16 and 24x24 pixel icons are used. However, some of the new icons still exists as a old GIF file. If you take a closer look at the folder structure, you will see that all the new icons can be found at:&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/icons/&lt;br /&gt;
 &lt;br /&gt;
The old icons can be found in the folder&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/img/&lt;br /&gt;
&lt;br /&gt;
With the help of &#039;&#039;&#039;Firebug&#039;&#039;&#039; you can easily get the correct path for the icon you want to change. For this example, we changed the top navigation icons for the Open-Xchange modules like mail, calendar, contacts aso.&lt;br /&gt;
&lt;br /&gt;
In the following screenshot, you can see the results after all changes we made so far which includes some new icons, a modified background and shadows and some new bars and panels.&lt;br /&gt;
&lt;br /&gt;
[[Image:Screen_step1.png|thumb|150px|none|Background]]&lt;br /&gt;
&lt;br /&gt;
== Branding, get your logo into the frontend ==&lt;br /&gt;
&lt;br /&gt;
The new version 6.18.2 comes without a branding icon or logo in the upper area like in version 6.18.1 and earlier versions. To get a logo back into the top area just follow this small tutorial.&lt;br /&gt;
&lt;br /&gt;
 1. Go to your theme folder e.g. themes/${name}/css/&lt;br /&gt;
 &lt;br /&gt;
 2. Expand the file &amp;quot;concat.cssz&amp;quot; using gzip: &amp;quot;gzip -d -S .cssz concat.cssz&amp;quot;&lt;br /&gt;
 &lt;br /&gt;
 3. Open the file &amp;quot;concat&amp;quot; using a text editor (e.g. vim concat)&lt;br /&gt;
 &lt;br /&gt;
 4. Search for the tag &#039;#branding&#039;.&lt;br /&gt;
  Please note: Further details how-to enable the logo or how to change&lt;br /&gt;
  the height of the logo area, can be found in the comments.&lt;br /&gt;
 &lt;br /&gt;
 5. After editing the file, save your work and compress it again:&lt;br /&gt;
  &amp;quot;gzip -S .cssz concat&amp;quot; &lt;br /&gt;
 &lt;br /&gt;
 &#039;&#039;&#039;To test your modifications, clear your browser cache and hit the reload button of your browser.&#039;&#039;&#039;&lt;br /&gt;
 &lt;br /&gt;
 Please note:&lt;br /&gt;
 You will have to re-apply these changes on each update you install.&lt;br /&gt;
&lt;br /&gt;
== Branding, customize the headline area ==&lt;br /&gt;
&lt;br /&gt;
If you enabled the area with your logo on top of the page you may want to add additional html components like own buttons, links or additional images. &lt;br /&gt;
This short how-to gives you an small example to add some text links and an additional image to this section.&lt;br /&gt;
&lt;br /&gt;
First create a new UI plugin like described in the article [[GUI Plugin Development|Gui_Plugin_Development]]. Open the register.js of your plugin and add this example code:&lt;br /&gt;
&lt;br /&gt;
 //selects the branding div and append additional html elements using jQuery&lt;br /&gt;
 jQuery(&amp;quot;#branding&amp;quot;).append(&lt;br /&gt;
      jQuery(&amp;quot;&amp;lt;div/&amp;gt;&amp;quot;).css({ position: &amp;quot;absolute&amp;quot;, right: &amp;quot;10px&amp;quot;, lineHeight: &amp;quot;35px&amp;quot; }).append(&lt;br /&gt;
             jQuery(&amp;quot;&amp;lt;div/&amp;gt;&amp;quot;).css({ float: &amp;quot;right&amp;quot;, color: &amp;quot;#449ccf&amp;quot;, cursor: &amp;quot;pointer&amp;quot; }).text(&amp;quot;Legal&amp;quot;).click(function() { alert(&amp;quot;Clicked on Legal&amp;quot;) })&lt;br /&gt;
       ).append(&lt;br /&gt;
               jQuery(&amp;quot;&amp;lt;div/&amp;gt;&amp;quot;).css({ float: &amp;quot;right&amp;quot;, width: &amp;quot;30px&amp;quot;, color: &amp;quot;#999999&amp;quot;, textAlign: &amp;quot;center&amp;quot; }).text(&amp;quot;|&amp;quot;)&lt;br /&gt;
       ).append(&lt;br /&gt;
               jQuery(&amp;quot;&amp;lt;div/&amp;gt;&amp;quot;).css({ float: &amp;quot;right&amp;quot;, color: &amp;quot;#449ccf&amp;quot;, cursor: &amp;quot;pointer&amp;quot; }).text(&amp;quot;FAQs&amp;quot;).click(function() { alert(&amp;quot;Clicked on FAQs&amp;quot;) })&lt;br /&gt;
       ).append(&lt;br /&gt;
               jQuery(&amp;quot;&amp;lt;div/&amp;gt;&amp;quot;).css({ float: &amp;quot;right&amp;quot;, width: &amp;quot;30px&amp;quot;, color: &amp;quot;#999999&amp;quot;, textAlign: &amp;quot;center&amp;quot; }).text(&amp;quot;|&amp;quot;)&lt;br /&gt;
       ).append(&lt;br /&gt;
               jQuery(&amp;quot;&amp;lt;div/&amp;gt;&amp;quot;).css({ float: &amp;quot;right&amp;quot;, color: &amp;quot;#449ccf&amp;quot;, cursor: &amp;quot;pointer&amp;quot; }).text(&amp;quot;Contact&amp;quot;).click(function() { alert(&amp;quot;Clicked on Contact&amp;quot;) })&lt;br /&gt;
       )&lt;br /&gt;
 ).append(&lt;br /&gt;
       jQuery(&amp;quot;&amp;lt;div/&amp;gt;&amp;quot;).css({ position: &amp;quot;absolute&amp;quot;, height: &amp;quot;35px&amp;quot;, width: &amp;quot;221px&amp;quot;, left: &amp;quot;50%&amp;quot;, marginLeft: &amp;quot;-110px&amp;quot;, background: &amp;quot;url(&amp;quot; + ox.gui.themePath + &amp;quot;img/brand_middle.png)&amp;quot; })&lt;br /&gt;
 );&lt;br /&gt;
&lt;br /&gt;
[[Image:Example_logo_headline.png|thumb|600px|none|Example how it looks like]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
As you can see you can use either use jQuery or the &#039;normal&#039; document way to add DOM elements. Everything you need is some HTML and JavaScript knowlege.&lt;br /&gt;
&lt;br /&gt;
= Version 6.18.0 and lower =&lt;br /&gt;
&lt;br /&gt;
== Style ==&lt;br /&gt;
&lt;br /&gt;
Open the Open-Xchange CSS files for this changes.&lt;br /&gt;
&lt;br /&gt;
=== The Portal Page ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut portal.jpg|thumb|150px|none|The Portal Page]]&lt;br /&gt;
&lt;br /&gt;
#&amp;lt;body&amp;gt; .background-color&lt;br /&gt;
#cpbottom-color&lt;br /&gt;
#font-color-disabled&lt;br /&gt;
#font-style-headline&lt;br /&gt;
#background-color-additional-content&lt;br /&gt;
#border-background-default&lt;br /&gt;
#font-color-default&lt;br /&gt;
#font-style-lable&lt;br /&gt;
#font-color-header&lt;br /&gt;
#cpheader-color&lt;br /&gt;
#font-style-headline&lt;br /&gt;
#border-color-design&lt;br /&gt;
#background-color-content&lt;br /&gt;
#font-color-header&lt;br /&gt;
#topHeaderBG&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== The Calendar Page ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar.jpg|thumb|150px|none|The Calendar Page]]&lt;br /&gt;
&lt;br /&gt;
#font-color-disabled&lt;br /&gt;
#wholeDayBackground&lt;br /&gt;
#background-color-PMG-selection-elements&lt;br /&gt;
#offTimeBackground&lt;br /&gt;
#strokeCalendar&lt;br /&gt;
#sectionStrokeCalendar&lt;br /&gt;
#border-color-image&lt;br /&gt;
#font-style-big-headline&lt;br /&gt;
#kwSeperationBackGround&lt;br /&gt;
#workTimeBackground&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Calendar Month View ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar month.jpg|thumb|150px|none|Calendar Month View]]&lt;br /&gt;
&lt;br /&gt;
#wholeDayBackground&lt;br /&gt;
#appointmentTEMPORARY&lt;br /&gt;
#appointmentRESERVED&lt;br /&gt;
#appointmentABSENT&lt;br /&gt;
#appointmentFREE&lt;br /&gt;
#workTimeBackground&lt;br /&gt;
#offTimeBackground&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== New Appointment ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar new.jpg|thumb|150px|none|New Appointment]]&lt;br /&gt;
&lt;br /&gt;
#background-color-additional-content&lt;br /&gt;
#font-color-disabled&lt;br /&gt;
#border-color-design&lt;br /&gt;
#border-color-content-default&lt;br /&gt;
#background-color-content&lt;br /&gt;
#font-style-lable&lt;br /&gt;
#background-color-default&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== New Appointment Series ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar new serie.jpg|thumb|150px|none|New Appointment Series]]&lt;br /&gt;
&lt;br /&gt;
#popupHeaderBackground&lt;br /&gt;
#popup-header&lt;br /&gt;
#greywrapper&lt;br /&gt;
#background-color-additional-content&lt;br /&gt;
#border-color-design&lt;br /&gt;
#popupBackground&lt;br /&gt;
&lt;br /&gt;
=== Calendar Week View ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar week.jpg|thumb|150px|none|Calendar Week View]]&lt;br /&gt;
&lt;br /&gt;
#border-color-design&lt;br /&gt;
#font-style-low&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Mail View ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut mail.jpg|thumb|150px|none|Mail View]]&lt;br /&gt;
&lt;br /&gt;
#selected&lt;br /&gt;
#tr&lt;br /&gt;
#font-style-big-headline&lt;br /&gt;
#font-style-lable&lt;br /&gt;
#border-color-design&lt;br /&gt;
#defaultContainer&lt;br /&gt;
&lt;br /&gt;
== Setup description ==&lt;br /&gt;
&lt;br /&gt;
After you have created and modified your theme, you should make those theme available in the configuration interface for users of the Open-Xchange Server. To do that, you only have to manifest your theme in the following server configuration file, afterwards your users can select your theme:&lt;br /&gt;
&lt;br /&gt;
 /opt/open-xchange/etc/groupware/settings/themes.properties&lt;br /&gt;
&lt;br /&gt;
Each key in this property file must be prefixed with the theme bundle identifier. This is &amp;quot;com.openexchange.themes&amp;quot;. The prefix must be followed with the unique identifier of a theme. This unique identifier specifies the directory name of the theme on the web server (/var/www/ox6/themes/ per default), too. The value of the property can be any name to described the theme. This name will be displayed in the AJAX GUI for selecting a theme. For example you should add the following line to this configuration file:&lt;br /&gt;
&lt;br /&gt;
 com.openexchange.themes.[YOUR_THEME_NAME]=[YOUR_THEME_DESCRIPTION]&lt;br /&gt;
&lt;br /&gt;
Afterwards, restart the Open-Xchange service groupware. Your users can now select your theme.&lt;br /&gt;
&lt;br /&gt;
== End user view ==&lt;br /&gt;
&lt;br /&gt;
After you have created and configured your theme, your users will be able to select it in the configuration frontend:&lt;br /&gt;
&lt;br /&gt;
[[Image:Theme_selection.png]]&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=File:Example_logo_headline.png&amp;diff=6844</id>
		<title>File:Example logo headline.png</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=File:Example_logo_headline.png&amp;diff=6844"/>
		<updated>2011-01-12T15:10:09Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Theming_Description&amp;diff=6843</id>
		<title>OX6:Gui Theming Description</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Theming_Description&amp;diff=6843"/>
		<updated>2011-01-12T14:29:20Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Added new branding section to custome headline area&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
The Open-Xchange application allows you to create your own theme with your own colors and images. This tutorial will explain each step to create such theme.&lt;br /&gt;
&lt;br /&gt;
== Tools ==&lt;br /&gt;
&lt;br /&gt;
A good tool for testing, debugging and experimenting is the Firefox plug-in Firebug. This powerful plug-in can help you to debug your CSS elements on the fly. You also require a image manipulation program like Photoshop, Gimp or Corel Draw.&lt;br /&gt;
&lt;br /&gt;
== Understanding CSS ==&lt;br /&gt;
&lt;br /&gt;
The full layout of each Open-Xchange theme consists of two major parts: the CSS elements (90%) and the layout images (10%). This means, most of the theme is done in CSS. The main structure of the Open-Xchange frontend is done in HTML and combined with a CSS theme and a set of images completes the theme. The CSS elements control the look, size, position and sometimes the effect of a HTML element. If you want to change these attributes of a HTML element, you only need to define a class within you CSS file for this given HTML element. In this class, you can set the color, the size, the position and sometimes the effect of one or more HTML elements.&lt;br /&gt;
&lt;br /&gt;
Some HTML elements have a fixed group of attributes which are set in a CSS file which is not part of the Open-Xchange theme. These fixed parts are required to make the layout work correct. However, you can always override these attributes in your CSS file if you want to or if you need to. &lt;br /&gt;
&lt;br /&gt;
== Where to start ==&lt;br /&gt;
&lt;br /&gt;
All themes will be stored in the following directory of the Open-Xchange Server:&lt;br /&gt;
&lt;br /&gt;
 /var/www/ox6/themes/&lt;br /&gt;
&lt;br /&gt;
Per default you will have at least two themes in this directory: a default theme and a alternative theme. The easiest way to start with your own theme is to copy the default theme with:&lt;br /&gt;
&lt;br /&gt;
 cp -r /var/www/ox6/themes/default /var/www/ox6/themes/[YOUR_THEME_NAME]&lt;br /&gt;
&lt;br /&gt;
Now, you should start modifying your theme, by editing the stylesheet files in /var/www/ox6/themes/[YOUR_THEME_NAME]/css, and exchanging the images from /var/www/ox6/themes/[YOUR_THEME_NAME]/images. The following screenshots will give you an overview of the stylesheet structure, and which tags have to be modified in order to get your theme customized&lt;br /&gt;
&lt;br /&gt;
= Version 6.18.2 =&lt;br /&gt;
&lt;br /&gt;
== Setup description ==&lt;br /&gt;
&lt;br /&gt;
After you have created your theme, you should make this theme available in the configuration interface for users of the Open-Xchange Server. To do that, you only have to manifest your theme in the following server configuration file, afterwards your users can select your theme:&lt;br /&gt;
&lt;br /&gt;
 groupware/settings/themes.properties&lt;br /&gt;
&lt;br /&gt;
You will find at least two already existing themes there. Just add your new theme. We call our new theme &amp;quot;Mantis&amp;quot; which is also the path within the theme folder of the GUI.&lt;br /&gt;
&lt;br /&gt;
 modules/themes/mantis=Mantis&lt;br /&gt;
&lt;br /&gt;
Afterwards, restart the Open-Xchange service groupware. Your users can now select your theme.&lt;br /&gt;
&lt;br /&gt;
== Getting started, the background and the shadow ==&lt;br /&gt;
&lt;br /&gt;
Lets start with the basics, the background and the shadows. Open the global.css and change the background color:&lt;br /&gt;
&lt;br /&gt;
 body {&lt;br /&gt;
  &#039;&#039;&#039;background-color: #f1f1f1;&#039;&#039;&#039;&lt;br /&gt;
  font-family: Arial, Helvetica, sans-serif;&lt;br /&gt;
  font-size: 9pt;&lt;br /&gt;
  color:#000;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
Save the file and reload your theme.&lt;br /&gt;
&lt;br /&gt;
[[Image:Background_theming.png|thumb|150px|none|Background]]&lt;br /&gt;
&lt;br /&gt;
In this screenshot, you can see that the background is now brighter but the corners of the subwindows are still blue. These blue elements are images which provide the shadow of the subwindows. In the next step we will replace this image with a new one which fits our colors. Open the image for the left shadow which can be found here&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/img/border/cpbody-r.png&lt;br /&gt;
&lt;br /&gt;
Basicly, this image is only 4 pixel wide and infinite heigh. It doesn&#039;t matter if you cut it down to 1x4 pixel or make a 500x4 pixel version. It will be unlimited repeated. A easy way to add a shadow, is to use a gradient tool and make a 4 pixel gradient from a dark gray to a lighter gray.&lt;br /&gt;
&lt;br /&gt;
You also have to add a extra line to your global.css CSS file which looks like this.&lt;br /&gt;
&lt;br /&gt;
 #ox-sidesplit {&lt;br /&gt;
  right: 1px !important;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
Just add it to the bottom of your file.&lt;br /&gt;
&lt;br /&gt;
Take your new &#039;&#039;&#039;cpbody-r.png&#039;&#039;&#039; file and copy it into the same folder and overwrite the &#039;&#039;&#039;cpbody-l.png&#039;&#039;&#039; file. Then open it and rotate it for 180°. The left shadow is the same as the right one which means you can easily copy these files.&lt;br /&gt;
&lt;br /&gt;
Another quick CSS change is needed to fix some custom elements. Open &lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/css/bgimages.css&lt;br /&gt;
&lt;br /&gt;
and change this line for the new created cpbody-l.png file.&lt;br /&gt;
&lt;br /&gt;
 .cpheader-l {&lt;br /&gt;
  &#039;&#039;&#039;background-image: url(&amp;quot;../img/border/cpbody-l.png&amp;quot;);&#039;&#039;&#039;&lt;br /&gt;
  background-position: 0% 0%;&lt;br /&gt;
  background-repeat: repeat-y;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
The last thing you have to do, is to change the panel-switcher or sometimes called panel toggler. It is the little arrow in the upper left corner if you have closed the folder panel. You have to change the background shadow, too. The file is located here:&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/img/border/spback.gif&lt;br /&gt;
&lt;br /&gt;
You also have to make a minor change in the &#039;&#039;&#039;bgimages.css&#039;&#039;&#039; file. Add the last line to this class which reduces the right position from -10 to -8.&lt;br /&gt;
&lt;br /&gt;
 .sp-toggle&lt;br /&gt;
 {&lt;br /&gt;
  background-image:url(../img/border/spback.gif);&lt;br /&gt;
  &#039;&#039;&#039;right: -8px !important;&#039;&#039;&#039;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
At this point, you are done with all shadows and borders and the background.&lt;br /&gt;
&lt;br /&gt;
== Panels and bars ==&lt;br /&gt;
&lt;br /&gt;
We start with the &amp;quot;module name bar&amp;quot; and the navigation panel. For this example, we change the background color with a image, a gradient image. Create a image you like and place it within your theme folder.&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/img/&lt;br /&gt;
&lt;br /&gt;
Now we have to add this image to our CSS files. Both bars or panels get their entries in the &#039;&#039;&#039;global.css&#039;&#039;&#039;. You can replace the existing entries with a new one. &lt;br /&gt;
&lt;br /&gt;
 .topHeaderBG, .topheader-color {&lt;br /&gt;
  background-image: url(&amp;quot;../img/background_g.png&amp;quot;);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
and&lt;br /&gt;
&lt;br /&gt;
 div.oxTabControl {&lt;br /&gt;
  background-color: #dae1e6;&lt;br /&gt;
  background-image: url(../img/background_g.png);&lt;br /&gt;
  background-position: 100% 0;&lt;br /&gt;
  background-repeat: no-repeat;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
You might need to change your font color for these bars in case you switched to a brighter background image or color. Both is set in the &#039;&#039;&#039;global.css&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
 .ox-sidepanel-title {&lt;br /&gt;
  color: black;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
and&lt;br /&gt;
&lt;br /&gt;
 div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
  background-color: #555;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
You also might change the hover effect of the panel bar to fit the new colors:&lt;br /&gt;
&lt;br /&gt;
 div.oxTabControl td.oxTab:hover, div.oxTabControl td.oxTabLast:hover {&lt;br /&gt;
  background-color: #ccc;&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
== Icons ==&lt;br /&gt;
&lt;br /&gt;
Since version 8.18.2 the Open-Xchange GUI comes with a new icon set. The old icons where a common 16x16 pixel GIF file. The new set comes in three different sizes, 16x16 pixel, 24x24 pixel and 34x34 pixel. Right now, only the 16x16 and 24x24 pixel icons are used. However, some of the new icons still exists as a old GIF file. If you take a closer look at the folder structure, you will see that all the new icons can be found at:&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/icons/&lt;br /&gt;
 &lt;br /&gt;
The old icons can be found in the folder&lt;br /&gt;
&lt;br /&gt;
 /themes/[YOUR_THEME_NAME]/img/&lt;br /&gt;
&lt;br /&gt;
With the help of &#039;&#039;&#039;Firebug&#039;&#039;&#039; you can easily get the correct path for the icon you want to change. For this example, we changed the top navigation icons for the Open-Xchange modules like mail, calendar, contacts aso.&lt;br /&gt;
&lt;br /&gt;
In the following screenshot, you can see the results after all changes we made so far which includes some new icons, a modified background and shadows and some new bars and panels.&lt;br /&gt;
&lt;br /&gt;
[[Image:Screen_step1.png|thumb|150px|none|Background]]&lt;br /&gt;
&lt;br /&gt;
== Branding, get your logo into the frontend ==&lt;br /&gt;
&lt;br /&gt;
The new version 6.18.2 comes without a branding icon or logo in the upper area like in version 6.18.1 and earlier versions. To get a logo back into the top area just follow this small tutorial.&lt;br /&gt;
&lt;br /&gt;
 1. Go to your theme folder e.g. themes/${name}/css/&lt;br /&gt;
 &lt;br /&gt;
 2. Expand the file &amp;quot;concat.cssz&amp;quot; using gzip: &amp;quot;gzip -d -S .cssz concat.cssz&amp;quot;&lt;br /&gt;
 &lt;br /&gt;
 3. Open the file &amp;quot;concat&amp;quot; using a text editor (e.g. vim concat)&lt;br /&gt;
 &lt;br /&gt;
 4. Search for the tag &#039;#branding&#039;.&lt;br /&gt;
  Please note: Further details how-to enable the logo or how to change&lt;br /&gt;
  the height of the logo area, can be found in the comments.&lt;br /&gt;
 &lt;br /&gt;
 5. After editing the file, save your work and compress it again:&lt;br /&gt;
  &amp;quot;gzip -S .cssz concat&amp;quot; &lt;br /&gt;
 &lt;br /&gt;
 &#039;&#039;&#039;To test your modifications, clear your browser cache and hit the reload button of your browser.&#039;&#039;&#039;&lt;br /&gt;
 &lt;br /&gt;
 Please note:&lt;br /&gt;
 You will have to re-apply these changes on each update you install.&lt;br /&gt;
&lt;br /&gt;
== Branding - how-to customize the headline are ==&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
= Version 6.18.0 and lower =&lt;br /&gt;
&lt;br /&gt;
== Style ==&lt;br /&gt;
&lt;br /&gt;
Open the Open-Xchange CSS files for this changes.&lt;br /&gt;
&lt;br /&gt;
=== The Portal Page ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut portal.jpg|thumb|150px|none|The Portal Page]]&lt;br /&gt;
&lt;br /&gt;
#&amp;lt;body&amp;gt; .background-color&lt;br /&gt;
#cpbottom-color&lt;br /&gt;
#font-color-disabled&lt;br /&gt;
#font-style-headline&lt;br /&gt;
#background-color-additional-content&lt;br /&gt;
#border-background-default&lt;br /&gt;
#font-color-default&lt;br /&gt;
#font-style-lable&lt;br /&gt;
#font-color-header&lt;br /&gt;
#cpheader-color&lt;br /&gt;
#font-style-headline&lt;br /&gt;
#border-color-design&lt;br /&gt;
#background-color-content&lt;br /&gt;
#font-color-header&lt;br /&gt;
#topHeaderBG&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== The Calendar Page ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar.jpg|thumb|150px|none|The Calendar Page]]&lt;br /&gt;
&lt;br /&gt;
#font-color-disabled&lt;br /&gt;
#wholeDayBackground&lt;br /&gt;
#background-color-PMG-selection-elements&lt;br /&gt;
#offTimeBackground&lt;br /&gt;
#strokeCalendar&lt;br /&gt;
#sectionStrokeCalendar&lt;br /&gt;
#border-color-image&lt;br /&gt;
#font-style-big-headline&lt;br /&gt;
#kwSeperationBackGround&lt;br /&gt;
#workTimeBackground&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Calendar Month View ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar month.jpg|thumb|150px|none|Calendar Month View]]&lt;br /&gt;
&lt;br /&gt;
#wholeDayBackground&lt;br /&gt;
#appointmentTEMPORARY&lt;br /&gt;
#appointmentRESERVED&lt;br /&gt;
#appointmentABSENT&lt;br /&gt;
#appointmentFREE&lt;br /&gt;
#workTimeBackground&lt;br /&gt;
#offTimeBackground&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== New Appointment ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar new.jpg|thumb|150px|none|New Appointment]]&lt;br /&gt;
&lt;br /&gt;
#background-color-additional-content&lt;br /&gt;
#font-color-disabled&lt;br /&gt;
#border-color-design&lt;br /&gt;
#border-color-content-default&lt;br /&gt;
#background-color-content&lt;br /&gt;
#font-style-lable&lt;br /&gt;
#background-color-default&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== New Appointment Series ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar new serie.jpg|thumb|150px|none|New Appointment Series]]&lt;br /&gt;
&lt;br /&gt;
#popupHeaderBackground&lt;br /&gt;
#popup-header&lt;br /&gt;
#greywrapper&lt;br /&gt;
#background-color-additional-content&lt;br /&gt;
#border-color-design&lt;br /&gt;
#popupBackground&lt;br /&gt;
&lt;br /&gt;
=== Calendar Week View ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut calendar week.jpg|thumb|150px|none|Calendar Week View]]&lt;br /&gt;
&lt;br /&gt;
#border-color-design&lt;br /&gt;
#font-style-low&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Mail View ===&lt;br /&gt;
&lt;br /&gt;
[[Image:Cut mail.jpg|thumb|150px|none|Mail View]]&lt;br /&gt;
&lt;br /&gt;
#selected&lt;br /&gt;
#tr&lt;br /&gt;
#font-style-big-headline&lt;br /&gt;
#font-style-lable&lt;br /&gt;
#border-color-design&lt;br /&gt;
#defaultContainer&lt;br /&gt;
&lt;br /&gt;
== Setup description ==&lt;br /&gt;
&lt;br /&gt;
After you have created and modified your theme, you should make those theme available in the configuration interface for users of the Open-Xchange Server. To do that, you only have to manifest your theme in the following server configuration file, afterwards your users can select your theme:&lt;br /&gt;
&lt;br /&gt;
 /opt/open-xchange/etc/groupware/settings/themes.properties&lt;br /&gt;
&lt;br /&gt;
Each key in this property file must be prefixed with the theme bundle identifier. This is &amp;quot;com.openexchange.themes&amp;quot;. The prefix must be followed with the unique identifier of a theme. This unique identifier specifies the directory name of the theme on the web server (/var/www/ox6/themes/ per default), too. The value of the property can be any name to described the theme. This name will be displayed in the AJAX GUI for selecting a theme. For example you should add the following line to this configuration file:&lt;br /&gt;
&lt;br /&gt;
 com.openexchange.themes.[YOUR_THEME_NAME]=[YOUR_THEME_DESCRIPTION]&lt;br /&gt;
&lt;br /&gt;
Afterwards, restart the Open-Xchange service groupware. Your users can now select your theme.&lt;br /&gt;
&lt;br /&gt;
== End user view ==&lt;br /&gt;
&lt;br /&gt;
After you have created and configured your theme, your users will be able to select it in the configuration frontend:&lt;br /&gt;
&lt;br /&gt;
[[Image:Theme_selection.png]]&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=6692</id>
		<title>OX6:Gui Plugin Development</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=6692"/>
		<updated>2010-12-09T17:00:54Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Updated upsell parameter / events&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
With Open-Xchange SP4 you will be able to add your own JavaScript code for existing events. The following examples show how you can add your own About page, your own Window Title, and your own message for not activated/bought components of OX (Upsell Message).&lt;br /&gt;
&lt;br /&gt;
= Setup and file description =&lt;br /&gt;
&lt;br /&gt;
Two things have to be done to register your own JavaScript code within the server:&lt;br /&gt;
&lt;br /&gt;
1. You have to create the property file in /opt/open-xchange/etc/groupware/settings/, for example myjscode.properties. The file should have the following value:&lt;br /&gt;
&lt;br /&gt;
 modules/$NAME/enabled=true&lt;br /&gt;
&lt;br /&gt;
$NAME is equal to the file name of the property file, in our case it would be:&lt;br /&gt;
&lt;br /&gt;
 modules/myjscode/enabled=true&lt;br /&gt;
&lt;br /&gt;
This will enable the JS code located in $WEBSRV/ox6/plugins/$NAME (for example /var/www/ox6/plugins/myjscode/).&lt;br /&gt;
&lt;br /&gt;
2. Next we have to create the folder that we configured, in our example we would have to create:&lt;br /&gt;
&lt;br /&gt;
 mkdir /var/www/ox6/plugins/myjscode/&lt;br /&gt;
&lt;br /&gt;
The server now will have a look at this directory and searches for the register.js file in this directory. All your JS enhancements should be written to that file.&lt;br /&gt;
&lt;br /&gt;
3. Afterwards you have to restart the groupware server with:&lt;br /&gt;
&lt;br /&gt;
 /etc/init.d/open-xchange-groupware restart&lt;br /&gt;
&lt;br /&gt;
= Examples =&lt;br /&gt;
&lt;br /&gt;
== Customized About page ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/productinfo.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/productinfo/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/productinfo/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.vendor_address = &amp;quot;&amp;lt;b&amp;gt;Open-Xchange GmbH&amp;lt;/b&amp;gt;\nMartinstrasse 41\n57462 Olpe\nE-Mail: info@open-xchange.com\n&amp;lt;a href=\&amp;quot;http://www.open-xchange.com\&amp;quot; target=\&amp;quot;_blank\&amp;quot;&amp;gt;www.open-xchange.com&amp;lt;/a&amp;gt;&amp;quot;&lt;br /&gt;
&lt;br /&gt;
== Customized Window Title ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/windowtitle.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/windowtitle/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/windowtitle/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.product_name = &amp;quot;This is the fabulous Open-Xchange Server&amp;quot;; &lt;br /&gt;
 &lt;br /&gt;
 try {&lt;br /&gt;
     window.document.title = oxProductInfo.product_name;&lt;br /&gt;
 } catch (e) { }&lt;br /&gt;
&lt;br /&gt;
== Customized Upsell Message ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/upsell.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com&lt;br /&gt;
 # &lt;br /&gt;
 # Author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 # The following property enables the Upsell-Layer Plugin for the OX6 AJAX GUI&lt;br /&gt;
 modules/upsell/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/upsell/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 /*&lt;br /&gt;
  * Example for an Upsell-Layer&lt;br /&gt;
  * The OX GUI triggers a special event if a user clicks on disabled features.&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
  /*&lt;br /&gt;
   * Register to Upsell-Event&lt;br /&gt;
   */&lt;br /&gt;
  register(&amp;quot;Feature_Not_Available&amp;quot;, showUpsellLayer);&lt;br /&gt;
 &lt;br /&gt;
  /**&lt;br /&gt;
   * Function to display an Upsell-Alert dialog&lt;br /&gt;
   * @param feature String (optional) - Module description&lt;br /&gt;
   * @param win Window (optional) - Only needed/given if we trigger the event from the new object windows &lt;br /&gt;
   */&lt;br /&gt;
  function showUpsellLayer(feature, win) {&lt;br /&gt;
     // setting corewindow to default if win is not defined&lt;br /&gt;
     win = win || corewindow; &lt;br /&gt;
     &lt;br /&gt;
     /*&lt;br /&gt;
      * Build up the dialog content&lt;br /&gt;
      * Note: You can also use myDiv.innerHTML!&lt;br /&gt;
      */&lt;br /&gt;
     var myDiv = newnode(&amp;quot;div&amp;quot;,{ textAlign: &amp;quot;center&amp;quot;, padding: &amp;quot;10px&amp;quot; }, 0, [ &lt;br /&gt;
             newnode(&amp;quot;div&amp;quot;, 0, { background: &amp;quot;url(http://www.example.com/img/header/logo.gif)&amp;quot; }, 0,&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;span&amp;quot;, 0, 0, [ &lt;br /&gt;
                 document.createTextNode(&amp;quot;Diese Funktion ist nur in Open-Xchange Premium verfügbar!&amp;quot;) ],&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Weitere Information zu Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Paket-Upgrade auf Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document) &lt;br /&gt;
         ], win.document);&lt;br /&gt;
     &lt;br /&gt;
     // calling the newAlert function to open the dialog at the given window&lt;br /&gt;
     win.newAlert(&amp;quot;Hinweis &amp;quot; + feature, null, AlertPopup.close, myDiv);&lt;br /&gt;
  }&lt;br /&gt;
  &lt;br /&gt;
  /*&lt;br /&gt;
   * Comment this out to change the grayed out module images in the upper left corner!&lt;br /&gt;
   */&lt;br /&gt;
  /*&lt;br /&gt;
  if (!document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src.match(/mod_portal_sel.gif$/)) {&lt;br /&gt;
     document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src = getFullImgSrc(&amp;quot;img/portal/mod_portal.gif&amp;quot;);&lt;br /&gt;
  }&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_calendar&amp;quot;).src = getFullImgSrc(&amp;quot;img/calendar/mod_calendar.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_tasks&amp;quot;).src = getFullImgSrc(&amp;quot;img/tasks/mod_tasks.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_infostore&amp;quot;).src = getFullImgSrc(&amp;quot;img/infostore/mod_infostore.gif&amp;quot;);&lt;br /&gt;
  */&lt;br /&gt;
&lt;br /&gt;
Currently, the parameter &amp;lt;code&amp;gt;feature&amp;lt;/code&amp;gt; can have following values:&lt;br /&gt;
* configuration/mail/accounts/new&lt;br /&gt;
* modules/calendar&lt;br /&gt;
* modules/calendar/freebusy&lt;br /&gt;
* modules/calendar/mini_calender&lt;br /&gt;
* modules/calendar/new/add_attachment&lt;br /&gt;
* modules/calendar/new/add_participants&lt;br /&gt;
* modules/calendar/new/delete_attachment&lt;br /&gt;
* modules/calendar/new/remove_participants&lt;br /&gt;
* modules/calendar/save_to_infostore&lt;br /&gt;
* modules/calendar/team&lt;br /&gt;
* modules/contacts&lt;br /&gt;
* modules/contacts/save_to_infostore&lt;br /&gt;
* modules/contacts/new/add_attachment&lt;br /&gt;
* modules/contacts/new/delete_attachment&lt;br /&gt;
* modules/folders/users&lt;br /&gt;
* modules/infostore&lt;br /&gt;
* modules/infostore/send_as_attachment&lt;br /&gt;
* modules/infostore/send_as_link&lt;br /&gt;
* modules/infostore/mail/save_to_infostore&lt;br /&gt;
* modules/mail&lt;br /&gt;
* modules/mail/save_to_infostore&lt;br /&gt;
* modules/mail/new/add_infostore_attachment&lt;br /&gt;
* modules/portal&lt;br /&gt;
* modules/tasks&lt;br /&gt;
* modules/tasks/save_to_infostore&lt;br /&gt;
* modules/tasks/new/add_participants&lt;br /&gt;
* modules/tasks/new/remove_participants&lt;br /&gt;
* modules/tasks/new/add_attachment&lt;br /&gt;
* modules/tasks/new/delete_attachment&lt;br /&gt;
&lt;br /&gt;
The following events may triggered by plugins (if enabled):&lt;br /&gt;
* modules/usm/eas&lt;br /&gt;
&lt;br /&gt;
== Customized / Extended configuration tree ==&lt;br /&gt;
&lt;br /&gt;
In order to extend your configuration frontend you will have to make more changes than overwriting existing JS methods. You have to implement your own configuration site. Below, you will find the JS API Doc that will show you how to build external contents into the configuration frontend:&lt;br /&gt;
&lt;br /&gt;
[[Main_Page#Interfaces|JavaScript API for extending the configuration frontend]]&lt;br /&gt;
and&lt;br /&gt;
[[Main_Page#UI_Customization|Gui Plugin API Documentation]]&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/extendconfiguration.properties:&lt;br /&gt;
&lt;br /&gt;
 modules/extendconfiguration/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/extendconfiguration/register.js:&lt;br /&gt;
&lt;br /&gt;
 // Extending the configuration tree.&lt;br /&gt;
 &lt;br /&gt;
 // Add a new folder-like node called &amp;quot;Example&amp;quot;, and inside it another node&lt;br /&gt;
 // called &amp;quot;Page&amp;quot;. The position of a node is specified by a path string.&lt;br /&gt;
 // Each tree level is separated by slashes. There should be only two levels&lt;br /&gt;
 // below the standard &amp;quot;configuration&amp;quot; root element: configuration/x for inner&lt;br /&gt;
 // nodes and configuration/x/y for leaf nodes.&lt;br /&gt;
 &lt;br /&gt;
 new ox.Configuration.InnerNode(&amp;quot;configuration/example&amp;quot;, &amp;quot;Example&amp;quot;);&lt;br /&gt;
 var node = new ox.Configuration.LeafNode(&amp;quot;configuration/example/page&amp;quot;, &amp;quot;Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Connect the node to a new page. &lt;br /&gt;
 &lt;br /&gt;
 var page = new ox.Configuration.Page(node, &amp;quot;Example Configuration Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All data on the page is collected in a single data object. This object is&lt;br /&gt;
 // transmitted to and from the server in the methods load() and save() using&lt;br /&gt;
 // static methods of ox.JSON.&lt;br /&gt;
 // For save(), the parameter cont is a continuation function which must be&lt;br /&gt;
 // called after the data was saved successfully.&lt;br /&gt;
 &lt;br /&gt;
 page.save = function(data, cont) {&lt;br /&gt;
     ox.JSON.put(AjaxRoot + &amp;quot;/serverplugin?action=set&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         data, cont);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // The continuation function of load() expects the data object as parameter.&lt;br /&gt;
 // To extract the data object from the server reply, a new continuation function&lt;br /&gt;
 // is used.&lt;br /&gt;
 &lt;br /&gt;
 page.load = function(cont) {&lt;br /&gt;
     ox.JSON.get(AjaxRoot + &amp;quot;/serverplugin?action=get&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         function(reply) { cont(reply.data); });&lt;br /&gt;
 };&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Content is added to the page with the method addWidget().&lt;br /&gt;
 // Here, a static text is added at the top of the page.&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.Text(&amp;quot;Long explanation text&amp;quot;));&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Individual input widgets can be connected to fields in the data object by&lt;br /&gt;
 // specifying the field name as the second parameter to addWidget().&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.CheckBox(&amp;quot;CheckBox Label&amp;quot;), &amp;quot;fieldname&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Layout can be controlled by using container widgets.&lt;br /&gt;
 // Configuration pages currently support only the Group container, which adds&lt;br /&gt;
 // a header over its children.&lt;br /&gt;
 // Every group has its own data object, which becomes nested in the page&#039;s&lt;br /&gt;
 // data object.&lt;br /&gt;
 &lt;br /&gt;
 var group = new ox.Configuration.Group(&amp;quot;Group title&amp;quot;);&lt;br /&gt;
 page.addWidget(group, &amp;quot;subobject&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Adding widgets to a goup happens exactly like for a page, since both are&lt;br /&gt;
 // descendants of ox.UI.Container.&lt;br /&gt;
 &lt;br /&gt;
 var input = new ox.UI.Input(&amp;quot;Detail field&amp;quot;);&lt;br /&gt;
 group.addWidget(input, &amp;quot;input&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All input widgets have a default value which is used when the data object&lt;br /&gt;
 // does not contain the widget&#039;s field (e. g. on first login).&lt;br /&gt;
 &lt;br /&gt;
 input.default_value = &amp;quot;default&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // ox.UI.Selection has many descendants which implement the same thing:&lt;br /&gt;
 // A field which must contain one of several possible values.&lt;br /&gt;
 // The possible values are set with the method setEntries().&lt;br /&gt;
 &lt;br /&gt;
 var choice = new ox.UI.ComboBox(&amp;quot;Choice&amp;quot;);&lt;br /&gt;
 group.addWidget(choice, &amp;quot;choice&amp;quot;);&lt;br /&gt;
 choice.setEntries([0, 1, Infinity], [&amp;quot;Zero&amp;quot;, &amp;quot;One&amp;quot;, &amp;quot;Infinity&amp;quot;]);&lt;br /&gt;
&lt;br /&gt;
== Customized new buttons in the panel ==&lt;br /&gt;
&lt;br /&gt;
This example adds a new area to the contacts panel called &amp;quot;SMS&amp;quot;. The area then&lt;br /&gt;
has two buttons, &amp;quot;Display&amp;quot; and &amp;quot;Send&amp;quot;. The &amp;quot;Display&amp;quot; button is active if one ore &lt;br /&gt;
multiple contacts are selected and fires a js alert for each of them when being &lt;br /&gt;
clicked. The &amp;quot;SMS&amp;quot; button is only active when one single contact is active&lt;br /&gt;
and has a business telephone number stored in it. On click a js alert is &lt;br /&gt;
executed and the telephone number is displayed.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Viktor&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 //create a new menu Object for the panel and define the unique id (id1 here)&lt;br /&gt;
 var contextmenu = MenuNodes.createSmallButtonContext(&amp;quot;id1&amp;quot;, &amp;quot;SMS&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 /**&lt;br /&gt;
  * Add menu Entries to the new generated panel object and define the icons&lt;br /&gt;
  * as well as the to be called functions. The identifiers must be unique &lt;br /&gt;
  * all over the complete js code (button1 and button2) in this example&lt;br /&gt;
  */&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button1&amp;quot;, &amp;quot;Display&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click1);&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button2&amp;quot;, &amp;quot;Send&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click2);&lt;br /&gt;
 /* The pannel object gets the id 20 and gets displayed in the fixed area&lt;br /&gt;
  * possible areas are FIXED and DYNAMIC the id controls the order in the areas&lt;br /&gt;
  */ &lt;br /&gt;
 addMenuNode(contextmenu.node, MenuNodes.FIXED, 20);&lt;br /&gt;
 &lt;br /&gt;
 //Following makes the new pannel options dynamic active/inactive&lt;br /&gt;
 changeDisplay(&amp;quot;contacts&amp;quot;, &amp;quot;id1&amp;quot;);&lt;br /&gt;
 menuarrows[&amp;quot;contacts&amp;quot;] = {};&lt;br /&gt;
 function changeplugin() {&lt;br /&gt;
     menuglobalzaehler = 0;&lt;br /&gt;
     menuarrows[&amp;quot;contacts&amp;quot;][&amp;quot;id1&amp;quot;] = new Array();&lt;br /&gt;
 //menucountselected here holds the amount of select items&lt;br /&gt;
     menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;, menucountselected &amp;gt;= 1,&lt;br /&gt;
 &amp;quot;button1&amp;quot;);&lt;br /&gt;
 // following an example how to get data out of the GUI internal cache. button2&lt;br /&gt;
 // is only active when a contact which as a business tel number is selected.&lt;br /&gt;
   if (activemodule == &amp;quot;contacts&amp;quot;) {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, function(data) {&lt;br /&gt;
             menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;,&lt;br /&gt;
                 menucountselected == 1 &amp;amp;&amp;amp;&lt;br /&gt;
 data.objects[0].telephone_business1,&lt;br /&gt;
                 &amp;quot;button2&amp;quot;);&lt;br /&gt;
         });&lt;br /&gt;
    }&lt;br /&gt;
 }&lt;br /&gt;
 register(&amp;quot;OX_SELECTED_ITEMS_CHANGED&amp;quot;, changeplugin); &lt;br /&gt;
 &lt;br /&gt;
 //now the called functions for the buttons follow&lt;br /&gt;
 function click1() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;id&amp;quot;, &amp;quot;folder_id&amp;quot;, &amp;quot;last_name&amp;quot;]&lt;br /&gt;
     }, null, display);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function click2() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, call);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function display(data) {&lt;br /&gt;
     for (var i = 0; i &amp;lt; menucountselected; i++)&lt;br /&gt;
         alert(data.objects[i].last_name);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function call(data) {&lt;br /&gt;
      alert(&amp;quot;Now, a SMS to &amp;quot; + data.objects[0].telephone_business1 + &lt;br /&gt;
             &amp;quot; could have been sent&amp;quot;);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
== Embedding external webapps which require authentication (works with OX 6.16 and higher) == &lt;br /&gt;
&lt;br /&gt;
In other examples on this page/wiki, you learned how to extend the settings tree with your own links to external web sites or similar. &lt;br /&gt;
But often it is required to login into such external web applications with some credentials. In many situations, the OX credentials and the credentials for the external web app are the same. So it would be an improvement for the OX user to be automatically logged in to this webapp when clicking some link within OX settings tree. &lt;br /&gt;
&lt;br /&gt;
To achieve this functionality, we introduced a new servlet in OX version 6.16 and higher with some kind of &amp;quot;Single Sign On&amp;quot; functionality, which is reachable at path &amp;quot;/ajax/sso&amp;quot; only via HTTPS (INFO: HTTP connections will NOT work). This servlet can be used to retrieve the following data from the user which uses the OX GUI:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 &amp;quot;login&amp;quot; -&amp;gt; The string which was entered at OX login screen.&lt;br /&gt;
 &amp;quot;imap_login&amp;quot; -&amp;gt; The string which was provisioned into the OX account as &amp;quot;imaplogin. This is used to authenticate against the primary IMAP/Mail Account.&lt;br /&gt;
 &amp;quot;username&amp;quot; -&amp;gt; OX internal username which was choosen by the administrator of the OX context/setup.&lt;br /&gt;
 &amp;quot;password&amp;quot; -&amp;gt; The password of the user.&lt;br /&gt;
 &amp;quot;context_id&amp;quot; -&amp;gt; OX internal number which references the context where the user resides in. Specified by the administrator at OX context creation.&lt;br /&gt;
 &amp;quot;context_name&amp;quot; -&amp;gt; OX internal string which references the context. Specified by the administrator at OX context creation.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Basically, you have to extend the settings/configuration tree in OX to contain a custom link/button where the user can click on. If this link is clicked, you have to call the SSO servlet with the session-id of the current user. Once you called the servlet, it will send some response with a json object which contains the needed data explained above. You can then use this data to &amp;quot;POST&amp;quot; to your external Webapplication Login URL, once your Webapplication has authenticated the POST request, it should redirect the request to its main application. In this case, the OX user is now successfully logged in to your external web application with just a click instead of entering his credentials again.&lt;br /&gt;
&lt;br /&gt;
Here is an example, how to call the SSO servlet:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
//this will fetch needed infos for redirecting&lt;br /&gt;
function callExtAPP(){&lt;br /&gt;
	ox.JSON.get(&amp;quot;/ajax/sso?action=get&amp;amp;session=&amp;quot;+session, function(reply) {&lt;br /&gt;
		username = reply.data.username;&lt;br /&gt;
		password = reply.data.password;&lt;br /&gt;
		login = reply.data.login;&lt;br /&gt;
	});&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
You can call this function for example on a &amp;quot;onClick&amp;quot; event, which was triggered by an OX user who clicks some link in the configuration/settings tree.&lt;br /&gt;
&lt;br /&gt;
== Customizing the Help, Logout, examples UWA link, Session Expired and Direct Link locations / URLs ==&lt;br /&gt;
&lt;br /&gt;
If you need to change or customize the Help, Logout, Session Expired or Direct Link locations / URLs you can use the following variables and parameters. You can set them anywhere within your plugin. If not set, the system defaults will be used. Don&#039;t use the expression &#039;var&#039; as this is publicly available.&lt;br /&gt;
&lt;br /&gt;
 // the base path for the help pages&lt;br /&gt;
 help_location = &amp;quot;[protocol]://[hostname][path]/help/[language{1}]/&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url after logout&lt;br /&gt;
 logout_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url if the session expires&lt;br /&gt;
 sessionExpired_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the direct link url, used in the infostore detail views and the new e-mail window&lt;br /&gt;
 // note: do not remove or modify the part &amp;quot;#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;, otherwise direct links won&#039;t work anymore&lt;br /&gt;
 directLink_location = &amp;quot;[protocol]://[hostname][path]#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // example for the UWA link from the UWA-Module settings page&lt;br /&gt;
 // The text between %s%s gets shown as href for the given link&lt;br /&gt;
 uwaLink.text = &amp;quot;Please have a look at the %sInteresting UWA modules%s page. It shows a list of widgets and their associated data.&amp;quot;&lt;br /&gt;
 uwaLink.link = &amp;quot;http://www.open-xchange.com/index.php?id=361&amp;amp;L=[language{0}]&amp;quot;&lt;br /&gt;
&lt;br /&gt;
As you can see you can use place holders, similar to other programming languages. These place holders will get parsed and replaced by the OX application. Here comes a short description of some of them:&lt;br /&gt;
&lt;br /&gt;
 [protocol]      = the current used protocol - e.g. http or https&lt;br /&gt;
 [hostname]      = the hostname - e.g www.myox.de&lt;br /&gt;
 [path]          = the path (if any) behind the hostname - e.g. /ox6/ - or empty if not used&lt;br /&gt;
 [file]          = the file parameter (if any) - e.g. ox.html&lt;br /&gt;
 [language{0|1}] = the users language - e.g. de_DE, where {0} is the language iso code and {1} the country iso code&lt;br /&gt;
 [context_id]    = the users context id&lt;br /&gt;
 [timezone]      = the users timezone - e.g. Europe/Berlin&lt;br /&gt;
&lt;br /&gt;
A full set of available parameters will follow soon.&lt;br /&gt;
Note: The parameters [module], [folder] and [object_id] are only available at the directLink and can&#039;t be used anywhere else.&lt;br /&gt;
&lt;br /&gt;
= Help Menu =&lt;br /&gt;
&lt;br /&gt;
It is possible to add entries to the pop-up menu of the help button in the top right corner. The following is a simple example which opens a language-specific help page:&lt;br /&gt;
&lt;br /&gt;
 var label = { de_DE: &amp;quot;Hilfe&amp;quot;, en_US: &amp;quot;Help&amp;quot;, fr_FR: &amp;quot;Aide&amp;quot; };&lt;br /&gt;
 HelpMenu.addText(label[config.language || &amp;quot;en_US&amp;quot;], displayLink);&lt;br /&gt;
 &lt;br /&gt;
 function displayLink() {&lt;br /&gt;
         open(&amp;quot;/help/&amp;quot; + config.language);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
The manual handling of the label is required until proper support for  the internationalization plug-in is implemented.&lt;br /&gt;
&lt;br /&gt;
=Events=&lt;br /&gt;
&lt;br /&gt;
It is possible to hook in some Events of the Frontend, here an autogenerated list of a small for...if:&lt;br /&gt;
&lt;br /&gt;
 LanguageChanged&lt;br /&gt;
 LanguageChangedInternal&lt;br /&gt;
 OX_Configuration_Changed&lt;br /&gt;
 OX_Configuration_Loaded&lt;br /&gt;
 OX_Refresh&lt;br /&gt;
 OX_Configuration_Loaded_Complete&lt;br /&gt;
 OX_Login&lt;br /&gt;
 Loaded&lt;br /&gt;
 Loading&lt;br /&gt;
 OX_Show_Help_Panel&lt;br /&gt;
 OX_Show_Help&lt;br /&gt;
 OX_Show_About&lt;br /&gt;
 LoginPageLoaded&lt;br /&gt;
 OX_Folder_Cleared&lt;br /&gt;
 OX_SELECTED_ITEMS_CHANGED&lt;br /&gt;
 OX_menu_Change_Height&lt;br /&gt;
 OX_Switched&lt;br /&gt;
 OX_Mail_Move&lt;br /&gt;
 OX_Calendar_Move&lt;br /&gt;
 OX_Contact_Move&lt;br /&gt;
 OX_InfoStore_Move&lt;br /&gt;
 OX_Task_Move&lt;br /&gt;
 OX_Object_Move&lt;br /&gt;
 OX_Mail_Copy&lt;br /&gt;
 OX_Contact_Copy&lt;br /&gt;
 OX_Object_Copy&lt;br /&gt;
 OX_Configuration_Switch_Folder_View&lt;br /&gt;
 OX_Direct_Linking&lt;br /&gt;
 OX_GLOBAL_CLICK&lt;br /&gt;
 OX_menu_After_Change_Height&lt;br /&gt;
 OX_menu_RESIZE&lt;br /&gt;
 OX_New_Error&lt;br /&gt;
 OX_New_Info&lt;br /&gt;
 OX_Configuration_Set_Empty&lt;br /&gt;
 OX_Switch_Module&lt;br /&gt;
 OX_Switch_View&lt;br /&gt;
 OX_Selected_Nested&lt;br /&gt;
 OX_Selected_Draft&lt;br /&gt;
 Selected&lt;br /&gt;
 Confirmation_Changed&lt;br /&gt;
 SubSelected&lt;br /&gt;
 SubSelectedTeamMember&lt;br /&gt;
 OX_Selected_Member&lt;br /&gt;
 OX_Lockable&lt;br /&gt;
 OX_Change_InfoStore_Detail_View&lt;br /&gt;
 OX_Change_Language&lt;br /&gt;
 OX_Execute_Function&lt;br /&gt;
 OX_Calendar_Change_Confirm&lt;br /&gt;
 OX_Calendar_Team_Add_Team&lt;br /&gt;
 OX_Task_Change_Confirm&lt;br /&gt;
 OX_Task_Standard_Search&lt;br /&gt;
 Preload&lt;br /&gt;
 OX_Configuration_Load_Foldertree&lt;br /&gt;
 OX_Portal_Click_Item&lt;br /&gt;
 OX_NEW_MAIL&lt;br /&gt;
 OX_Mail_Reply&lt;br /&gt;
 OX_Mail_ReplyAll&lt;br /&gt;
 OX_Mail_Forward&lt;br /&gt;
 OX_Mail_Edit_Draft&lt;br /&gt;
 OX_Mail_Change_Structure&lt;br /&gt;
 updateAllNewMailNumbers_Created&lt;br /&gt;
 OX_Mail_Delete&lt;br /&gt;
 OX_Mail_SaveMail&lt;br /&gt;
 OX_Attachment_Open&lt;br /&gt;
 OX_Attachment_Open_Nested&lt;br /&gt;
 OX_Attachment_Save&lt;br /&gt;
 OX_New_OXObject&lt;br /&gt;
 OX_Calendar_Edit&lt;br /&gt;
 OX_Calendar_Delete&lt;br /&gt;
 _IE_resize_complete&lt;br /&gt;
 OX_Calendar_Switch_Detail&lt;br /&gt;
 OX_Contact_Edit&lt;br /&gt;
 OX_Contact_Duplicate&lt;br /&gt;
 OX_Contact_Delete&lt;br /&gt;
 OX_Contact_SendVCard&lt;br /&gt;
 OX_Contact_Switch_Detail&lt;br /&gt;
 cb_abstact_email1&lt;br /&gt;
 sendMailToContact&lt;br /&gt;
 OX_Changed_DefaultIMAP_Unread&lt;br /&gt;
 OX_Tasks_Switch_Split_Detail&lt;br /&gt;
 OX_Task_Delete&lt;br /&gt;
 OX_Task_Edit&lt;br /&gt;
 OX_Task_Duplicate&lt;br /&gt;
 OX_Object_Add_Attachment&lt;br /&gt;
 OX_Create_Object&lt;br /&gt;
 OX_Configuration_GUI_Changed&lt;br /&gt;
 OX_Save_Configuration&lt;br /&gt;
 OX_Configuration_Settings_Changed_Language&lt;br /&gt;
 OX_Configuration_Settings_Changed_Timezone&lt;br /&gt;
 OX_Configuration_Settings_Changed_GUI&lt;br /&gt;
 OX_Configuration_Settings_Changed_Mail&lt;br /&gt;
 OX_Configuration_Settings_Changed_Modules&lt;br /&gt;
 OX_Configuration_Settings_Changed_Calendar_Notification&lt;br /&gt;
 OX_Configuration_Settings_Changed_Task_Notification&lt;br /&gt;
 OX_Configuration_Settings_Changed_Region_Date&lt;br /&gt;
 OX_Configuration_Settings_Changed_Tree&lt;br /&gt;
 OX_SELECTION_CHANGED_CONFIRM&lt;br /&gt;
 OX_Show_Mail_Panel&lt;br /&gt;
 OX_Show_MiniCalendar&lt;br /&gt;
 OX_SELECTED_SUBSELECTION_CHANGED&lt;br /&gt;
 OX_Task_Search&lt;br /&gt;
 OX_Search_InfoStore&lt;br /&gt;
 OX_Configuration_Change_Right&lt;br /&gt;
 OX_Configuration_Move_Folder&lt;br /&gt;
 OX_Config_Folder_Changed&lt;br /&gt;
 OX_Show_Rights&lt;br /&gt;
 OX_Before_Create_Calendar&lt;br /&gt;
 OX_Before_Create_Contact&lt;br /&gt;
 OX_Before_Create_Distributionlist&lt;br /&gt;
 OX_Before_Create_Task&lt;br /&gt;
 OX_Before_Create_InfoStore&lt;br /&gt;
 OX_Teammember_Changed&lt;br /&gt;
 OX_Switch_InfoStore_Detail&lt;br /&gt;
 OX_SELECTION_CHANGED&lt;br /&gt;
 OX_Refresh_Mini_Calendar&lt;br /&gt;
 OX_Select_MiniMonth&lt;br /&gt;
 OX_Select_MiniYear&lt;br /&gt;
 OX_Dummy&lt;br /&gt;
 OX_Quota_Update&lt;br /&gt;
 Logout&lt;br /&gt;
 OX_Add_Flag&lt;br /&gt;
 OX_Mail_Flag&lt;br /&gt;
 OX_Mail_Spam&lt;br /&gt;
 OX_Mail_Ham&lt;br /&gt;
 OX_Mail_Show_Source&lt;br /&gt;
 OX_New_Search&lt;br /&gt;
 OX_Delete_Search&lt;br /&gt;
 OX_Print&lt;br /&gt;
 OX_Attachment_SaveInfoStore&lt;br /&gt;
&lt;br /&gt;
Would be nice if some body could add some description to particular Events :-)&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=5000</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=5000"/>
		<updated>2009-10-21T13:27:58Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: added available types for free &amp;amp; busy&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
Some error message contain data sizes which must be expressed in Bytes or Kilobytes etc., depending on the actual value. Since the unit must be translated, this conversion is performed by the client. Unfortunately, standard printf()-style formatting does not have a specifier for this kind of translation. Therefore, the conversion specification for sizes is the same as for normal strings, and the client has to determine which parameters to translate based on the error code. The current error codes and the corresponding size parameters are listed in [[#DataSizeParameters | Data size parameters]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSizeParameters&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data size parameters&lt;br /&gt;
! Error code !! Parameter indices&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0006   || 1&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0020   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
| CON-0101   || 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| FLS-0003   || 1, 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0065   || 1, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0066   || 1&lt;br /&gt;
|-&lt;br /&gt;
| NON-0005   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
==== Detailed Exception Data (Preliminary) ====&lt;br /&gt;
Starting with some upcoming version application errors will be returned in the field &amp;quot;exception&amp;quot; in a response. The exception field will contain a JSON array containing objects that have the format specified in the following table:&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Exception Object&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|} &lt;br /&gt;
|-&lt;br /&gt;
| message      || String    || Localized error message. &lt;br /&gt;
|-&lt;br /&gt;
| parameters   || Array     || Replacement parameters for the message. &#039;&#039;What are they good for if the message is already localized? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| logMessage   || String    || Technical error message useful for debugging the problem. &lt;br /&gt;
|-&lt;br /&gt;
| exceptionId  || String    || Unique error identifier to help finding this error instance in the server logs. &lt;br /&gt;
|-&lt;br /&gt;
| help         || String    || Localized help text, telling the user how he may resolve the problem. &lt;br /&gt;
|-&lt;br /&gt;
| session      || String    || The session id of the session in which this exception was caused. &#039;&#039;When can this be &#039;&#039;&#039;not&#039;&#039;&#039; the current session? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| user         || Number    || The id of the user having caused the exception. &#039;&#039;When can this be &#039;&#039;&#039;not&#039;&#039;&#039; the current user? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| context      || Number    || The context id of the context in which the exception happened. &#039;&#039;When can this be &#039;&#039;&#039;not&#039;&#039;&#039; the current context? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| details      || Object    || A JSON Object containing extra information for debugging purposes. &lt;br /&gt;
|-&lt;br /&gt;
| application  || String    || Application ID of the subsystem having thrown this exception. &lt;br /&gt;
|-&lt;br /&gt;
| stacktrace   || Array     || An array of Strings containing the error trace. Note: This can be turned off in the backend, in which case an empty array will be returned. &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
=== Common object data ===&lt;br /&gt;
&lt;br /&gt;
This table contains common fields which apply for any module&#039;s data type and is referenced throughout this document whenever a module&#039;s data type is described.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100  || categories     || String  || String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101  || private_flag     || Boolean  || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 102  || color_label  || Number  || Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 1 and 10 (inclusive). Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 103  || number_of_links     || Number  || Number of links. &#039;&#039;&#039;deprecated&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| 104  || number_of_attachments     || Number  || Number of attachments &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – A string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;fastgui&amp;lt;/code&amp;gt; - A string containing GUI-specific settings. This is a JSON object that must be kept small for performance.&lt;br /&gt;
** &amp;lt;code&amp;gt;context_id&amp;lt;/code&amp;gt; - the unique identifier of the context (read-only, added 2008-01-28).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments (deprecated since 2008-12-11)&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks (deprecated since 2008-12-11)&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;maxUploadIdleTimeout&amp;lt;/code&amp;gt; - Timeout after that idle uploads are deleted.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with.  (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt; (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not. (deprecated 2008-04-29)&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;autoSearch&amp;lt;/code&amp;gt; - If a search for all users, groups and resources when participant selection dialog is opened. (read-only, added 2008-10-09/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;maximumNumberParticipants&amp;lt;/code&amp;gt; – Defines the maximum number of participants for appointments and tasks. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
*** &amp;lt;code&amp;gt;showDialog&amp;lt;/code&amp;gt; – Enables participant selection dialog for appointments and tasks. (read-only, added 2008-04-30/SP4)&lt;br /&gt;
** &amp;lt;code&amp;gt;availableModules&amp;lt;/code&amp;gt; – Contains a JSON array listing all enabled modules for a user. GUI loads Plugins through this list. To get your plugin listed here, create a subtree below &amp;lt;code&amp;gt;modules/&amp;lt;/code&amp;gt; without a &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; subelement or with a subelement containing &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; (read-only, added 2008-02-25)&lt;br /&gt;
** &amp;lt;code&amp;gt;minimumSearchCharacters&amp;lt;/code&amp;gt; – Minimum number of characters a search pattern must have to prevent large responses and slow queries. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;portal&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for portal module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;appendmailtext&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;allowhtmlimages&amp;lt;/code&amp;gt; – Alters default setting whether external images contained in HTML content are allowed or not (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;colorquoted&amp;lt;/code&amp;gt; – color quoted lines (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectFolder&amp;lt;/code&amp;gt; – contact folder id to save mail addresses from sent mails (added 2008-10-16)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectEnabled&amp;lt;/code&amp;gt; – switch contact collection on/off (added 2008-10-16)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectOnMailAccess&amp;lt;/code&amp;gt; – enables/disables contact collection for incoming mails. Default is true. (added 2009-09-24)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectOnMailTransport&amp;lt;/code&amp;gt; – enables/disables contact collection for outgoing mails. Default is true. (added 2009-09-24)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;deletemail&amp;lt;/code&amp;gt; – delete emails or move to trash (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultFolder&amp;lt;/code&amp;gt;&lt;br /&gt;
***** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;forwardmessage&amp;lt;/code&amp;gt; – forward messages as inline or attachment (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for mail module&lt;br /&gt;
**** &amp;lt;code&amp;gt;inlineattachments&amp;lt;/code&amp;gt; – activate inlining of HTML attachments (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;linewrap&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – if mail module is enabled or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;phishingheaders&amp;lt;/code&amp;gt; – header(s) identifying phishing headers (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;replyallcc&amp;lt;/code&amp;gt; – put all recipients on reply all into CC (added 2008-12-16/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; – Spam Button should be displayed in GUI or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails (added 2008-02-25)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the calendar module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyNewModifiedDeleted&amp;lt;/code&amp;gt; receive mail notification for new, modified or deleted appointments (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsCreator&amp;lt;/code&amp;gt; receive mail notification for accepted or declined appointments created by the user (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsParticipant&amp;lt;/code&amp;gt; receive mail notification for accepted or declined appointments that the user participates (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultStatusPrivate&amp;lt;/code&amp;gt; Default status for new appointments in private folders, where the user is participant. This does not affect appointments created by this user, which always have the status &amp;quot;accepted&amp;quot;. The status are described in [[#UserParticipantObject | User participant object]]. Default is 0:none (added 2009-07-20/6.12)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultStatusPublic&amp;lt;/code&amp;gt; Default status for new appointments in public folders, where the user is participant. This does not affect appointments created by this user, which always have the status &amp;quot;accepted&amp;quot;. The status are described in [[#UserParticipantObject | User participant object]]. Default is 0:none (added 2009-07-20/6.12)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the contacts module&lt;br /&gt;
**** &amp;lt;code&amp;gt;mailAddressAutoSearch&amp;lt;/code&amp;gt; – Define if a search is triggered when the recipient selection dialog is opened or the folder is changed. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; True if the contact module is enabled for the current user, false otherwise.&lt;br /&gt;
**** &amp;lt;code&amp;gt;singleFolderSearch&amp;lt;/code&amp;gt; True if the current user is allowed to search for contacts only in a single folder. False if contact searches across all folders are allowed. (read-only, added 2009-02-04/SP5 U1)&lt;br /&gt;
**** &amp;lt;code&amp;gt;characterSearch&amp;lt;/code&amp;gt; True if the side bar for searching for contacts by a start letter should be displayed. False if the side bar should be hidden. (read-only, added 2009-05-29/6.10)&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the tasks module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyNewModifiedDeleted&amp;lt;/code&amp;gt; receive mail notification for new, modified or deleted tasks (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsCreator&amp;lt;/code&amp;gt; receive mail notification for accepted or declined tasks created by the user (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsParticipant&amp;lt;/code&amp;gt; receive mail notification for accepted or declined taks that the user participates (added 2008-12-11/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the infostore module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;interfaces&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the folder tree&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.extras&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Extras link in the configuration (read only, added 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.passwordchange&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to change the Password within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.personaldata&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to edit personal contact information within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.group&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to edit groups and loads the corresponding Plug-In. (read only, added 2008-08-08)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.resource&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to edit resources and loads the corresponding Plug-In. (read only, added 2008-08-08)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.publish&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to publish items. (read only, added 2009-05-27)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.subscribe&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to subscribe sources. (read only, added 2009-05-27)&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common folder data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 6 || last_modified_utc || Timestamp || Timestamp of the last modification. Note that the type is Timestamp, not Time. See [[#Date and time]] for details. (added 2008-10-17, with SP5, temporary workaround)&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder; e.g. &amp;quot;tasks&amp;quot;, &amp;quot;calendar&amp;quot;, &amp;quot;contacts&amp;quot;, &amp;quot;infostore&amp;quot;, or &amp;quot;mail&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| 306 || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 313 || capabilities || Number || Bit mask containing information about mail folder capabilites, as described in [[#Capabilities | capabilities]].&lt;br /&gt;
|-&lt;br /&gt;
| 314 || subscribed || Boolean || Indicates whether this folder should appear in folder tree or not.&lt;br /&gt;
|-&lt;br /&gt;
| 315 || subscr_subflds || Boolean || Indicates whether subfolders should appear in folder tree or not.&lt;br /&gt;
|-&lt;br /&gt;
| 316 || standard_folder_type || Number || Indicates the default folder type. Zero for non-default folder. See [[#DefaultTypes | Standard folder types]]&lt;br /&gt;
|-&lt;br /&gt;
| 3010 || com.openexchange.publish.publicationFlag || Boolean || Indicates whether this folder is published. Read Only, provided by the com.openexchange.publish plugin, since 6.14.&lt;br /&gt;
|-&lt;br /&gt;
| 3020 || com.openexchange.subscribe.subscriptionFlag || Boolean || Indicates whether this folder has subscriptions storing their content in this folder. Read Only, provided by the com.openexchange.subscribe plugin, since 6.14.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-6 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Capabilities&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Capabilities&lt;br /&gt;
! Bit  !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 0 || Mailing system supports permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Mailing system supports ordering mails by their thread reference.&lt;br /&gt;
|-&lt;br /&gt;
| 2 || Mailing system supports quota restrictions.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Mailing system supports sorting.&lt;br /&gt;
|-&lt;br /&gt;
| 4 || Mailing system supports folder subscription.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DefaultTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Standard Folder Types&lt;br /&gt;
! Bit  !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 0 || No default folder.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Task.&lt;br /&gt;
|-&lt;br /&gt;
| 2 || Calendar.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Contact.&lt;br /&gt;
|-&lt;br /&gt;
| 7 || Inbox.&lt;br /&gt;
|-&lt;br /&gt;
| 8 || Infostore.&lt;br /&gt;
|-&lt;br /&gt;
| 9 || Drafts.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Sent.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || Spam.&lt;br /&gt;
|-&lt;br /&gt;
| 12 || Trash.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id is not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;folder_id&amp;lt;/code&amp;gt; – The parent folder of the newly created folder&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id should not be present.&lt;br /&gt;
&lt;br /&gt;
Provided that permission is granted to create a folder, its module is bound to the limitation, that the new folder&#039;s module must be equal to parent folder&#039;s module except that:&lt;br /&gt;
* Parent folder is one of the system folders &amp;lt;code&amp;gt;private&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;public&amp;lt;/code&amp;gt;, or &amp;lt;code&amp;gt;shared&amp;lt;/code&amp;gt;. Below these folders task, calendar, and contact modules are permitted.&lt;br /&gt;
* Parent folder&#039;s module is one of task, calendar, or contact. Below this kind of folders task, calendar, and contact modules are permitted.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content (preliminary) ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=clear&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Subscribing a folder to a (non-primary) folder tree (preliminary) ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=subscribe&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The identifier of the folder to subscribe&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON object specifying source tree, (non-primary) target tree and the parent in target tree:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;sourcetree&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;targettree&amp;quot;:&amp;quot;1&amp;quot;, &amp;quot;targetparent&amp;quot;:&amp;quot;112&amp;quot;}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: Undefined. No reasonable response is generated by this request.&lt;br /&gt;
&lt;br /&gt;
=== Unsubscribing a folder from a (non-primary) folder tree (preliminary) ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=unsubscribe&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The identifier of the folder to unsubscribe&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON object specifying the (non-primary) target tree:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;targettree&amp;quot;:&amp;quot;1&amp;quot;}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: Undefined. No reasonable response is generated by this request.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number or Time || Specifies when to notify the participants as the number of minutes before the start of the appointment. For tasks, the Time value specifies the absolute time when the user should be notified.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 210 || change_exceptions                     || Array       || An array of Dates, representing all change exceptions of a sequence.&lt;br /&gt;
|-&lt;br /&gt;
| 211 || delete_exceptions                     || Array       || An array of Dates, representing all delete exceptions of a sequence.&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Inclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#ParticipantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|-&lt;br /&gt;
| 222 || occurrences || Number || Specifies how often a recurrence should appear. May be present only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|-&lt;br /&gt;
| 5 || external user&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete || Date || Deprecated. Only present in AJAX interface. Value will not be stored on OX server.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority || Number || 1 = LOW, 2 = MEDIUM, 3 = HIGH&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the task&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder Identifier through that the task is accessed. This is necessary for checking the permissions.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object with attributes described in [[#SearchTasks | Search tasks]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchTasks&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search tasks&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find tasks. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || (optional) Defines the folder to search for tasks in. If this is omitted in all task folders will be searched.&lt;br /&gt;
|-&lt;br /&gt;
| start || Date or Time || (optional) Inclusive start date for a time range the tasks should end in. If start is omitted end is ignored.&lt;br /&gt;
|-&lt;br /&gt;
| end || Date or Time || (optional) Exclusive end date for a time range the tasks should end in. If this parameter is omitted the time range has an open end.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with matching tasks. Tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home || String&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status || String&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children || String&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type  || String&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number || String&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business || String&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees || String&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume || String&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other || String&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1 || String&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01 || String&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02 || String&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03 || String&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04 || String&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05 || String&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06 || String&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07 || String&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08 || String&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09 || String&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10 || String&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11 || String&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12 || String&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13 || String&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14 || String&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15 || String&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16 || String&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17 || String&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18 || String&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19 || String&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20 || String&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]]. &#039;&#039;&#039;deprecated&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distribution_list || Number&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links || Number || &#039;&#039;&#039;deprecated&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || number_of_images || Number&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified || Timestamp&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other || String&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as || String&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type || String&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist || Boolean&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address || Number&lt;br /&gt;
|-&lt;br /&gt;
| 606 ||                             || image1_url || String&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid || Number&lt;br /&gt;
|-&lt;br /&gt;
| 608 ||                             || useCount || Number || In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with objects. Each object contains fields “id” and “folder” of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=listuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with id&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
Available with SP4&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the contact&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Get contact by user ID ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – User ID (not Object ID) of the requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. &lt;br /&gt;
&lt;br /&gt;
Available with SP4 package.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder identifier through that the contact is accessed. This is necessary for checking the permissions.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
To remove some contact image send the image attribute set to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
To change or add some contact image the PUT command must be replaced with a POST command and all data must be provided within a &amp;lt;code&amp;gt;multipart/form-data&amp;lt;/code&amp;gt; body. The normal request body must be placed into a form field named &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; while the image file must be placed in a file field named &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt;. The response is then an HTML page as described in section [[#File_uploads | File uploads]].&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
To add some contact image the PUT command must be replaced with a POST command and all data must be provided within a &amp;lt;code&amp;gt;multipart/form-data&amp;lt;/code&amp;gt; body. The normal request body must be placed into a form field named &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; while the image file must be placed in a file field named &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt;. The response is then an HTML page as described in section [[#File uploads | File uploads]].&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. In case of use of column 609 (use count depending order for collected contacts with global address book) the parameter &amp;quot;order&amp;quot; ist NOT necessary and will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter. If this field is present, the pattern is matched against the contact field which is specified by the property contact_first_letter_field on the server (default: last name). Otherwise, the pattern is matched against the display name.&lt;br /&gt;
|-&lt;br /&gt;
| folder || Array of Number || If a list of folder identifiers or at least a single folder identifier is given, only in that folders will be searched for contacts. This paramenter is optional but searching in all contact folders that are viewable and where objects can be read in is more expensive on that database than searching in a dedicated number of them. The possibility to provide here an array of folder identifier has been added with 6.10.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Alternative request body: An Object as described in [[#SearchContactsAlternative | Search contacts alternative]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContactsAlternative&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts alternative&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| email1 || String || Searches contacts where the email1 address match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| email2 || String || Searches contacts where the email2 address match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| email3 || String || Searches contacts where the email3 address match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| categories || String || Searches contacts where the categories match with the given search pattern. &lt;br /&gt;
|-&lt;br /&gt;
| orSearch || Boolean || If set to true, the fields are connected through an OR search habit.&lt;br /&gt;
|-&lt;br /&gt;
| emailAutoComplete || Boolean || If set to true, results are guaranteed to contain at least one email adress and the search is performed by connecting the relevant fields through an OR search habit.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which start on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which end before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client. &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days. Each entry in the array corresponds with one day in the range that was queried, explaining whether there is an appointment on this day or not.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_position&amp;lt;/code&amp;gt; (optional) – Recurrence Position requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the appointment&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: If the appointment was created successfully, an object with the attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created appointment. If the appointment could not be created due to conflicts, the response body is an object with the field &amp;lt;code&amp;gt;conflicts&amp;lt;/code&amp;gt;, which is an array of appointment objects which caused the conflict. Each appointment object which represents a resource conflict contains an additional field &amp;lt;code&amp;gt;hard_conflict&amp;lt;/code&amp;gt; with the Boolean value true. If the user does not have read access to a conflicting appointment, only the fields &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;start_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;end_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;shown_as&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; are present and the field &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; contains only the participants which caused the conflict.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Confirm appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the appointment to confirm.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through which the appointment is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirmed appointment.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot;, &amp;quot;confirmmessage&amp;quot; and &amp;quot;id&amp;quot; (optional) as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource (1 for users, 3 for resources)&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| folder_id || String || Folder ID. Only set, if the user has the right to see the object. (added 2009-08-18/6.12) &lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find appointments. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search appointments with the given starting letter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get new appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/appointments?action=newappointments&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;limit&amp;lt;/code&amp;gt; – limits the number of returned object to the given value.&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number || Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 1 and 10 (inclusive).&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|-&lt;br /&gt;
| 256 || forwarded&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 615  || msg_ref                 || String  || Message reference on reply/forward.&lt;br /&gt;
|-&lt;br /&gt;
| 651  || flag_seen                 || String  || Special field to sort mails by seen status&lt;br /&gt;
|-&lt;br /&gt;
| 652  || account_name                 || String  || Message&#039;s account name.&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Array  || An array with user-defined flags as strings.&lt;br /&gt;
|-&lt;br /&gt;
|     || headers                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with one object for each requested mail. Each object contains the fields &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail as described in [[#UpdateMail | Update mail]] or [[#UpdateMailExtended | Update mail extended]] (available with SP6 v6.10).&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object containing the Object ID of the updated mail and its folder.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UpdateMail&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Update mail&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| color_label || Number || The color number between 1 and 10.&lt;br /&gt;
|-&lt;br /&gt;
| flags || Number || A set of flags to add or remove. Note: Flags for &amp;quot;recent&amp;quot; (8) and &amp;quot;user&amp;quot; (64) are ignored.&lt;br /&gt;
|-&lt;br /&gt;
| value || Boolean || &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; to add the flags specified by &amp;lt;code&amp;gt;flags&amp;lt;/code&amp;gt; (logical OR), &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt; to remove them (logical AND with the inverted value).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UpdateMailExtended&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Update mail extended (available with SP6 v6.10)&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| set_flags || Number || A set of flags to add. Note: Flags for &amp;quot;recent&amp;quot; (8) and &amp;quot;user&amp;quot; (64) are ignored.&lt;br /&gt;
|-&lt;br /&gt;
| clear_flags || Number || A set of flags to remove. Note: Flags for &amp;quot;recent&amp;quot; (8) and &amp;quot;user&amp;quot; (64) are ignored.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the mail&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) – 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
* &amp;lt;code&amp;gt;view&amp;lt;/code&amp;gt; (optional - available with SP4) - &amp;quot;raw&amp;quot; returns the content as it is, meaning no preparation are performed and thus no guarantee for safe contents is given (available with SP6 v6.10). &amp;quot;text&amp;quot; forces the server to deliver a text-only version of the requested mail&#039;s body, even if content is HTML. &amp;quot;html&amp;quot; to allow a possible HTML mail body being transferred as it is (but white-list filter applied). &amp;quot;noimg&amp;quot; to allow a possible HTML content being transferred but without original image src attributes which references external images: Can be used to prevent loading external linked images (spam privacy protection). &#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;unseen&amp;lt;/code&amp;gt; (optional) – &amp;quot;1&amp;quot; or &amp;quot;true&amp;quot; to leave an unseen mail as unseen although its content is requested&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The folder identifier.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment &#039;&#039;&#039;OR&#039;&#039;&#039;&lt;br /&gt;
* &amp;lt;code&amp;gt;cid&amp;lt;/code&amp;gt; – Value of header &#039;Content-ID&#039; of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
* &amp;lt;code&amp;gt;filter&amp;lt;/code&amp;gt; (optional) – 1 to apply HTML white-list filter rules if and only if requested attachment is of MIME type &amp;lt;code&amp;gt;text/htm*&amp;lt;/code&amp;gt; &#039;&#039;&#039;AND&#039;&#039;&#039; parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
=== Get multiple mail attachments as a ZIP file (preliminary) ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=zip_attachments&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The folder identifier.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachments.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – A comma-separated list of IDs of the requested attachments&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the ZIP file.&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send/Save mail as MIME data block (RFC822) (added in SP5) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; - A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; - Set to &amp;quot;1&amp;quot; to accept mail message as MIME data block.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) - In case the mail should not be sent out, but saved in a specific folder, the &amp;quot;folder&amp;quot; paramter can be used. If the mail should be sent out to the recipient, the &amp;quot;folder&amp;quot; parameter must not be included and the mail is stored in the folder &amp;quot;Sent Items&amp;quot;. Example &amp;quot;folder=default.INBOX/Testfolder&amp;quot;&lt;br /&gt;
* &amp;lt;code&amp;gt;flags&amp;lt;/code&amp;gt; (optional) - In case the mail should be stored with status &amp;quot;read&amp;quot; (e.g. mail has been read already in the client inbox), the parameter &amp;quot;flags&amp;quot; has to be included. If no &amp;quot;folder&amp;quot;  parameter is specified, this parameter must not be included. For infos about mail flags see [[#DetailedMailData | Detailed mail data]] spec.&lt;br /&gt;
 &lt;br /&gt;
Request Body: The MIME Data Block&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created/moved mail.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;view&amp;lt;/code&amp;gt; (optional - available with SP6) - &amp;quot;text&amp;quot; forces the server to deliver a text-only version of the requested mail&#039;s body, even if content is HTML. &amp;quot;html&amp;quot; to allow a possible HTML mail body being transferred as it is (but white-list filter applied).&#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Clear mail folder(s) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=clear&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with IDs of the mail folders to clear&lt;br /&gt;
&lt;br /&gt;
Response: An array with IDs of mail folder that could not be cleared; meaning the response body is an empty JSON array if everything went well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: A group object as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
=== List groups ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with group identifiers.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
=== Search for groups ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#GroupSearch | Group search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array of group objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group data&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| name         || String || Name with character restrictions&lt;br /&gt;
|-&lt;br /&gt;
| members       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Create a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created group.&lt;br /&gt;
&lt;br /&gt;
=== Delete a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the group to delete.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id” containing the unique identifier of the group.&lt;br /&gt;
&lt;br /&gt;
Response: An empty json array if the group was deleted successfully.&lt;br /&gt;
&lt;br /&gt;
=== Change a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the group to update.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Time stamp of the group to update. If the group was modified after the specified time stamp, then the update must fail. &lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. Only modified fields are present and the field id is omitted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== List resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Request body: An array with resources ids.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document. Not yet implemented, so this is currently always empty.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise. . Note: This is not writeable&lt;br /&gt;
|-&lt;br /&gt;
| 711 || number_of_versions || Number || The number of all versions of the infoitem. Note: This is not writeable.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the infoitem&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with [[]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with objects to delete. The fields for the object are described in [[#FullIdentifierForAnInfostoreDocument|Full identifier for an infostore document]]. &lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnInfostoreDocument&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an infostore document&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || Folder ID&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; (deprecated) ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| servertime || Time || The time on the server&lt;br /&gt;
|-&lt;br /&gt;
| user_id || Number || The ID of the user.&lt;br /&gt;
|-&lt;br /&gt;
| last_modified || Time || The last modification timestamp of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| recurrence_position || Number || The recurrence position for series appointments or 0 if no series&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || The ID of the folder through that the object can be read&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Reminder===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/reminder?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
Response body: An JSON array with the id that was not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: A &amp;quot;multipart/form-data&amp;quot; encoded .CSV file. The field name for the file is &amp;quot;file&amp;quot;. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered, and warnings (under the key &amp;quot;warnings&amp;quot;) containing an Array of objects with the warning data, containing all customary error fields.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Calendar folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mailfilter&amp;quot; ==&lt;br /&gt;
The module mailfilter descriptes how to add, update or delete mail filter rules or to check which actions are supported by the underlying system.&lt;br /&gt;
&lt;br /&gt;
A detailed description can be found here [[ HTTP_API_MailFilter | Mail Filter HTTP API]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;ajax file upload&amp;quot; ==&lt;br /&gt;
This module offers to store files in server&#039;s dedicated download directory for a configureable amount of time. The files are then accessible for further operations like inline images in (html) mails&lt;br /&gt;
&lt;br /&gt;
=== Uploading a file ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/file?action=new&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The module for which the file is uploaded to determine proper upload quota constraints (e.g. &amp;quot;mail&amp;quot;, &amp;quot;infostore&amp;quot;, etc.).&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; – The file type filter to define which file types are allowed during upload. Currently supported filters are: &amp;lt;code&amp;gt;file=all, text=text/*, media=image OR audio OR video, image=image/*, audio=audio/*, video=video/*, application=application/*&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A common POST request body of MIME type &amp;quot;multipart/*&amp;quot; which holds the file(s) to upload&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of the uploaded files. The files are accessible through the returned IDs for future use.&lt;br /&gt;
&lt;br /&gt;
=== Updating a file&#039;s last access timestamp (keep alive) ===&lt;br /&gt;
By updating the last access timestamp it&#039;s prevented from being deleted from both session and disk storage.&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=keepalive&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file whose timestamp should be updated&lt;br /&gt;
&lt;br /&gt;
Response: The string &amp;quot;null&amp;quot; in response&#039;s data element&lt;br /&gt;
&lt;br /&gt;
=== Requesting a formerly uploaded file ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested file is directly written into output stream&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;image&amp;quot; ==&lt;br /&gt;
This module allows to download images from Open-Xchange server without providing a session ID in request&#039;s URL parameters.&lt;br /&gt;
&lt;br /&gt;
=== Requesting an image ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/image&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;uid&amp;lt;/code&amp;gt; – The unique ID referring to the desired image&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested image is directly written into output stream&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;conversion&amp;quot; (preliminary) ==&lt;br /&gt;
&lt;br /&gt;
A generic module to request data from a data source and to process obtained/submitted data with a data handler. Thus data is converted from a data source by a data handler.&lt;br /&gt;
&lt;br /&gt;
=== Converting data ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/conversion?action=convert&amp;lt;/code&amp;gt;&amp;lt;br&amp;gt;&lt;br /&gt;
or&amp;lt;br&amp;gt;&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/conversion?action=convert&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters: &amp;amp;lt;no parameters required&amp;amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A [[#ConversionRequest | conversion request]] JSON object containing nested JSON objects for [[#DataSource | data source]] and [[#DataHandler | data handler]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ConversionRequest&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Conversion request object&lt;br /&gt;
! Field      !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| datasource || JSON object || The data source object.&lt;br /&gt;
|-&lt;br /&gt;
| datahandler || JSON object || The data handler object.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSource&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data source object&lt;br /&gt;
! Field      !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| identifier || String || The identifier of the data source.&lt;br /&gt;
|-&lt;br /&gt;
| args || JSON array || The &#039;&#039;&#039;optional&#039;&#039;&#039; name-value-pairs as JSON objects for data source&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataHandler&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data handler object&lt;br /&gt;
! Field      !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| identifier || String || The identifier of the data handler.&lt;br /&gt;
|-&lt;br /&gt;
| args || JSON array || The &#039;&#039;&#039;optional&#039;&#039;&#039; name-value-pairs as JSON objects for data handler&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: The result of converted data ready as an appropriate JSON response&lt;br /&gt;
&lt;br /&gt;
==== Saving an ICal email attachment ====&lt;br /&gt;
&lt;br /&gt;
If an ICal file is attached to an email, its content can be saved as appointments and tasks into given calendar and task folder.&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.ical&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.fullname&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-fullname&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.mailid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;mail-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.sequenceid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;attachment-sequence-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.ical&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.groupware.calendar.folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;calendar-folder-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&lt;br /&gt;
{&amp;amp;quot;com.openexchange.groupware.task.folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;task-folder-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array of JSON objects each providing folder and object ID of added appointment/task; e.g. &amp;lt;code&amp;gt;[{&amp;amp;quot;folder_id&amp;amp;quot;:2567, &amp;amp;quot;id&amp;amp;quot;:7689}, ...]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
==== Converting an ICal email attachment into JSON objects ====&lt;br /&gt;
&lt;br /&gt;
If an ICal file is attached to an email, its content can converted to JSON appointments and tasks.&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.ical&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.fullname&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-fullname&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.mailid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;mail-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.sequenceid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;attachment-sequence-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object.&amp;lt;br&amp;gt;&lt;br /&gt;
&#039;&#039;&#039;Note&#039;&#039;&#039; that both arguments are optional: Default is user time zone and zero recurrence position&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.ical.json&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.groupware.calendar.timezone&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;timezone-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&lt;br /&gt;
{&amp;amp;quot;com.openexchange.groupware.calendar.recurrencePosition&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;recurrence-position&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array of JSON objects for each appointment/task as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]/[[##DetailedAppointmentData | Detailed appointment data]]&lt;br /&gt;
&lt;br /&gt;
==== Saving a VCard email attachment ====&lt;br /&gt;
&lt;br /&gt;
If a VCard file is attached to an email, its content can be saved as contacts into given contact folder.&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.vcard&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.fullname&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-fullname&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.mailid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;mail-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.sequenceid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;attachment-sequence-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.contact&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.groupware.contact.folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;contact-folder-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array of JSON objects each providing folder and object ID of added contact; e.g. &amp;lt;code&amp;gt;[{&amp;amp;quot;folder_id&amp;amp;quot;:2567, &amp;amp;quot;id&amp;amp;quot;:7689}, ...]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==== Contact(s) attached to a new email as a VCard file ====&lt;br /&gt;
&lt;br /&gt;
Obtain VCard data from specified contact object(s).&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.contact&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-id1&amp;amp;gt;&amp;amp;quot;,&amp;amp;quot;id&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;id1&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;...&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-idn&amp;amp;gt;&amp;amp;quot;,&amp;amp;quot;id&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;idn&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Get a new email&#039;s JSON object with specified VCard data source attached.&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.vcard&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:[]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A [[#DetailedMailData | mail]] JSON object.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;search&amp;quot; (preliminary) ==&lt;br /&gt;
&lt;br /&gt;
The search module is an enhancement to each search request as an optional JSON object via PUT method to filter elements; e.g.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
PUT /ajax/contacts?action=all&amp;amp;...&lt;br /&gt;
&lt;br /&gt;
{&amp;quot;filter&amp;quot;:{search-term-object}}&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This section describes the syntax of the optional JSON object representing the search term.&amp;lt;br&amp;gt;&lt;br /&gt;
In general the structure of a search term is in prefix notation; meaning the operator is written before its operands:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;operation&amp;quot;:&amp;quot;equals&amp;quot;,&amp;quot;operands&amp;quot;:[...]}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Moreover there are two different types of a search terms:&lt;br /&gt;
* A single search term&lt;br /&gt;
* A composite search term&lt;br /&gt;
&lt;br /&gt;
A single search term reflects an operation which cannot hold nested search terms as operands; e.g. &amp;quot;equals&amp;quot;. In opposite to this a composite search term holds one or more nested search terms as operands; e.g. &amp;quot;not&amp;quot; or the logical junctors &amp;quot;and&amp;quot;/&amp;quot;or&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
By now the following operations are supported:&lt;br /&gt;
* composite operations&lt;br /&gt;
** &amp;quot;and&amp;quot; - The AND junctor&lt;br /&gt;
** &amp;quot;or&amp;quot; - The OR junctor&lt;br /&gt;
** &amp;quot;not&amp;quot; - Negation&lt;br /&gt;
* single operations&lt;br /&gt;
** &amp;quot;equals&amp;quot; - Equals comparison&lt;br /&gt;
** &amp;quot;lt&amp;quot; - Less-than comparison&lt;br /&gt;
** &amp;quot;gt&amp;quot; - Greater-than comparison&lt;br /&gt;
&lt;br /&gt;
Furthermore following operand types are supported for single search terms:&lt;br /&gt;
* Column - Providing a name referring to a field/column&lt;br /&gt;
* Constant - A constant&lt;br /&gt;
&lt;br /&gt;
Example of an EQUALS search term:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;quot;operation&amp;quot;:&amp;quot;equals&amp;quot;,&amp;quot;operands&amp;quot;:[{&amp;quot;type&amp;quot;:&amp;quot;column&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;first_name&amp;quot;},&amp;quot;Jane&amp;quot;]}&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Example of an OR search term:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;quot;operation&amp;quot;:&amp;quot;or&amp;quot;,&amp;quot;operands&amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;{&amp;quot;operation&amp;quot;:&amp;quot;equals&amp;quot;,&amp;quot;operands&amp;quot;:[{&amp;quot;type&amp;quot;:&amp;quot;column&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;first_name&amp;quot;},&amp;quot;Jane&amp;quot;]},&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;{&amp;quot;operation&amp;quot;:&amp;quot;gt&amp;quot;,&amp;quot;operands&amp;quot;:[{&amp;quot;type&amp;quot;:&amp;quot;column&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;birthday&amp;quot;},&amp;quot;1975-05-01&amp;quot;]}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Refer to object data tables introduced by different modules to know which field names are supported; e.g. for tasks it is [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]], and [[#DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail account&amp;quot; (preliminary: available with v6.12) ==&lt;br /&gt;
&lt;br /&gt;
The mail account module is used to manage multiple mail accounts held by a user.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail account ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/account?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the account to return.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object representing the desired mail account. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MailAccountData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Mail account data&lt;br /&gt;
! ID    !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  1001   || id            || Number  || Account ID&lt;br /&gt;
|-&lt;br /&gt;
|  1002   ||  login    || String  || The login.&lt;br /&gt;
|-&lt;br /&gt;
|  1003   ||  password   || String  || The (optional) password.&lt;br /&gt;
|-&lt;br /&gt;
|  1004   ||  mail_url || String    || The mail server URL; e.g. &amp;quot;imap://imap.somewhere.com:143&amp;quot;. &#039;&#039;&#039;URL is preferred over single fields&#039;&#039;&#039; (like mail_server, mail_port, etc.)&lt;br /&gt;
|-&lt;br /&gt;
|  1005   ||  transport_url || String    || The transport server URL; e.g. &amp;quot;smtp://smtp.somewhere.com:25&amp;quot;. &#039;&#039;&#039;URL is preferred over single fields&#039;&#039;&#039; (like transport_server, transport_port, etc.)&lt;br /&gt;
|-&lt;br /&gt;
|   1006  ||  name || String    || Account&#039;s display name.&lt;br /&gt;
|-&lt;br /&gt;
|  1007   ||  primary_address || String    || User&#039;s primary address in account; e.g. &amp;quot;someone@somewhere.com&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|  1008   ||  spam_handler || String    || The name of the spam handler used by account.&lt;br /&gt;
|-&lt;br /&gt;
|   1009  ||  trash || String    || The name of the default trash folder.&lt;br /&gt;
|-&lt;br /&gt;
|  1010   ||  sent || String    || The name of the default sent folder.&lt;br /&gt;
|-&lt;br /&gt;
|   1011  ||  drafts || String    || The name of the default drafts folder.&lt;br /&gt;
|-&lt;br /&gt;
|  1012   ||  spam || String    || The name of the default spam folder.&lt;br /&gt;
|-&lt;br /&gt;
|  1013   ||  confirmed_spam || String    || The name of the default confirmed-spam folder.&lt;br /&gt;
|-&lt;br /&gt;
|   1014  || confirmed_ham || String    || The name of the default confirmed-ham folder.&lt;br /&gt;
|-&lt;br /&gt;
|   1015  ||  mail_server || String    || The mail server&#039;s hostname or IP address.&lt;br /&gt;
|-&lt;br /&gt;
|   1016  ||  mail_port || Number    || The mail server&#039;s port.&lt;br /&gt;
|-&lt;br /&gt;
|   1017  ||  mail_protocol || String    || The mail server&#039;s protocol. &#039;&#039;&#039;Always use basic protocol name.&#039;&#039;&#039; E.g. use &amp;quot;imap&amp;quot; instead of &amp;quot;imaps&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1018  ||  mail_secure || Boolean    || Whether to establish a secure connection to mail server (SSL, TLS).&lt;br /&gt;
|-&lt;br /&gt;
|   1019  ||  transport_server || String    || The transport server&#039;s hostname or IP address.&lt;br /&gt;
|-&lt;br /&gt;
|   1020  ||  transport_port || Number    || The transport server&#039;s port.&lt;br /&gt;
|-&lt;br /&gt;
|   1021  ||  transport_protocol || String    || The transport server&#039;s protocol. &#039;&#039;&#039;Always use basic protocol name.&#039;&#039;&#039; E.g. use &amp;quot;smtp&amp;quot; instead of &amp;quot;smtps&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1022  ||  transport_secure || Boolean    || Whether to establish a secure connection to transport server (SSL, TLS).&lt;br /&gt;
|-&lt;br /&gt;
|   1023  ||  transport_login || String    || The transport login. If empty &amp;quot;login&amp;quot; is taken as transport login as well.&lt;br /&gt;
|-&lt;br /&gt;
|   1024  ||  transport_password || String    || The transport password. If empty &amp;quot;password&amp;quot; is taken as transport password as well.&lt;br /&gt;
|-&lt;br /&gt;
|   1025  ||  unified_inbox_enabled || Boolean    || If enabled for Unified INBOX&lt;br /&gt;
|-&lt;br /&gt;
|   1026  ||  trash_fullname || String    || Path to default trash folder. Preferred over &amp;quot;trash&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1027  ||  sent_fullname || String    || Path to default sent folder. Preferred over &amp;quot;sent&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1028  ||  drafts_fullname || String    || Path to default drafts folder. Preferred over &amp;quot;drafts&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1029  ||  spam_fullname || String    || Path to default spam folder. Preferred over &amp;quot;spam&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1030  ||  confirmed_spam_fullname || String    || Path to default confirmed-spam folder. Preferred over &amp;quot;confirmed_spam&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1031  ||  confirmed_ham_fullname || String    || Path to default confirmed-ham folder. Preferred over &amp;quot;confirmed_ham&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1032  ||  pop3_refresh_rate || Number    || The interval in minutes the POP3 account is refreshed&lt;br /&gt;
|-&lt;br /&gt;
|   1033  ||  pop3_expunge_on_quit || Boolean    || Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not&lt;br /&gt;
|-&lt;br /&gt;
|   1034  ||  pop3_delete_write_through || Boolean    || If option &amp;quot;pop3_expunge_on_quit&amp;quot; is disabled, this property defines whether a delete in local INBOX also deletes affected message in actual POP3 account&lt;br /&gt;
|-&lt;br /&gt;
|   1035  ||  pop3_storage || String    || The name of POP3 storage provider, default is &amp;quot;mailaccount&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1036  ||  pop3_path || String    || Path to POP3&#039;s virtual root folder in storage, default is name of the POP3 account beside default folders&lt;br /&gt;
|-&lt;br /&gt;
|   1037  ||  personal || String    || The customizable personal part of email address&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Create a new mail account ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request: A JSON object describing the new account to create. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object representing the inserted mail account. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
=== Update a mail account ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request: A JSON object identifiying (field ID is present) and describing the account to update. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object representing the updated mail account. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
=== Delete a mail account ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ID of the mail account to delete.&lt;br /&gt;
&lt;br /&gt;
=== Validate a mail account (which shall be created) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=validate&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; - An optional boolean parameter which indicates whether on successful validation the folder tree shall be returned (NULL on failure) or if set to &amp;quot;false&amp;quot; or missing only a boolean is returned which indicates validation result&lt;br /&gt;
&lt;br /&gt;
Request: A JSON object describing the new account to validate. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: Dependent on optional &amp;quot;tree&amp;quot; parameter a JSON folder object or a boolean value indicating the validation result&lt;br /&gt;
&lt;br /&gt;
The JSON folder object corresponding to [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
Additionally a field &amp;quot;subfolder_array&amp;quot; is added which contains possible subfolders. This field is missing if a folder contains no subfolders.&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;user&amp;quot; (preliminary: available with v6.14) ==&lt;br /&gt;
&lt;br /&gt;
The user module is used to access user information.&lt;br /&gt;
&lt;br /&gt;
=== Get all users ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/user?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for users are defined in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with user data. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedUserData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed user data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type       !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 610 || Aliases                     || aliases              || Array      || The user&#039;s aliases&lt;br /&gt;
|-&lt;br /&gt;
| 611 || Time zone                   || timezone             || String     || The time zone ID.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || Locale                      || locale               || String     || The name of user&#039;s entire locale, with the language, country and variant separated by underbars. E.g. &amp;quot;en&amp;quot;, &amp;quot;de_DE&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 613 || Groups                      || groups               || Array      || The IDs of user&#039;s groups&lt;br /&gt;
|-&lt;br /&gt;
| 614 || Contact ID                  || contact_id           || Number     || The contact ID of the user&lt;br /&gt;
|-&lt;br /&gt;
| 615 || Login info                  || login_info           || String     || The user&#039;s login information&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for users are defined in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of numbers. Each number is the ID of requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with user data. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a user ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/user?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested user. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]].&lt;br /&gt;
&lt;br /&gt;
=== Update a user ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated user.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated user. If the user was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: User object as described in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Note&#039;&#039;&#039;: &amp;quot;timezone&amp;quot; and &amp;quot;locale&amp;quot; are the only fields from [[#DetailedUserData | Detailed user data]] which are allowed to be updated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An empty object.&lt;br /&gt;
&lt;br /&gt;
=== Search users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. In case of use of column 609 (use count depending order for collected users with global address book) the parameter &amp;quot;order&amp;quot; ist NOT necessary and will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchUsers | Search users]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchUsers&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search users&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find users. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search users with the given startletter. If this field is present, the pattern is matched against the user field which is specified by the property contact_first_letter_field on the server (default: last name). Otherwise, the pattern is matched against the display name.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Alternative request body: An Object as described in [[#SearchUsersAlternative | Search users alternative]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchUsersAlternative&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search users alternative&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches users where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches users where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches users where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| orSearch || Boolean || If set to true, the fields are connected through an OR search habit.&lt;br /&gt;
|-&lt;br /&gt;
| emailAutoComplete || Boolean || If set to true, results are guaranteed to contain at least one email adress and the search is performed by connecting the relevant fields through an OR search habit.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with user data. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=4903</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=4903"/>
		<updated>2009-10-07T10:02:44Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: added available contact fields you can search in&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
Some error message contain data sizes which must be expressed in Bytes or Kilobytes etc., depending on the actual value. Since the unit must be translated, this conversion is performed by the client. Unfortunately, standard printf()-style formatting does not have a specifier for this kind of translation. Therefore, the conversion specification for sizes is the same as for normal strings, and the client has to determine which parameters to translate based on the error code. The current error codes and the corresponding size parameters are listed in [[#DataSizeParameters | Data size parameters]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSizeParameters&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data size parameters&lt;br /&gt;
! Error code !! Parameter indices&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0006   || 1&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0020   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
| CON-0101   || 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| FLS-0003   || 1, 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0065   || 1, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0066   || 1&lt;br /&gt;
|-&lt;br /&gt;
| NON-0005   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
==== Detailed Exception Data (Preliminary) ====&lt;br /&gt;
Starting with some upcoming version application errors will be returned in the field &amp;quot;exception&amp;quot; in a response. The exception field will contain a JSON array containing objects that have the format specified in the following table:&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Exception Object&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|} &lt;br /&gt;
|-&lt;br /&gt;
| message      || String    || Localized error message. &lt;br /&gt;
|-&lt;br /&gt;
| parameters   || Array     || Replacement parameters for the message. &#039;&#039;What are they good for if the message is already localized? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| logMessage   || String    || Technical error message useful for debugging the problem. &lt;br /&gt;
|-&lt;br /&gt;
| exceptionId  || String    || Unique error identifier to help finding this error instance in the server logs. &lt;br /&gt;
|-&lt;br /&gt;
| help         || String    || Localized help text, telling the user how he may resolve the problem. &lt;br /&gt;
|-&lt;br /&gt;
| session      || String    || The session id of the session in which this exception was caused. &#039;&#039;When can this be &#039;&#039;&#039;not&#039;&#039;&#039; the current session? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| user         || Number    || The id of the user having caused the exception. &#039;&#039;When can this be &#039;&#039;&#039;not&#039;&#039;&#039; the current user? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| context      || Number    || The context id of the context in which the exception happened. &#039;&#039;When can this be &#039;&#039;&#039;not&#039;&#039;&#039; the current context? -- Viktor Pracht - 2009-04-24&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| details      || Object    || A JSON Object containing extra information for debugging purposes. &lt;br /&gt;
|-&lt;br /&gt;
| application  || String    || Application ID of the subsystem having thrown this exception. &lt;br /&gt;
|-&lt;br /&gt;
| stacktrace   || Array     || An array of Strings containing the error trace. Note: This can be turned off in the backend, in which case an empty array will be returned. &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
=== Common object data ===&lt;br /&gt;
&lt;br /&gt;
This table contains common fields which apply for any module&#039;s data type and is referenced throughout this document whenever a module&#039;s data type is described.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100  || categories     || String  || String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101  || private_flag     || Boolean  || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 102  || color_label  || Number  || Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 1 and 10 (inclusive). Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 103  || number_of_links     || Number  || Number of links. &#039;&#039;&#039;deprecated&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| 104  || number_of_attachments     || Number  || Number of attachments &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – A string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;fastgui&amp;lt;/code&amp;gt; - A string containing GUI-specific settings. This is a JSON object that must be kept small for performance.&lt;br /&gt;
** &amp;lt;code&amp;gt;context_id&amp;lt;/code&amp;gt; - the unique identifier of the context (read-only, added 2008-01-28).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments (deprecated since 2008-12-11)&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks (deprecated since 2008-12-11)&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;maxUploadIdleTimeout&amp;lt;/code&amp;gt; - Timeout after that idle uploads are deleted.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with.  (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt; (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not. (deprecated 2008-04-29)&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;autoSearch&amp;lt;/code&amp;gt; - If a search for all users, groups and resources when participant selection dialog is opened. (read-only, added 2008-10-09/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;maximumNumberParticipants&amp;lt;/code&amp;gt; – Defines the maximum number of participants for appointments and tasks. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
*** &amp;lt;code&amp;gt;showDialog&amp;lt;/code&amp;gt; – Enables participant selection dialog for appointments and tasks. (read-only, added 2008-04-30/SP4)&lt;br /&gt;
** &amp;lt;code&amp;gt;availableModules&amp;lt;/code&amp;gt; – Contains a JSON array listing all enabled modules for a user. GUI loads Plugins through this list. To get your plugin listed here, create a subtree below &amp;lt;code&amp;gt;modules/&amp;lt;/code&amp;gt; without a &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; subelement or with a subelement containing &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; (read-only, added 2008-02-25)&lt;br /&gt;
** &amp;lt;code&amp;gt;minimumSearchCharacters&amp;lt;/code&amp;gt; – Minimum number of characters a search pattern must have to prevent large responses and slow queries. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;portal&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for portal module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;appendmailtext&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;allowhtmlimages&amp;lt;/code&amp;gt; – Alters default setting whether external images contained in HTML content are allowed or not (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;colorquoted&amp;lt;/code&amp;gt; – color quoted lines (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectFolder&amp;lt;/code&amp;gt; – contact folder id to save mail addresses from sent mails (added 2008-10-16)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectEnabled&amp;lt;/code&amp;gt; – switch contact collection on/off (added 2008-10-16)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectOnMailAccess&amp;lt;/code&amp;gt; – enables/disables contact collection for incoming mails. Default is true. (added 2009-09-24)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectOnMailTransport&amp;lt;/code&amp;gt; – enables/disables contact collection for outgoing mails. Default is true. (added 2009-09-24)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;deletemail&amp;lt;/code&amp;gt; – delete emails or move to trash (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultFolder&amp;lt;/code&amp;gt;&lt;br /&gt;
***** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;forwardmessage&amp;lt;/code&amp;gt; – forward messages as inline or attachment (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for mail module&lt;br /&gt;
**** &amp;lt;code&amp;gt;inlineattachments&amp;lt;/code&amp;gt; – activate inlining of HTML attachments (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;linewrap&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – if mail module is enabled or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;phishingheaders&amp;lt;/code&amp;gt; – header(s) identifying phishing headers (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;replyallcc&amp;lt;/code&amp;gt; – put all recipients on reply all into CC (added 2008-12-16/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; – Spam Button should be displayed in GUI or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails (added 2008-02-25)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the calendar module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyNewModifiedDeleted&amp;lt;/code&amp;gt; receive mail notification for new, modified or deleted appointments (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsCreator&amp;lt;/code&amp;gt; receive mail notification for accepted or declined appointments created by the user (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsParticipant&amp;lt;/code&amp;gt; receive mail notification for accepted or declined appointments that the user participates (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultStatusPrivate&amp;lt;/code&amp;gt; Default status for new appointments in private folders, where the user is participant. This does not affect appointments created by this user, which always have the status &amp;quot;accepted&amp;quot;. The status are described in [[#UserParticipantObject | User participant object]]. Default is 0:none (added 2009-07-20/6.12)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultStatusPublic&amp;lt;/code&amp;gt; Default status for new appointments in public folders, where the user is participant. This does not affect appointments created by this user, which always have the status &amp;quot;accepted&amp;quot;. The status are described in [[#UserParticipantObject | User participant object]]. Default is 0:none (added 2009-07-20/6.12)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the contacts module&lt;br /&gt;
**** &amp;lt;code&amp;gt;mailAddressAutoSearch&amp;lt;/code&amp;gt; – Define if a search is triggered when the recipient selection dialog is opened or the folder is changed. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; True if the contact module is enabled for the current user, false otherwise.&lt;br /&gt;
**** &amp;lt;code&amp;gt;singleFolderSearch&amp;lt;/code&amp;gt; True if the current user is allowed to search for contacts only in a single folder. False if contact searches across all folders are allowed. (read-only, added 2009-02-04/SP5 U1)&lt;br /&gt;
**** &amp;lt;code&amp;gt;characterSearch&amp;lt;/code&amp;gt; True if the side bar for searching for contacts by a start letter should be displayed. False if the side bar should be hidden. (read-only, added 2009-05-29/6.10)&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the tasks module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyNewModifiedDeleted&amp;lt;/code&amp;gt; receive mail notification for new, modified or deleted tasks (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsCreator&amp;lt;/code&amp;gt; receive mail notification for accepted or declined tasks created by the user (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsParticipant&amp;lt;/code&amp;gt; receive mail notification for accepted or declined taks that the user participates (added 2008-12-11/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the infostore module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;interfaces&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the folder tree&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.extras&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Extras link in the configuration (read only, added 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.passwordchange&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to change the Password within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.personaldata&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to edit personal contact information within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.group&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to edit groups and loads the corresponding Plug-In. (read only, added 2008-08-08)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.resource&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to edit resources and loads the corresponding Plug-In. (read only, added 2008-08-08)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.publish&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to publish items. (read only, added 2009-05-27)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.subscribe&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to subscribe sources. (read only, added 2009-05-27)&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common folder data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 6 || last_modified_utc || Timestamp || Timestamp of the last modification. Note that the type is Timestamp, not Time. See [[#Date and time]] for details. (added 2008-10-17, with SP5, temporary workaround)&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder; e.g. &amp;quot;tasks&amp;quot;, &amp;quot;calendar&amp;quot;, &amp;quot;contacts&amp;quot;, &amp;quot;infostore&amp;quot;, or &amp;quot;mail&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| 306 || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 313 || capabilities || Number || Bit mask containing information about mail folder capabilites, as described in [[#Capabilities | capabilities]].&lt;br /&gt;
|-&lt;br /&gt;
| 314 || subscribed || Boolean || Indicates whether this folder should appear in folder tree or not.&lt;br /&gt;
|-&lt;br /&gt;
| 315 || subscr_subflds || Boolean || Indicates whether subfolders should appear in folder tree or not.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-6 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Capabilities&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Capabilities&lt;br /&gt;
! Bit  !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 0 || Mailing system supports permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Mailing system supports ordering mails by their thread reference.&lt;br /&gt;
|-&lt;br /&gt;
| 2 || Mailing system supports quota restrictions.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Mailing system supports sorting.&lt;br /&gt;
|-&lt;br /&gt;
| 4 || Mailing system supports folder subscription.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id is not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;folder_id&amp;lt;/code&amp;gt; – The parent folder of the newly created folder&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id should not be present.&lt;br /&gt;
&lt;br /&gt;
Provided that permission is granted to create a folder, its module is bound to the limitation, that the new folder&#039;s module must be equal to parent folder&#039;s module except that:&lt;br /&gt;
* Parent folder is one of the system folders &amp;lt;code&amp;gt;private&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;public&amp;lt;/code&amp;gt;, or &amp;lt;code&amp;gt;shared&amp;lt;/code&amp;gt;. Below these folders task, calendar, and contact modules are permitted.&lt;br /&gt;
* Parent folder&#039;s module is one of task, calendar, or contact. Below this kind of folders task, calendar, and contact modules are permitted.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content (preliminary) ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=clear&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; – (Preliminary) The identifier of the folder tree. If missing &#039;0&#039; (primary folder tree) is assumed.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Subscribing a folder to a (non-primary) folder tree (preliminary) ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=subscribe&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The identifier of the folder to subscribe&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON object specifying source tree, (non-primary) target tree and the parent in target tree:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;sourcetree&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;targettree&amp;quot;:&amp;quot;1&amp;quot;, &amp;quot;targetparent&amp;quot;:&amp;quot;112&amp;quot;}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: Undefined. No reasonable response is generated by this request.&lt;br /&gt;
&lt;br /&gt;
=== Unsubscribing a folder from a (non-primary) folder tree (preliminary) ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=unsubscribe&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The identifier of the folder to unsubscribe&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON object specifying the (non-primary) target tree:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;targettree&amp;quot;:&amp;quot;1&amp;quot;}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: Undefined. No reasonable response is generated by this request.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number or Time || Specifies when to notify the participants as the number of minutes before the start of the appointment. For tasks, the Time value specifies the absolute time when the user should be notified.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 210 || change_exceptions                     || Array       || An array of Dates, representing all change exceptions of a sequence.&lt;br /&gt;
|-&lt;br /&gt;
| 211 || delete_exceptions                     || Array       || An array of Dates, representing all delete exceptions of a sequence.&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Inclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#ParticipantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|-&lt;br /&gt;
| 222 || occurrences || Number || Specifies how often a recurrence should appear. May be present only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|-&lt;br /&gt;
| 5 || external user&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete || Date || Deprecated. Only present in AJAX interface. Value will not be stored on OX server.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority || Number || 1 = LOW, 2 = MEDIUM, 3 = HIGH&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the task&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder Identifier through that the task is accessed. This is necessary for checking the permissions.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object with attributes described in [[#SearchTasks | Search tasks]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchTasks&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search tasks&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find tasks. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || (optional) Defines the folder to search for tasks in. If this is omitted in all task folders will be searched.&lt;br /&gt;
|-&lt;br /&gt;
| start || Date or Time || (optional) Inclusive start date for a time range the tasks should end in. If start is omitted end is ignored.&lt;br /&gt;
|-&lt;br /&gt;
| end || Date or Time || (optional) Exclusive end date for a time range the tasks should end in. If this parameter is omitted the time range has an open end.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with matching tasks. Tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home || String&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status || String&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children || String&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type  || String&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number || String&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business || String&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees || String&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume || String&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other || String&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1 || String&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01 || String&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02 || String&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03 || String&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04 || String&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05 || String&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06 || String&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07 || String&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08 || String&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09 || String&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10 || String&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11 || String&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12 || String&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13 || String&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14 || String&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15 || String&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16 || String&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17 || String&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18 || String&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19 || String&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20 || String&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]]. &#039;&#039;&#039;deprecated&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distribution_list || Number&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links || Number || &#039;&#039;&#039;deprecated&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || number_of_images || Number&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified || Timestamp&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other || String&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as || String&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type || String&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist || Boolean&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address || Number&lt;br /&gt;
|-&lt;br /&gt;
| 606 ||                             || image1_url || String&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid || Number&lt;br /&gt;
|-&lt;br /&gt;
| 608 ||                             || useCount || Number || In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with objects. Each object contains fields “id” and “folder” of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=listuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with id&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
Available with SP4&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the contact&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Get contact by user ID ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – User ID (not Object ID) of the requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. &lt;br /&gt;
&lt;br /&gt;
Available with SP4 package.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder identifier through that the contact is accessed. This is necessary for checking the permissions.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
To remove some contact image send the image attribute set to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
To change or add some contact image the PUT command must be replaced with a POST command and all data must be provided within a &amp;lt;code&amp;gt;multipart/form-data&amp;lt;/code&amp;gt; body. The normal request body must be placed into a form field named &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; while the image file must be placed in a file field named &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt;. The response is then an HTML page as described in section [[#File_uploads | File uploads]].&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
To add some contact image the PUT command must be replaced with a POST command and all data must be provided within a &amp;lt;code&amp;gt;multipart/form-data&amp;lt;/code&amp;gt; body. The normal request body must be placed into a form field named &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; while the image file must be placed in a file field named &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt;. The response is then an HTML page as described in section [[#File uploads | File uploads]].&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. In case of use of column 609 (use count depending order for collected contacts with global address book) the parameter &amp;quot;order&amp;quot; ist NOT necessary and will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter. If this field is present, the pattern is matched against the contact field which is specified by the property contact_first_letter_field on the server (default: last name). Otherwise, the pattern is matched against the display name.&lt;br /&gt;
|-&lt;br /&gt;
| folder || Array of Number || If a list of folder identifiers or at least a single folder identifier is given, only in that folders will be searched for contacts. This paramenter is optional but searching in all contact folders that are viewable and where objects can be read in is more expensive on that database than searching in a dedicated number of them. The possibility to provide here an array of folder identifier has been added with 6.10.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Alternative request body: An Object as described in [[#SearchContactsAlternative | Search contacts alternative]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContactsAlternative&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts alternative&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| email1 || String || Searches contacts where the email1 address match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| email2 || String || Searches contacts where the email2 address match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| email3 || String || Searches contacts where the email3 address match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given search pattern. (requires version &amp;gt;= 6.12)&lt;br /&gt;
|-&lt;br /&gt;
| categories || String || Searches contacts where the categories match with the given search pattern. &lt;br /&gt;
|-&lt;br /&gt;
| orSearch || Boolean || If set to true, the fields are connected through an OR search habit.&lt;br /&gt;
|-&lt;br /&gt;
| emailAutoComplete || Boolean || If set to true, results are guaranteed to contain at least one email adress and the search is performed by connecting the relevant fields through an OR search habit.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which start on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which end before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client. &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days. Each entry in the array corresponds with one day in the range that was queried, explaining whether there is an appointment on this day or not.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_position&amp;lt;/code&amp;gt; (optional) – Recurrence Position requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the appointment&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: If the appointment was created successfully, an object with the attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created appointment. If the appointment could not be created due to conflicts, the response body is an object with the field &amp;lt;code&amp;gt;conflicts&amp;lt;/code&amp;gt;, which is an array of appointment objects which caused the conflict. Each appointment object which represents a resource conflict contains an additional field &amp;lt;code&amp;gt;hard_conflict&amp;lt;/code&amp;gt; with the Boolean value true. If the user does not have read access to a conflicting appointment, only the fields &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;start_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;end_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;shown_as&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; are present and the field &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; contains only the participants which caused the conflict.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Confirm appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the appointment to confirm.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through which the appointment is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirmed appointment.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot;, &amp;quot;confirmmessage&amp;quot; and &amp;quot;id&amp;quot; (optional) as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| folder_id || String || Folder ID. Only set, if the user has the right to see the object. (added 2009-08-18/6.12) &lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find appointments. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search appointments with the given starting letter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get new appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/appointments?action=newappointments&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;limit&amp;lt;/code&amp;gt; – limits the number of returned object to the given value.&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number || Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 1 and 10 (inclusive).&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|-&lt;br /&gt;
| 256 || forwarded&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 615  || msg_ref                 || String  || Message reference on reply/forward.&lt;br /&gt;
|-&lt;br /&gt;
| 651  || flag_seen                 || String  || Special field to sort mails by seen status&lt;br /&gt;
|-&lt;br /&gt;
| 652  || account_name                 || String  || Message&#039;s account name.&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Array  || An array with user-defined flags as strings.&lt;br /&gt;
|-&lt;br /&gt;
|     || headers                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with one object for each requested mail. Each object contains the fields &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail as described in [[#UpdateMail | Update mail]] or [[#UpdateMailExtended | Update mail extended]] (available with SP6 v6.10).&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object containing the Object ID of the updated mail and its folder.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UpdateMail&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Update mail&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| color_label || Number || The color number between 1 and 10.&lt;br /&gt;
|-&lt;br /&gt;
| flags || Number || A set of flags to add or remove. Note: Flags for &amp;quot;recent&amp;quot; (8) and &amp;quot;user&amp;quot; (64) are ignored.&lt;br /&gt;
|-&lt;br /&gt;
| value || Boolean || &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; to add the flags specified by &amp;lt;code&amp;gt;flags&amp;lt;/code&amp;gt; (logical OR), &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt; to remove them (logical AND with the inverted value).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UpdateMailExtended&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Update mail extended (available with SP6 v6.10)&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| set_flags || Number || A set of flags to add. Note: Flags for &amp;quot;recent&amp;quot; (8) and &amp;quot;user&amp;quot; (64) are ignored.&lt;br /&gt;
|-&lt;br /&gt;
| clear_flags || Number || A set of flags to remove. Note: Flags for &amp;quot;recent&amp;quot; (8) and &amp;quot;user&amp;quot; (64) are ignored.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the mail&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) – 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
* &amp;lt;code&amp;gt;view&amp;lt;/code&amp;gt; (optional - available with SP4) - &amp;quot;raw&amp;quot; returns the content as it is, meaning no preparation are performed and thus no guarantee for safe contents is given (available with SP6 v6.10). &amp;quot;text&amp;quot; forces the server to deliver a text-only version of the requested mail&#039;s body, even if content is HTML. &amp;quot;html&amp;quot; to allow a possible HTML mail body being transferred as it is (but white-list filter applied). &amp;quot;noimg&amp;quot; to allow a possible HTML content being transferred but without original image src attributes which references external images: Can be used to prevent loading external linked images (spam privacy protection). &#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;unseen&amp;lt;/code&amp;gt; (optional) – &amp;quot;1&amp;quot; or &amp;quot;true&amp;quot; to leave an unseen mail as unseen although its content is requested&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The folder identifier.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment &#039;&#039;&#039;OR&#039;&#039;&#039;&lt;br /&gt;
* &amp;lt;code&amp;gt;cid&amp;lt;/code&amp;gt; – Value of header &#039;Content-ID&#039; of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
* &amp;lt;code&amp;gt;filter&amp;lt;/code&amp;gt; (optional) – 1 to apply HTML white-list filter rules if and only if requested attachment is of MIME type &amp;lt;code&amp;gt;text/htm*&amp;lt;/code&amp;gt; &#039;&#039;&#039;AND&#039;&#039;&#039; parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
=== Get multiple mail attachments as a ZIP file (preliminary) ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=zip_attachments&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The folder identifier.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachments.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – A comma-separated list of IDs of the requested attachments&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the ZIP file.&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send/Save mail as MIME data block (RFC822) (added in SP5) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; - A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; - Set to &amp;quot;1&amp;quot; to accept mail message as MIME data block.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) - In case the mail should not be sent out, but saved in a specific folder, the &amp;quot;folder&amp;quot; paramter can be used. If the mail should be sent out to the recipient, the &amp;quot;folder&amp;quot; parameter must not be included and the mail is stored in the folder &amp;quot;Sent Items&amp;quot;. Example &amp;quot;folder=default.INBOX/Testfolder&amp;quot;&lt;br /&gt;
* &amp;lt;code&amp;gt;flags&amp;lt;/code&amp;gt; (optional) - In case the mail should be stored with status &amp;quot;read&amp;quot; (e.g. mail has been read already in the client inbox), the parameter &amp;quot;flags&amp;quot; has to be included. If no &amp;quot;folder&amp;quot;  parameter is specified, this parameter must not be included. For infos about mail flags see [[#DetailedMailData | Detailed mail data]] spec.&lt;br /&gt;
 &lt;br /&gt;
Request Body: The MIME Data Block&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created/moved mail.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;view&amp;lt;/code&amp;gt; (optional - available with SP6) - &amp;quot;text&amp;quot; forces the server to deliver a text-only version of the requested mail&#039;s body, even if content is HTML. &amp;quot;html&amp;quot; to allow a possible HTML mail body being transferred as it is (but white-list filter applied).&#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Clear mail folder(s) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=clear&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with IDs of the mail folders to clear&lt;br /&gt;
&lt;br /&gt;
Response: An array with IDs of mail folder that could not be cleared; meaning the response body is an empty JSON array if everything went well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: A group object as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
=== List groups ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with group identifiers.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
=== Search for groups ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#GroupSearch | Group search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array of group objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group data&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| name         || String || Name with character restrictions&lt;br /&gt;
|-&lt;br /&gt;
| members       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Create a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created group.&lt;br /&gt;
&lt;br /&gt;
=== Delete a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the group to delete.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id” containing the unique identifier of the group.&lt;br /&gt;
&lt;br /&gt;
Response: An empty json array if the group was deleted successfully.&lt;br /&gt;
&lt;br /&gt;
=== Change a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the group to update.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Time stamp of the group to update. If the group was modified after the specified time stamp, then the update must fail. &lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. Only modified fields are present and the field id is omitted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== List resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Request body: An array with resources ids.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document. Not yet implemented, so this is currently always empty.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise. . Note: This is not writeable&lt;br /&gt;
|-&lt;br /&gt;
| 711 || number_of_versions || Number || The number of all versions of the infoitem. Note: This is not writeable.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the infoitem&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with [[]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with objects to delete. The fields for the object are described in [[#FullIdentifierForAnInfostoreDocument|Full identifier for an infostore document]]. &lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnInfostoreDocument&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an infostore document&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || Folder ID&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; (deprecated) ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| servertime || Time || The time on the server&lt;br /&gt;
|-&lt;br /&gt;
| user_id || Number || The ID of the user.&lt;br /&gt;
|-&lt;br /&gt;
| last_modified || Time || The last modification timestamp of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| recurrence_position || Number || The recurrence position for series appointments or 0 if no series&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || The ID of the folder through that the object can be read&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Reminder===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/reminder?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
Response body: An JSON array with the id that was not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: A &amp;quot;multipart/form-data&amp;quot; encoded .CSV file. The field name for the file is &amp;quot;file&amp;quot;. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered, and warnings (under the key &amp;quot;warnings&amp;quot;) containing an Array of objects with the warning data, containing all customary error fields.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Calendar folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mailfilter&amp;quot; ==&lt;br /&gt;
The module mailfilter descriptes how to add, update or delete mail filter rules or to check which actions are supported by the underlying system.&lt;br /&gt;
&lt;br /&gt;
A detailed description can be found here [[ HTTP_API_MailFilter | Mail Filter HTTP API]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;ajax file upload&amp;quot; ==&lt;br /&gt;
This module offers to store files in server&#039;s dedicated download directory for a configureable amount of time. The files are then accessible for further operations like inline images in (html) mails&lt;br /&gt;
&lt;br /&gt;
=== Uploading a file ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/file?action=new&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The module for which the file is uploaded to determine proper upload quota constraints (e.g. &amp;quot;mail&amp;quot;, &amp;quot;infostore&amp;quot;, etc.).&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; – The file type filter to define which file types are allowed during upload. Currently supported filters are: &amp;lt;code&amp;gt;file=all, text=text/*, media=image OR audio OR video, image=image/*, audio=audio/*, video=video/*, application=application/*&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A common POST request body of MIME type &amp;quot;multipart/*&amp;quot; which holds the file(s) to upload&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of the uploaded files. The files are accessible through the returned IDs for future use.&lt;br /&gt;
&lt;br /&gt;
=== Updating a file&#039;s last access timestamp (keep alive) ===&lt;br /&gt;
By updating the last access timestamp it&#039;s prevented from being deleted from both session and disk storage.&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=keepalive&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file whose timestamp should be updated&lt;br /&gt;
&lt;br /&gt;
Response: The string &amp;quot;null&amp;quot; in response&#039;s data element&lt;br /&gt;
&lt;br /&gt;
=== Requesting a formerly uploaded file ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested file is directly written into output stream&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;image&amp;quot; ==&lt;br /&gt;
This module allows to download images from Open-Xchange server without providing a session ID in request&#039;s URL parameters.&lt;br /&gt;
&lt;br /&gt;
=== Requesting an image ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/image&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;uid&amp;lt;/code&amp;gt; – The unique ID referring to the desired image&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested image is directly written into output stream&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;conversion&amp;quot; (preliminary) ==&lt;br /&gt;
&lt;br /&gt;
A generic module to request data from a data source and to process obtained/submitted data with a data handler. Thus data is converted from a data source by a data handler.&lt;br /&gt;
&lt;br /&gt;
=== Converting data ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/conversion?action=convert&amp;lt;/code&amp;gt;&amp;lt;br&amp;gt;&lt;br /&gt;
or&amp;lt;br&amp;gt;&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/conversion?action=convert&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters: &amp;amp;lt;no parameters required&amp;amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A [[#ConversionRequest | conversion request]] JSON object containing nested JSON objects for [[#DataSource | data source]] and [[#DataHandler | data handler]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ConversionRequest&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Conversion request object&lt;br /&gt;
! Field      !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| datasource || JSON object || The data source object.&lt;br /&gt;
|-&lt;br /&gt;
| datahandler || JSON object || The data handler object.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSource&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data source object&lt;br /&gt;
! Field      !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| identifier || String || The identifier of the data source.&lt;br /&gt;
|-&lt;br /&gt;
| args || JSON array || The &#039;&#039;&#039;optional&#039;&#039;&#039; name-value-pairs as JSON objects for data source&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataHandler&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data handler object&lt;br /&gt;
! Field      !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| identifier || String || The identifier of the data handler.&lt;br /&gt;
|-&lt;br /&gt;
| args || JSON array || The &#039;&#039;&#039;optional&#039;&#039;&#039; name-value-pairs as JSON objects for data handler&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: The result of converted data ready as an appropriate JSON response&lt;br /&gt;
&lt;br /&gt;
==== Saving an ICal email attachment ====&lt;br /&gt;
&lt;br /&gt;
If an ICal file is attached to an email, its content can be saved as appointments and tasks into given calendar and task folder.&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.ical&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.fullname&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-fullname&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.mailid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;mail-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.sequenceid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;attachment-sequence-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.ical&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.groupware.calendar.folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;calendar-folder-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&lt;br /&gt;
{&amp;amp;quot;com.openexchange.groupware.task.folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;task-folder-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array of JSON objects each providing folder and object ID of added appointment/task; e.g. &amp;lt;code&amp;gt;[{&amp;amp;quot;folder_id&amp;amp;quot;:2567, &amp;amp;quot;id&amp;amp;quot;:7689}, ...]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
==== Converting an ICal email attachment into JSON objects ====&lt;br /&gt;
&lt;br /&gt;
If an ICal file is attached to an email, its content can converted to JSON appointments and tasks.&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.ical&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.fullname&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-fullname&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.mailid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;mail-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.sequenceid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;attachment-sequence-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object.&amp;lt;br&amp;gt;&lt;br /&gt;
&#039;&#039;&#039;Note&#039;&#039;&#039; that both arguments are optional: Default is user time zone and zero recurrence position&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.ical.json&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.groupware.calendar.timezone&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;timezone-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&lt;br /&gt;
{&amp;amp;quot;com.openexchange.groupware.calendar.recurrencePosition&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;recurrence-position&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array of JSON objects for each appointment/task as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]/[[##DetailedAppointmentData | Detailed appointment data]]&lt;br /&gt;
&lt;br /&gt;
==== Saving a VCard email attachment ====&lt;br /&gt;
&lt;br /&gt;
If a VCard file is attached to an email, its content can be saved as contacts into given contact folder.&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.vcard&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.fullname&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-fullname&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.mailid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;mail-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.mail.conversion.sequenceid&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;attachment-sequence-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.contact&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;com.openexchange.groupware.contact.folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;contact-folder-id&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array of JSON objects each providing folder and object ID of added contact; e.g. &amp;lt;code&amp;gt;[{&amp;amp;quot;folder_id&amp;amp;quot;:2567, &amp;amp;quot;id&amp;amp;quot;:7689}, ...]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==== Contact(s) attached to a new email as a VCard file ====&lt;br /&gt;
&lt;br /&gt;
Obtain VCard data from specified contact object(s).&lt;br /&gt;
&lt;br /&gt;
Data source&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.contact&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-id1&amp;amp;gt;&amp;amp;quot;,&amp;amp;quot;id&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;id1&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;...&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;&amp;amp;nbsp;{&amp;amp;quot;folder&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;folder-idn&amp;amp;gt;&amp;amp;quot;,&amp;amp;quot;id&amp;amp;quot;:&amp;amp;quot;&amp;amp;lt;idn&amp;amp;gt;&amp;amp;quot;}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Get a new email&#039;s JSON object with specified VCard data source attached.&lt;br /&gt;
&lt;br /&gt;
Data handler&#039;s JSON object&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;identifier&amp;amp;quot;:&amp;amp;quot;com.openexchange.mail.vcard&amp;amp;quot;&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;quot;args&amp;amp;quot;:[]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A [[#DetailedMailData | mail]] JSON object.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;search&amp;quot; (preliminary) ==&lt;br /&gt;
&lt;br /&gt;
The search module is an enhancement to each search request as an optional JSON object via PUT method to filter elements; e.g.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
PUT /ajax/contacts?action=all&amp;amp;...&lt;br /&gt;
&lt;br /&gt;
{&amp;quot;filter&amp;quot;:{search-term-object}}&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This section describes the syntax of the optional JSON object representing the search term.&amp;lt;br&amp;gt;&lt;br /&gt;
In general the structure of a search term is in prefix notation; meaning the operator is written before its operands:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;operation&amp;quot;:&amp;quot;equals&amp;quot;,&amp;quot;operands&amp;quot;:[...]}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Moreover there are two different types of a search terms:&lt;br /&gt;
* A single search term&lt;br /&gt;
* A composite search term&lt;br /&gt;
&lt;br /&gt;
A single search term reflects an operation which cannot hold nested search terms as operands; e.g. &amp;quot;equals&amp;quot;. In opposite to this a composite search term holds one or more nested search terms as operands; e.g. &amp;quot;not&amp;quot; or the logical junctors &amp;quot;and&amp;quot;/&amp;quot;or&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
By now the following operations are supported:&lt;br /&gt;
* composite operations&lt;br /&gt;
** &amp;quot;and&amp;quot; - The AND junctor&lt;br /&gt;
** &amp;quot;or&amp;quot; - The OR junctor&lt;br /&gt;
** &amp;quot;not&amp;quot; - Negation&lt;br /&gt;
* single operations&lt;br /&gt;
** &amp;quot;equals&amp;quot; - Equals comparison&lt;br /&gt;
** &amp;quot;lt&amp;quot; - Less-than comparison&lt;br /&gt;
** &amp;quot;gt&amp;quot; - Greater-than comparison&lt;br /&gt;
&lt;br /&gt;
Furthermore following operand types are supported for single search terms:&lt;br /&gt;
* Column - Providing a name referring to a field/column&lt;br /&gt;
* Constant - A constant&lt;br /&gt;
&lt;br /&gt;
Example of an EQUALS search term:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;quot;operation&amp;quot;:&amp;quot;equals&amp;quot;,&amp;quot;operands&amp;quot;:[{&amp;quot;type&amp;quot;:&amp;quot;column&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;first_name&amp;quot;},&amp;quot;Jane&amp;quot;]}&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Example of an OR search term:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;code&amp;gt;&lt;br /&gt;
{&amp;quot;operation&amp;quot;:&amp;quot;or&amp;quot;,&amp;quot;operands&amp;quot;:&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;[&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;{&amp;quot;operation&amp;quot;:&amp;quot;equals&amp;quot;,&amp;quot;operands&amp;quot;:[{&amp;quot;type&amp;quot;:&amp;quot;column&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;first_name&amp;quot;},&amp;quot;Jane&amp;quot;]},&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;&amp;amp;nbsp;{&amp;quot;operation&amp;quot;:&amp;quot;gt&amp;quot;,&amp;quot;operands&amp;quot;:[{&amp;quot;type&amp;quot;:&amp;quot;column&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;birthday&amp;quot;},&amp;quot;1975-05-01&amp;quot;]}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;amp;nbsp;]&amp;lt;br&amp;gt;&lt;br /&gt;
}&amp;lt;br&amp;gt;&lt;br /&gt;
&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Refer to object data tables introduced by different modules to know which field names are supported; e.g. for tasks it is [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]], and [[#DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail account&amp;quot; (preliminary: available with v6.12) ==&lt;br /&gt;
&lt;br /&gt;
The mail account module is used to manage multiple mail accounts held by a user.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail account ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/account?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the account to return.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object representing the desired mail account. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;MailAccountData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Mail account data&lt;br /&gt;
! ID    !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  1001   || id            || Number  || Account ID&lt;br /&gt;
|-&lt;br /&gt;
|  1002   ||  login    || String  || The login.&lt;br /&gt;
|-&lt;br /&gt;
|  1003   ||  password   || String  || The (optional) password.&lt;br /&gt;
|-&lt;br /&gt;
|  1004   ||  mail_url || String    || The mail server URL; e.g. &amp;quot;imap://imap.somewhere.com:143&amp;quot;. &#039;&#039;&#039;URL is preferred over single fields&#039;&#039;&#039; (like mail_server, mail_port, etc.)&lt;br /&gt;
|-&lt;br /&gt;
|  1005   ||  transport_url || String    || The transport server URL; e.g. &amp;quot;smtp://smtp.somewhere.com:25&amp;quot;. &#039;&#039;&#039;URL is preferred over single fields&#039;&#039;&#039; (like transport_server, transport_port, etc.)&lt;br /&gt;
|-&lt;br /&gt;
|   1006  ||  name || String    || Account&#039;s display name.&lt;br /&gt;
|-&lt;br /&gt;
|  1007   ||  primary_address || String    || User&#039;s primary address in account; e.g. &amp;quot;someone@somewhere.com&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|  1008   ||  spam_handler || String    || The name of the spam handler used by account.&lt;br /&gt;
|-&lt;br /&gt;
|   1009  ||  trash || String    || The name of the default trash folder.&lt;br /&gt;
|-&lt;br /&gt;
|  1010   ||  sent || String    || The name of the default sent folder.&lt;br /&gt;
|-&lt;br /&gt;
|   1011  ||  drafts || String    || The name of the default drafts folder.&lt;br /&gt;
|-&lt;br /&gt;
|  1012   ||  spam || String    || The name of the default spam folder.&lt;br /&gt;
|-&lt;br /&gt;
|  1013   ||  confirmed_spam || String    || The name of the default confirmed-spam folder.&lt;br /&gt;
|-&lt;br /&gt;
|   1014  || confirmed_ham || String    || The name of the default confirmed-ham folder.&lt;br /&gt;
|-&lt;br /&gt;
|   1015  ||  mail_server || String    || The mail server&#039;s hostname or IP address.&lt;br /&gt;
|-&lt;br /&gt;
|   1016  ||  mail_port || Number    || The mail server&#039;s port.&lt;br /&gt;
|-&lt;br /&gt;
|   1017  ||  mail_protocol || String    || The mail server&#039;s protocol. &#039;&#039;&#039;Always use basic protocol name.&#039;&#039;&#039; E.g. use &amp;quot;imap&amp;quot; instead of &amp;quot;imaps&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1018  ||  mail_secure || Boolean    || Whether to establish a secure connection to mail server (SSL, TLS).&lt;br /&gt;
|-&lt;br /&gt;
|   1019  ||  transport_server || String    || The transport server&#039;s hostname or IP address.&lt;br /&gt;
|-&lt;br /&gt;
|   1020  ||  transport_port || Number    || The transport server&#039;s port.&lt;br /&gt;
|-&lt;br /&gt;
|   1021  ||  transport_protocol || String    || The transport server&#039;s protocol. &#039;&#039;&#039;Always use basic protocol name.&#039;&#039;&#039; E.g. use &amp;quot;smtp&amp;quot; instead of &amp;quot;smtps&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1022  ||  transport_secure || Boolean    || Whether to establish a secure connection to transport server (SSL, TLS).&lt;br /&gt;
|-&lt;br /&gt;
|   1023  ||  transport_login || String    || The transport login. If empty &amp;quot;login&amp;quot; is taken as transport login as well.&lt;br /&gt;
|-&lt;br /&gt;
|   1024  ||  transport_password || String    || The transport password. If empty &amp;quot;password&amp;quot; is taken as transport password as well.&lt;br /&gt;
|-&lt;br /&gt;
|   1025  ||  unified_inbox_enabled || Boolean    || If enabled for Unified INBOX&lt;br /&gt;
|-&lt;br /&gt;
|   1026  ||  trash_fullname || String    || Path to default trash folder. Preferred over &amp;quot;trash&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1027  ||  sent_fullname || String    || Path to default sent folder. Preferred over &amp;quot;sent&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1028  ||  drafts_fullname || String    || Path to default drafts folder. Preferred over &amp;quot;drafts&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1029  ||  spam_fullname || String    || Path to default spam folder. Preferred over &amp;quot;spam&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1030  ||  confirmed_spam_fullname || String    || Path to default confirmed-spam folder. Preferred over &amp;quot;confirmed_spam&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1031  ||  confirmed_ham_fullname || String    || Path to default confirmed-ham folder. Preferred over &amp;quot;confirmed_ham&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1032  ||  pop3_refresh_rate || Number    || The interval in minutes the POP3 account is refreshed&lt;br /&gt;
|-&lt;br /&gt;
|   1033  ||  pop3_expunge_on_quit || Boolean    || Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not&lt;br /&gt;
|-&lt;br /&gt;
|   1034  ||  pop3_delete_write_through || Boolean    || If option &amp;quot;pop3_expunge_on_quit&amp;quot; is disabled, this property defines whether a delete in local INBOX also deletes affected message in actual POP3 account&lt;br /&gt;
|-&lt;br /&gt;
|   1035  ||  pop3_storage || String    || The name of POP3 storage provider, default is &amp;quot;mailaccount&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
|   1036  ||  pop3_path || String    || Path to POP3&#039;s virtual root folder in storage, default is name of the POP3 account beside default folders&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Create a new mail account ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request: A JSON object describing the new account to create. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object representing the inserted mail account. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
=== Update a mail account ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request: A JSON object identifiying (field ID is present) and describing the account to update. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: A JSON object representing the updated mail account. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
=== Delete a mail account ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ID of the mail account to delete.&lt;br /&gt;
&lt;br /&gt;
=== Validate a mail account (which shall be created) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/account?action=validate&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;tree&amp;lt;/code&amp;gt; - An optional boolean parameter which indicates whether on successful validation the folder tree shall be returned (NULL on failure) or if set to &amp;quot;false&amp;quot; or missing only a boolean is returned which indicates validation result&lt;br /&gt;
&lt;br /&gt;
Request: A JSON object describing the new account to validate. See [[#MailAccountData | mail account data]].&lt;br /&gt;
&lt;br /&gt;
Response: Dependent on optional &amp;quot;tree&amp;quot; parameter a JSON folder object or a boolean value indicating the validation result&lt;br /&gt;
&lt;br /&gt;
The JSON folder object corresponding to [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
Additionally a field &amp;quot;subfolder_array&amp;quot; is added which contains possible subfolders. This field is missing if a folder contains no subfolders.&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;user&amp;quot; (preliminary: available with v6.14) ==&lt;br /&gt;
&lt;br /&gt;
The user module is used to access user information.&lt;br /&gt;
&lt;br /&gt;
=== Get all users ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/user?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for users are defined in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with user data. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedUserData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed user data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type       !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 610 || Aliases                     || aliases              || Array      || The user&#039;s aliases&lt;br /&gt;
|-&lt;br /&gt;
| 611 || Time zone                   || timezone             || String     || The time zone ID.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || Locale                      || locale               || String     || The name of user&#039;s entire locale, with the language, country and variant separated by underbars. E.g. &amp;quot;en&amp;quot;, &amp;quot;de_DE&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 613 || Groups                      || groups               || Array      || The IDs of user&#039;s groups&lt;br /&gt;
|-&lt;br /&gt;
| 614 || Contact ID                  || contact_id           || Number     || The contact ID of the user&lt;br /&gt;
|-&lt;br /&gt;
| 615 || Login info                  || login_info           || String     || The user&#039;s login information&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for users are defined in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of numbers. Each number is the ID of requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with user data. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a user ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/user?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested user. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]].&lt;br /&gt;
&lt;br /&gt;
=== Update a user ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated user.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated user. If the user was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: User object as described in [[#CommonObjectData | Common object data]], [[#DetailedContactData | Detailed contact data]] and [[#DetailedUserData | Detailed user data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Note&#039;&#039;&#039;: &amp;quot;timezone&amp;quot; and &amp;quot;locale&amp;quot; are the only fields from [[#DetailedUserData | Detailed user data]] which are allowed to be updated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An empty object.&lt;br /&gt;
&lt;br /&gt;
=== Search users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/user?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. In case of use of column 609 (use count depending order for collected users with global address book) the parameter &amp;quot;order&amp;quot; ist NOT necessary and will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchUsers | Search users]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchUsers&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search users&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find users. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search users with the given startletter. If this field is present, the pattern is matched against the user field which is specified by the property contact_first_letter_field on the server (default: last name). Otherwise, the pattern is matched against the display name.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Alternative request body: An Object as described in [[#SearchUsersAlternative | Search users alternative]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchUsersAlternative&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search users alternative&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches users where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches users where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches users where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| orSearch || Boolean || If set to true, the fields are connected through an OR search habit.&lt;br /&gt;
|-&lt;br /&gt;
| emailAutoComplete || Boolean || If set to true, results are guaranteed to contain at least one email adress and the search is performed by connecting the relevant fields through an OR search habit.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with user data. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=Enable_TinyMCE_spellcheck_module&amp;diff=4869</id>
		<title>Enable TinyMCE spellcheck module</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=Enable_TinyMCE_spellcheck_module&amp;diff=4869"/>
		<updated>2009-10-05T10:53:45Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Added new property description to enable the spellchecker&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
By default there is no spell check available in the Open-Xchange application itself because most of the modern browsers usually offer a spellcheck module. TinyMCE, the HTML editor which is used by Open-Xchange for HTML editing while writing an eMail, offers a wide set of functions and features which can be added to the HTML editor UI. This example will describe how you can enable the TinyMCE based spellcheck functionality within the Open-Xchange mail module.&lt;br /&gt;
&lt;br /&gt;
= Requirements =&lt;br /&gt;
&lt;br /&gt;
* An installed Open-Xchange Server&lt;br /&gt;
&lt;br /&gt;
* ASpell with the according dictionaries needs to be installed&lt;br /&gt;
&lt;br /&gt;
* PHP5 must be enabled in your Apache configuration&lt;br /&gt;
&lt;br /&gt;
= Enabling the TinyMCE Spellcheck module =&lt;br /&gt;
&lt;br /&gt;
Please note that enabling the spellcheck module will require the modification of one javascript file of the Open-Xchange UI, and therefor every update will disable the spellcheck button, as the javascript file will be overwritten during the update. Also Open-Xchange cannot support the spellcheck module itself and the according infrastructure (aspell, PHP), as those modules won&#039;t be maintained and tracked by Open-Xchange.&lt;br /&gt;
&lt;br /&gt;
== Installation of the TinyMCE spellchecker module ==&lt;br /&gt;
&lt;br /&gt;
Please visit the TinyMCE website and download the latest TinyMCE spellchecker module (at the bottom of the page) at http://tinymce.moxiecode.com/download.php. This article will use the following spellchecker module: http://prdownloads.sourceforge.net/tinymce/tinymce_spellchecker_php_2_0_2.zip?download&lt;br /&gt;
&lt;br /&gt;
Extract the downloaded archive and move the extracted directory &amp;quot;spellchecker&amp;quot; to the TinyMCE location on the Open-Xchange installation:&lt;br /&gt;
&lt;br /&gt;
 $ mv spellchecker /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/.&lt;br /&gt;
&lt;br /&gt;
== Enable the spellchecker button in the Open-Xchange HTML editor ==&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Version &amp;gt;= 6.14:&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
This can be accomplished by adding a properties file to directory &amp;quot;/opt/open-xchange/etc/groupware/settings&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
This file should contain a single property of the format:&lt;br /&gt;
 &amp;lt;path-in-config-tree&amp;gt; &#039;=&#039; (&amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;)&lt;br /&gt;
&lt;br /&gt;
E.g.:&lt;br /&gt;
 # A short description of this property&lt;br /&gt;
 modules/mail/spellcheck=true&lt;br /&gt;
&lt;br /&gt;
The file &amp;quot;/opt/open-xchange/etc/groupware/settings/themes.properties&amp;quot; for example is a good choice as a template.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Version &amp;lt;= 6.12:&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Now as we have installed the spellcheker plugin, we need to modify the Open-Xchange HTML editor, so that the spellchecker button will be displayed. To do so, edit /var/www/ox6/concat_mailnew.js and change the following lines:&lt;br /&gt;
&lt;br /&gt;
Replace&lt;br /&gt;
 plugins : &amp;quot;inlinepopups&amp;quot;,&lt;br /&gt;
with&lt;br /&gt;
 plugins : &amp;quot;inlinepopups,spellchecker&amp;quot;,&lt;br /&gt;
Replace:&lt;br /&gt;
 theme_advanced_buttons2 : (editorEnabled ? &amp;quot;cut,copy,paste,|,bullist,numlist,|,outdent,indent,|,undo,redo,|,image,link,unlink,|,hr,|,charmap&amp;quot; : &amp;quot;&amp;quot;) ,&lt;br /&gt;
with&lt;br /&gt;
 theme_advanced_buttons2 : (editorEnabled ? &amp;quot;cut,copy,paste,|,bullist,numlist,|,outdent,indent,|,undo,redo,|,image,link,unlink,|,hr,|,charmap,|,spellchecker&amp;quot; : &amp;quot;&amp;quot;) ,&lt;br /&gt;
&lt;br /&gt;
== Setup the backend communication ==&lt;br /&gt;
&lt;br /&gt;
Finally we need to tell the spellchecker module which binary it should execute in order to get spelling suggestions. By default GoogleSpell is activated for remote suggestion, but as this would mean that every eMail which should be checked will be send to Google, we recommend to use a local aspell instance for this purpose. To do so, install aspell and the according dictionaries as we told you in the requirements section, and modify /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/spellchecker/config.php to specify the aspell binary location. Please use the following example, and just replace [REPLACE_WITH_PATH_TO_ASPELL_BIN] with the location of the aspell binary (for example /usr/bin/aspell):&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;?php&lt;br /&gt;
         // General settings&lt;br /&gt;
         //$config[&#039;general.engine&#039;] = &#039;GoogleSpell&#039;;&lt;br /&gt;
         //$config[&#039;general.engine&#039;] = &#039;PSpell&#039;;&lt;br /&gt;
         $config[&#039;general.engine&#039;] = &#039;PSpellShell&#039;;&lt;br /&gt;
         //$config[&#039;general.remote_rpc_url&#039;] = &#039;http://some.other.site/some/url/rpc.php&#039;;&lt;br /&gt;
 &lt;br /&gt;
         // PSpell settings&lt;br /&gt;
         //$config[&#039;PSpell.mode&#039;] = PSPELL_FAST;&lt;br /&gt;
         //$config[&#039;PSpell.spelling&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
         //$config[&#039;PSpell.jargon&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
         //$config[&#039;PSpell.encoding&#039;] = &amp;quot;&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
         // PSpellShell settings&lt;br /&gt;
         $config[&#039;PSpellShell.mode&#039;] = PSPELL_FAST;&lt;br /&gt;
         $config[&#039;PSpellShell.aspell&#039;] = &#039;[REPLACE_WITH_PATH_TO_ASPELL_BIN]&#039;;&lt;br /&gt;
         $config[&#039;PSpellShell.tmp&#039;] = &#039;/tmp&#039;;&lt;br /&gt;
 &lt;br /&gt;
         // Windows PSpellShell settings&lt;br /&gt;
         //$config[&#039;PSpellShell.aspell&#039;] = &#039;&amp;quot;c:\Program Files\Aspell\bin\aspell.exe&amp;quot;&#039;;&lt;br /&gt;
         //$config[&#039;PSpellShell.tmp&#039;] = &#039;c:/temp&#039;;&lt;br /&gt;
 ?&amp;gt;&lt;br /&gt;
&lt;br /&gt;
[[Category: OX6]]&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=3027</id>
		<title>OX6:Gui Plugin Development</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=3027"/>
		<updated>2009-02-10T10:40:58Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: small text changes&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
With Open-Xchange SP4 you will be able to add you own JavaScript Code for existing events. The follwoing examples show how you can add your own About page, your own Window Title, and your own message for not activated/bought components of OX (Upsell Message).&lt;br /&gt;
&lt;br /&gt;
= Setup and file description =&lt;br /&gt;
&lt;br /&gt;
Two things have to be done to register your own JavaScript Code within the server:&lt;br /&gt;
&lt;br /&gt;
1. You have to create the property file in /opt/open-xchange/etc/groupware/settings/, for example myjscode.properties. The file should have the following value:&lt;br /&gt;
&lt;br /&gt;
 modules/$NAME/enabled=true&lt;br /&gt;
&lt;br /&gt;
$NAME is equal to the filename of the property file, in our case it would be:&lt;br /&gt;
&lt;br /&gt;
 modules/myjscode/enabled=true&lt;br /&gt;
&lt;br /&gt;
This will enable the JS Code located in $WEBSRV/ox6/plugins/$NAME (for example /var/www/ox6/plugins/myjscode/).&lt;br /&gt;
&lt;br /&gt;
2. Next we have to create the folder that we had configured, in our example we would have to create:&lt;br /&gt;
&lt;br /&gt;
 mkdir /var/www/ox6/plugins/myjscode/&lt;br /&gt;
&lt;br /&gt;
The server now will have a look at this directory and searches for the file register.js in this directory. All your JS enhancements should be written to that file.&lt;br /&gt;
&lt;br /&gt;
3. Afterwards you have to restart the groupware server with:&lt;br /&gt;
&lt;br /&gt;
 /etc/init.d/open-xchange-groupware restart&lt;br /&gt;
&lt;br /&gt;
= Examples =&lt;br /&gt;
&lt;br /&gt;
== Customized About page ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/productinfo.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/productinfo/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/productinfo/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.vendor_address = &amp;quot;&amp;lt;b&amp;gt;Open-Xchange GmbH&amp;lt;/b&amp;gt;\nMartinstrasse 41\n57462 Olpe\nE-Mail: info@open-xchange.com\n&amp;lt;a href=\&amp;quot;http://www.open-xchange.com\&amp;quot; target=\&amp;quot;_blank\&amp;quot;&amp;gt;www.open-xchange.com&amp;lt;/a&amp;gt;&amp;quot;&lt;br /&gt;
&lt;br /&gt;
== Customized Window Title ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/windowtitle.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/windowtitle/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/windowtitle/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.product_name = &amp;quot;This is the fabulous Open-Xchange Server&amp;quot;; &lt;br /&gt;
 &lt;br /&gt;
 try {&lt;br /&gt;
     window.document.title = oxProductInfo.product_name;&lt;br /&gt;
 } catch (e) { }&lt;br /&gt;
&lt;br /&gt;
== Customized Upsell Message ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/upsell.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com&lt;br /&gt;
 # &lt;br /&gt;
 # Author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 # The following property enables the Upsell-Layer Plugin for the OX6 AJAX GUI&lt;br /&gt;
 modules/upsell/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/upsell/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 /*&lt;br /&gt;
  * Example for an Upsell-Layer&lt;br /&gt;
  * The OX GUI triggers a special event if a user clicks on disabled features.&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
  /*&lt;br /&gt;
   * Register to Upsell-Event&lt;br /&gt;
   */&lt;br /&gt;
  register(&amp;quot;Feature_Not_Available&amp;quot;, showUpsellLayer);&lt;br /&gt;
 &lt;br /&gt;
  /**&lt;br /&gt;
   * Function to display an Upsell-Alert dialog&lt;br /&gt;
   * @param feature String (optional) - Module description&lt;br /&gt;
   * @param win Window (optional) - Only needed/given if we trigger the event from the new object windows &lt;br /&gt;
   */&lt;br /&gt;
  function showUpsellLayer(feature, win) {&lt;br /&gt;
     // setting corewindow to default if win is not defined&lt;br /&gt;
     win = win || corewindow; &lt;br /&gt;
     &lt;br /&gt;
     /*&lt;br /&gt;
      * Build up the dialog content&lt;br /&gt;
      * Note: You can also use myDiv.innerHTML!&lt;br /&gt;
      */&lt;br /&gt;
     var myDiv = newnode(&amp;quot;div&amp;quot;,{ textAlign: &amp;quot;center&amp;quot;, padding: &amp;quot;10px&amp;quot; }, 0, [ &lt;br /&gt;
             newnode(&amp;quot;div&amp;quot;, 0, { background: &amp;quot;url(http://www.example.com/img/header/logo.gif)&amp;quot; }, 0,&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;span&amp;quot;, 0, 0, [ &lt;br /&gt;
                 document.createTextNode(&amp;quot;Diese Funktion ist nur in Open-Xchange Premium verfügbar!&amp;quot;) ],&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Weitere Information zu Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Paket-Upgrade auf Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document) &lt;br /&gt;
         ], win.document);&lt;br /&gt;
     &lt;br /&gt;
     // calling the newAlert function to open the dialog at the given window&lt;br /&gt;
     win.newAlert(&amp;quot;Hinweis &amp;quot; + feature, null, AlertPopup.close, myDiv);&lt;br /&gt;
  }&lt;br /&gt;
  &lt;br /&gt;
  /*&lt;br /&gt;
   * Comment this out to change the grayed out module images in the upper left corner!&lt;br /&gt;
   */&lt;br /&gt;
  /*&lt;br /&gt;
  if (!document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src.match(/mod_portal_sel.gif$/)) {&lt;br /&gt;
     document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src = getFullImgSrc(&amp;quot;img/portal/mod_portal.gif&amp;quot;);&lt;br /&gt;
  }&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_calendar&amp;quot;).src = getFullImgSrc(&amp;quot;img/calendar/mod_calendar.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_tasks&amp;quot;).src = getFullImgSrc(&amp;quot;img/tasks/mod_tasks.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_infostore&amp;quot;).src = getFullImgSrc(&amp;quot;img/infostore/mod_infostore.gif&amp;quot;);&lt;br /&gt;
  */&lt;br /&gt;
&lt;br /&gt;
== Customized / Extended configuration tree ==&lt;br /&gt;
&lt;br /&gt;
In order to extend your configuration frontend you will have to make more changes then overwrite existing JS methods. You have to implement your own configuration site. Below, you will find the JS API Doc that will show you how to build external contents into the configuration frontend:&lt;br /&gt;
&lt;br /&gt;
[[Main_Page#Interfaces|JavaScript API for extending the configuration frontend]]&lt;br /&gt;
and&lt;br /&gt;
[[Main_Page#UI_Customization|Gui Plugin API Documentation]]&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/extendconfiguration.properties:&lt;br /&gt;
&lt;br /&gt;
 modules/extendconfiguration/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/extendconfiguration/register.js:&lt;br /&gt;
&lt;br /&gt;
 // Extending the configuration tree.&lt;br /&gt;
 &lt;br /&gt;
 // Add a new folder-like node called &amp;quot;Example&amp;quot;, and inside it another node&lt;br /&gt;
 // called &amp;quot;Page&amp;quot;. The position of a node is specified by a path string.&lt;br /&gt;
 // Each tree level is separated by slashes. There should be only two levels&lt;br /&gt;
 // below the standard &amp;quot;configuration&amp;quot; root element: configuration/x for inner&lt;br /&gt;
 // nodes and configuration/x/y for leaf nodes.&lt;br /&gt;
 &lt;br /&gt;
 new ox.Configuration.InnerNode(&amp;quot;configuration/example&amp;quot;, &amp;quot;Example&amp;quot;);&lt;br /&gt;
 var node = new ox.Configuration.LeafNode(&amp;quot;configuration/example/page&amp;quot;, &amp;quot;Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Connect the node to a new page. &lt;br /&gt;
 &lt;br /&gt;
 var page = new ox.Configuration.Page(node, &amp;quot;Example Configuration Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All data on the page is collected in a single data object. This object is&lt;br /&gt;
 // transmitted to and from the server in the methods load() and save() using&lt;br /&gt;
 // static methods of ox.JSON.&lt;br /&gt;
 // For save(), the parameter cont is a continuation function which must be&lt;br /&gt;
 // called after the data was saved successfully.&lt;br /&gt;
 &lt;br /&gt;
 page.save = function(data, cont) {&lt;br /&gt;
     ox.JSON.put(AjaxRoot + &amp;quot;/serverplugin?action=set&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         data, cont);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // The continuation function of load() expects the data object as parameter.&lt;br /&gt;
 // To extract the data object from the server reply, a new continuation function&lt;br /&gt;
 // is used.&lt;br /&gt;
 &lt;br /&gt;
 page.load = function(cont) {&lt;br /&gt;
     ox.JSON.get(AjaxRoot + &amp;quot;/serverplugin?action=get&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         function(reply) { cont(reply.data); });&lt;br /&gt;
 };&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Content is added to the page with the method addWidget().&lt;br /&gt;
 // Here, a static text is added at the top of the page.&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.Text(&amp;quot;Long explanation text&amp;quot;));&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Individual input widgets can be connected to fields in the data object by&lt;br /&gt;
 // specifying the field name as the second parameter to addWidget().&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.CheckBox(&amp;quot;CheckBox Label&amp;quot;), &amp;quot;fieldname&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Layout can be controlled by using container widgets.&lt;br /&gt;
 // Configuration pages currently support only the Group container, which adds&lt;br /&gt;
 // a header over its children.&lt;br /&gt;
 // Every group has its own data object, which becomes nested in the page&#039;s&lt;br /&gt;
 // data object.&lt;br /&gt;
 &lt;br /&gt;
 var group = new ox.Configuration.Group(&amp;quot;Group title&amp;quot;);&lt;br /&gt;
 page.addWidget(group, &amp;quot;subobject&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Adding widgets to a goup happens exactly like for a page, since both are&lt;br /&gt;
 // descendants of ox.UI.Container.&lt;br /&gt;
 &lt;br /&gt;
 var input = new ox.UI.Input(&amp;quot;Detail field&amp;quot;);&lt;br /&gt;
 group.addWidget(input, &amp;quot;input&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All input widgets have a default value which is used when the data object&lt;br /&gt;
 // does not contain the widget&#039;s field (e. g. on first login).&lt;br /&gt;
 &lt;br /&gt;
 input.default_value = &amp;quot;default&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // ox.UI.Selection has many descendants which implement the same thing:&lt;br /&gt;
 // A field which must contain one of several possible values.&lt;br /&gt;
 // The possible values are set with the method setEntries().&lt;br /&gt;
 &lt;br /&gt;
 var choice = new ox.UI.ComboBox(&amp;quot;Choice&amp;quot;);&lt;br /&gt;
 group.addWidget(choice, &amp;quot;choice&amp;quot;);&lt;br /&gt;
 choice.setEntries([0, 1, Infinity], [&amp;quot;Zero&amp;quot;, &amp;quot;One&amp;quot;, &amp;quot;Infinity&amp;quot;]);&lt;br /&gt;
&lt;br /&gt;
== Customized new buttons in the panel ==&lt;br /&gt;
&lt;br /&gt;
This example adds a new area to the contacts pannel called &amp;quot;SMS&amp;quot;. The area then&lt;br /&gt;
has two buttons &amp;quot;Display&amp;quot; and &amp;quot;Send&amp;quot;. The &amp;quot;Display&amp;quot; button is active if one ore &lt;br /&gt;
multiple contacts are selected and fires a js alert for each of them when being &lt;br /&gt;
clicked. The Button &amp;quot;SMS&amp;quot; is only active when one single contacts is active&lt;br /&gt;
and has a business telephone number stored in it. On click a js alert is &lt;br /&gt;
executed and the telephone number is displayed.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Viktor&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 //create a new menu Object for the panel and define the unique id (id1 here)&lt;br /&gt;
 var contextmenu = MenuNodes.createSmallButtonContext(&amp;quot;id1&amp;quot;, &amp;quot;SMS&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 /**&lt;br /&gt;
  * Add menu Entries to the new generated panel object and define the icons&lt;br /&gt;
  * as well as the to be called functions. The identifiers must be unique &lt;br /&gt;
  * all over the complete js code (button1 and button2) in this example&lt;br /&gt;
  */&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button1&amp;quot;, &amp;quot;Display&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click1);&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button2&amp;quot;, &amp;quot;Send&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click2);&lt;br /&gt;
 /* The pannel object gets the id 20 and gets displayed in the fixed area&lt;br /&gt;
  * possible areas are FIXED and DYNAMIC the id controls the order in the areas&lt;br /&gt;
  */ &lt;br /&gt;
 addMenuNode(contextmenu.node, MenuNodes.FIXED, 20);&lt;br /&gt;
 &lt;br /&gt;
 //Following makes the new pannel options dynamic active/inactive&lt;br /&gt;
 changeDisplay(&amp;quot;contacts&amp;quot;, &amp;quot;id1&amp;quot;);&lt;br /&gt;
 menuarrows[&amp;quot;contacts&amp;quot;] = {};&lt;br /&gt;
 function changeplugin() {&lt;br /&gt;
     menuglobalzaehler = 0;&lt;br /&gt;
     menuarrows[&amp;quot;contacts&amp;quot;][&amp;quot;id1&amp;quot;] = new Array();&lt;br /&gt;
 //menucountselected here holds the amount of select items&lt;br /&gt;
     menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;, menucountselected &amp;gt;= 1,&lt;br /&gt;
 &amp;quot;button1&amp;quot;);&lt;br /&gt;
 // following an example how to get data out of the GUI internal cache. button2&lt;br /&gt;
 // is only active when a contact which as a business tel number is selected.&lt;br /&gt;
   if (activemodule == &amp;quot;contacts&amp;quot;) {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, function(data) {&lt;br /&gt;
             menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;,&lt;br /&gt;
                 menucountselected == 1 &amp;amp;&amp;amp;&lt;br /&gt;
 data.objects[0].telephone_business1,&lt;br /&gt;
                 &amp;quot;button2&amp;quot;);&lt;br /&gt;
         });&lt;br /&gt;
    }&lt;br /&gt;
 }&lt;br /&gt;
 register(&amp;quot;OX_SELECTED_ITEMS_CHANGED&amp;quot;, changeplugin); &lt;br /&gt;
 &lt;br /&gt;
 //now the called functions for the buttons follow&lt;br /&gt;
 function click1() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;id&amp;quot;, &amp;quot;folder_id&amp;quot;, &amp;quot;last_name&amp;quot;]&lt;br /&gt;
     }, null, display);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function click2() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, call);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function display(data) {&lt;br /&gt;
     for (var i = 0; i &amp;lt; menucountselected; i++)&lt;br /&gt;
         alert(data.objects[i].last_name);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function call(data) {&lt;br /&gt;
      alert(&amp;quot;Now, a SMS to &amp;quot; + data.objects[0].telephone_business1 + &lt;br /&gt;
             &amp;quot; could have been sent&amp;quot;);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
== Customizing the Help, Logout, examples UWA link, Session Expired and Direct Link locations / URLs ==&lt;br /&gt;
&lt;br /&gt;
If you need to change or customize the Help, Logout, Session Expired or Direct Link locations / URLs you can use the following variables and parameters. You can set them anywhere within your plugin. If not set, the system defaults will be used. Don&#039;t use the expression &#039;var&#039; as these are public available.&lt;br /&gt;
&lt;br /&gt;
 // the base path for the help pages&lt;br /&gt;
 help_location = &amp;quot;[protocol]://[hostname][path]/help/[language{1}]/&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url after logout&lt;br /&gt;
 logout_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url if the session expires&lt;br /&gt;
 sessionExpired_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the direct link url, used in the infostore detail views and the new e-mail window&lt;br /&gt;
 // note: do not remove or modify the part &amp;quot;#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;, otherwise direct links won&#039;t work anymore&lt;br /&gt;
 directLink_location = &amp;quot;[protocol]://[hostname][path]#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // example for the UWA link from the UWA-Module settings page&lt;br /&gt;
 // The text between %s%s gets shown as href for the given link&lt;br /&gt;
 uwaLink.text = &amp;quot;Please have a look at the %sInteresting UWA modules%s page. It shows a list of widgets and their associated data.&amp;quot;&lt;br /&gt;
 uwaLink.link = &amp;quot;http://www.open-xchange.com/index.php?id=361&amp;amp;L=[language{0}]&amp;quot;&lt;br /&gt;
&lt;br /&gt;
As you can see you can use place holders, similar to other programming languages. These place holders will get parsed and replaced by the OX application. Following a short description of some of them:&lt;br /&gt;
&lt;br /&gt;
 [protocol]      = the current used protocol - e.g. http or https&lt;br /&gt;
 [hostname]      = the hostname - e.g www.myox.de&lt;br /&gt;
 [path]          = the path (if any) behind the hostname - e.g. /ox6/ - or empty if not used&lt;br /&gt;
 [file]          = the file parameter (if any) - e.g. ox.html&lt;br /&gt;
 [language{0|1}] = the users language - e.g. de_DE, where {0} is the language iso code and {1} the country iso code&lt;br /&gt;
 [context_id]    = the users context id&lt;br /&gt;
 [timezone]      = the users timezone - e.g. Europe/Berlin&lt;br /&gt;
&lt;br /&gt;
A full set of available parameter will follow soon.&lt;br /&gt;
Note: The parameter [module], [folder] and [object_id] are only available at the directLink and can&#039;t be used anywhere else!&lt;br /&gt;
&lt;br /&gt;
= Help Menu =&lt;br /&gt;
&lt;br /&gt;
It is possible to add entries to the pop-up menu of the help button in the top right corner. Following is a simple example which opens a language-specific help page:&lt;br /&gt;
&lt;br /&gt;
 var label = { de_DE: &amp;quot;Hilfe&amp;quot;, en_US: &amp;quot;Help&amp;quot;, fr_FR: &amp;quot;Aide&amp;quot; };&lt;br /&gt;
 HelpMenu.addText(label[config.language || &amp;quot;en_US&amp;quot;], displayLink);&lt;br /&gt;
 &lt;br /&gt;
 function displayLink() {&lt;br /&gt;
         open(&amp;quot;/help/&amp;quot; + config.language);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
The manual handling of the label is required until proper support for plug-in internationalization is implemented.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=2794</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=2794"/>
		<updated>2008-12-19T15:06:21Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: added fowarded flag&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
Some error message contain data sizes which must be expressed in Bytes or Kilobytes etc., depending on the actual value. Since the unit must be translated, this conversion is performed by the client. Unfortunately, standard printf()-style formatting does not have a specifier for this kind of translation. Therefore, the conversion specification for sizes is the same as for normal strings, and the client has to determine which parameters to translate based on the error code. The current error codes and the corresponding size parameters are listed in [[#DataSizeParameters | Data size parameters]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSizeParameters&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data size parameters&lt;br /&gt;
! Error code !! Parameter indices&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0006   || 1&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0020   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
| CON-0101   || 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| FLS-0003   || 1, 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0065   || 1, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0066   || 1&lt;br /&gt;
|-&lt;br /&gt;
| NON-0005   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
=== Common object data ===&lt;br /&gt;
&lt;br /&gt;
This table contains common fields which apply for any module&#039;s data type and is referenced throughout this document whenever a module&#039;s data type is described.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100  || categories     || Array  || Each element is a string, naming a category. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101  || private_flag     || Boolean  || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 103  || number_of_links     || Number  || Number of links.&lt;br /&gt;
|-&lt;br /&gt;
| 104  || number_of_attachments     || Number  || Number of attachments &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – A string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;fastgui&amp;lt;/code&amp;gt; - A string containing GUI-specific settings. This is a JSON object that must be kept small for performance.&lt;br /&gt;
** &amp;lt;code&amp;gt;context_id&amp;lt;/code&amp;gt; - the unique identifier of the context (read-only, added 2008-01-28).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments (deprecated since 2008-12-11)&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks (deprecated since 2008-12-11)&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;maxUploadIdleTimeout&amp;lt;/code&amp;gt; - Timeout after that idle uploads are deleted.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with.  (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt; (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not. (deprecated 2008-04-29)&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;autoSearch&amp;lt;/code&amp;gt; - If a search for all users, groups and resources when participant selection dialog is opened. (read-only, added 2008-10-09/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;maximumNumberParticipants&amp;lt;/code&amp;gt; – Defines the maximum number of participants for appointments and tasks. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
*** &amp;lt;code&amp;gt;showDialog&amp;lt;/code&amp;gt; – Enables participant selection dialog for appointments and tasks. (read-only, added 2008-04-30/SP4)&lt;br /&gt;
** &amp;lt;code&amp;gt;availableModules&amp;lt;/code&amp;gt; – Contains a JSON array listing all enabled modules for a user. GUI loads Plugins through this list. To get your plugin listed here, create a subtree below &amp;lt;code&amp;gt;modules/&amp;lt;/code&amp;gt; without a &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; subelement or with a subelement containing &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; (read-only, added 2008-02-25)&lt;br /&gt;
** &amp;lt;code&amp;gt;minimumSearchCharacters&amp;lt;/code&amp;gt; – Minimum number of characters a search pattern must have to prevent large responses and slow queries. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;portal&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for portal module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;appendmailtext&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;allowhtmlimages&amp;lt;/code&amp;gt; – Alters default setting whether external images contained in HTML content are allowed or not (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;colorquoted&amp;lt;/code&amp;gt; – color quoted lines (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;deletemail&amp;lt;/code&amp;gt; – delete emails or move to trash (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultFolder&amp;lt;/code&amp;gt;&lt;br /&gt;
***** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;forwardmessage&amp;lt;/code&amp;gt; – forward messages as inline or attachment (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for mail module&lt;br /&gt;
**** &amp;lt;code&amp;gt;inlineattachments&amp;lt;/code&amp;gt; – activate inlining of HTML attachments (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;linewrap&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – if mail module is enabled or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; – Spam Button should be displayed in GUI or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;phishingheaders&amp;lt;/code&amp;gt; – header(s) identifying phishing headers (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectFolder&amp;lt;/code&amp;gt; – contact folder id to save mail addresses from sent mails (added 2008-10-16)&lt;br /&gt;
**** &amp;lt;code&amp;gt;contactCollectEnabled&amp;lt;/code&amp;gt; – switch contact collection on/off (added 2008-10-16)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the calendar module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyNewModifiedDeleted&amp;lt;/code&amp;gt; receive mail notification for new, modified or deleted appointments (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsCreator&amp;lt;/code&amp;gt; receive mail notification for accepted or declined appointments created by the user (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsParticipant&amp;lt;/code&amp;gt; receive mail notification for accepted or declined appointments that the user participates (added 2008-12-11/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the contacts module&lt;br /&gt;
**** &amp;lt;code&amp;gt;mailAddressAutoSearch&amp;lt;/code&amp;gt; – Define if a search is triggered when the recipient selection dialog is opened or the folder is changed. (read-only, added 2008-10-20/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the tasks module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyNewModifiedDeleted&amp;lt;/code&amp;gt; receive mail notification for new, modified or deleted tasks (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsCreator&amp;lt;/code&amp;gt; receive mail notification for accepted or declined tasks created by the user (added 2008-12-11/SP5)&lt;br /&gt;
**** &amp;lt;code&amp;gt;notifyAcceptedDeclinedAsParticipant&amp;lt;/code&amp;gt; receive mail notification for accepted or declined taks that the user participates (added 2008-12-11/SP5)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the infostore module&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;interfaces&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; GUI settings for the folder tree&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.extras&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Extras link in the configuration (read only, added 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.passwordchange&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to change the Password within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.personaldata&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to edit personal contact information within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.group&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to edit groups and loads the corresponding Plug-In. (read only, added 2008-08-08)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.resource&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;enabled&amp;lt;/code&amp;gt; – Specifies whether the user is allowed to edit resources and loads the corresponding Plug-In. (read only, added 2008-08-08)&lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common folder data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 6 || last_modified_utc || Timestamp || Timestamp of the last modification. Note that the type is Timestamp, not Time. See [[#Date and time]] for details. (added 2008-10-17, with SP5, temporary workaround)&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder; e.g. &amp;quot;tasks&amp;quot;, &amp;quot;calendar&amp;quot;, &amp;quot;contacts&amp;quot;, &amp;quot;infostore&amp;quot;, or &amp;quot;mail&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| 306 || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 313 || capabilities || Number || Bit mask containing information about mail folder capabilites, as described in [[#Capabilities | capabilities]].&lt;br /&gt;
|-&lt;br /&gt;
| 314 || subscribed || Boolean || Indicates whether this folder should appear in folder tree or not.&lt;br /&gt;
|-&lt;br /&gt;
| 315 || subscr_subflds || Boolean || Indicates whether subfolders should appear in folder tree or not.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-6 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Capabilities&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Capabilities&lt;br /&gt;
! Bit  !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 0 || Mailing system supports permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Mailing system supports ordering mails by their thread reference.&lt;br /&gt;
|-&lt;br /&gt;
| 2 || Mailing system supports quota restrictions.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Mailing system supports sorting.&lt;br /&gt;
|-&lt;br /&gt;
| 4 || Mailing system supports folder subscription.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id is not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;folder_id&amp;lt;/code&amp;gt; – The parent folder of the newly created folder&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id should not be present.&lt;br /&gt;
&lt;br /&gt;
Provided that permission is granted to create a folder, its module is bound to the limitation, that the new folder&#039;s module must be equal to parent folder&#039;s module except that:&lt;br /&gt;
* Parent folder is one of the system folders &amp;lt;code&amp;gt;private&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;public&amp;lt;/code&amp;gt;, or &amp;lt;code&amp;gt;shared&amp;lt;/code&amp;gt;. Below these folders task, calendar, and contact modules are permitted.&lt;br /&gt;
* Parent folder&#039;s module is one of task, calendar, or contact. Below this kind of folders task, calendar, and contact modules are permitted.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number       || Specifies when to notify the participants as the number of minutes before the end of the task or before the start of the appointment.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Exclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#participantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|-&lt;br /&gt;
| 222 || occurences || Number || Specifies how often a recurrence should appear. May be present only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|-&lt;br /&gt;
| 5 || external user&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority || Number || 1 = LOW, 2 = MEDIUM, 3 = HIGH&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the task&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder Identifier through that the task is accessed. This is necessary for checking the permissions.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object with attributes described in [[#SearchTasks | Search tasks]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchTasks&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search tasks&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find tasks. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || (optional) Defines the folder to search for tasks in. If this is omitted in all task folders will be searched.&lt;br /&gt;
|-&lt;br /&gt;
| start || Date or Time || (optional) Inclusive start date for a time range the tasks should end in. If start is omitted end is ignored.&lt;br /&gt;
|-&lt;br /&gt;
| end || Date or Time || (optional) Exclusive end date for a time range the tasks should end in. If this parameter is omitted the time range has an open end.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with matching tasks. Tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home || String&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status || String&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children || String&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type  || String&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number || String&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business || String&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees || String&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume || String&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other || String&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1 || String&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01 || String&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02 || String&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03 || String&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04 || String&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05 || String&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06 || String&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07 || String&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08 || String&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09 || String&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10 || String&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11 || String&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12 || String&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13 || String&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14 || String&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15 || String&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16 || String&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17 || String&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18 || String&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19 || String&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20 || String&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]].&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distribution_list || Number&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links || Number&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || number_of_images || Number&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified || Date&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other || String&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as || String&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type || String&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist || Boolean&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address || Number&lt;br /&gt;
|-&lt;br /&gt;
| 606 ||                             || image1_url || String&lt;br /&gt;
|-&lt;br /&gt;
| 102 ||                             || color_label || Number&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid || Number&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with objects. Each object contains fields “id” and “folder” of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=listuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with id&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
Available with SP4&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the contact&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Get contact by user ID ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – User ID (not Object ID) of the requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. &lt;br /&gt;
&lt;br /&gt;
Available with SP4 package.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder identifier through that the contact is accessed. This is necessary for checking the permissions.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given company.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which start on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which end before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client. &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_position&amp;lt;/code&amp;gt; (optional) – Recurrence Position requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the appointment&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: If the appointment was created successfully, an object with the attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created appointment. If the appointment could not be created due to conflicts, the response body is an object with the field &amp;lt;code&amp;gt;conflicts&amp;lt;/code&amp;gt;, which is an array of appointment objects which caused the conflict. Each appointment object which represents a resource conflict contains an additional field &amp;lt;code&amp;gt;hard_conflict&amp;lt;/code&amp;gt; with the Boolean value true. If the user does not have read access to a conflicting appointment, only the fields &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;start_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;end_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;shown_as&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; are present and the field &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; contains only the participants which caused the conflict.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find appointments. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search appointments with the given starting letter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get new appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/appointments?action=newappointments&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;limit&amp;lt;/code&amp;gt; (optional) – limits the number of returned object to the given value.&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|-&lt;br /&gt;
| 256 || forwarded&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Array  || An array with user-defined flags as strings.&lt;br /&gt;
|-&lt;br /&gt;
|     || headers                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested mails.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail as described in [[#UpdateMail | Update mail]].&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the updated mail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UpdateMail&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Update mail&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| color_label || Number || The color number between 1 and 10.&lt;br /&gt;
|-&lt;br /&gt;
| flags || Number || A set of flags to add or remove.&lt;br /&gt;
|-&lt;br /&gt;
| value || Boolean || &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; to add the flags specified by &amp;lt;code&amp;gt;flags&amp;lt;/code&amp;gt; (logical OR), &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt; to remove them (logical AND with the inverted value).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the mail&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) – 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowimages&amp;lt;/code&amp;gt; (optional - available with SP4) - 0 forces the server to copy (and then emtpy) any image src attribute to a new oxsrc attribute within html parts. 0 to let the response contain the original image src attributes. Can be used to prevent loading external linked images (spam privacy protection). &#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
* &amp;lt;code&amp;gt;unseen&amp;lt;/code&amp;gt; (optional) – &amp;quot;1&amp;quot; or &amp;quot;true&amp;quot; to leave an unseen mail as unseen although its content is requested&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment &#039;&#039;&#039;OR&#039;&#039;&#039;&lt;br /&gt;
* &amp;lt;code&amp;gt;cid&amp;lt;/code&amp;gt; – Value of header &#039;Content-ID&#039; of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
* &amp;lt;code&amp;gt;filter&amp;lt;/code&amp;gt; (optional) – 1 to apply HTML white-list filter rules if and only if requested attachment is of MIME type &amp;lt;code&amp;gt;text/htm*&amp;lt;/code&amp;gt; &#039;&#039;&#039;AND&#039;&#039;&#039; parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send/Save mail as MIME data block (RFC822) (Available soon!) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; - A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; - Set to &amp;quot;1&amp;quot; to accept mail message as MIME data block.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) - In case the mail should not be sent out, but saved in a specific folder, the &amp;quot;folder&amp;quot; paramter can be used. If the mail should be sent out to the recipient, the &amp;quot;folder&amp;quot; parameter must not be included and the mail is stored in the folder &amp;quot;Sent Items&amp;quot;. Example &amp;quot;folder=default.INBOX/Testfolder&amp;quot;&lt;br /&gt;
* &amp;lt;code&amp;gt;flags&amp;lt;/code&amp;gt; (optional) - In case the mail should be stored with status &amp;quot;read&amp;quot; (e.g. mail has been read already in the client inbox), the parameter &amp;quot;flags&amp;quot; has to be included. If no &amp;quot;folder&amp;quot;  parameter is specified, this parameter must not be included. For infos about mail flags see [[#DetailedMailData | Detailed mail data]] spec.&lt;br /&gt;
 &lt;br /&gt;
Request Body: The MIME Data Block&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created/moved mail.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;b&amp;gt;INFO: This feature is currently not included in the latest Packages and will be available soon&amp;lt;/b&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Clear mail folder(s) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=clear&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with IDs of the mail folders to clear&lt;br /&gt;
&lt;br /&gt;
Response: An array with IDs of mail folder that could not be cleared; meaning the response body is an empty JSON array if everything went well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: A group object as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
=== List groups ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with group identifiers.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
=== Search for groups ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#GroupSearch | Group search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array of group objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group data&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| name         || String || Name with character restrictions&lt;br /&gt;
|-&lt;br /&gt;
| members       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Create a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created group.&lt;br /&gt;
&lt;br /&gt;
=== Delete a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the group to delete.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id” containing the unique identifier of the group.&lt;br /&gt;
&lt;br /&gt;
Response: An empty json array if the group was deleted successfully.&lt;br /&gt;
&lt;br /&gt;
=== Change a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the group to update.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Time stamp of the group to update. If the group was modified after the specified time stamp, then the update must fail. &lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. Only modified fields are present and the field id is omitted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== List resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Request body: An array with resources ids.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise. . Note: This is not writeable&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label     || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|-&lt;br /&gt;
| 711 || number_of_versions || Number || The number of all versions of the infoitem. Note: This is not writeable.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the infoitem&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: Rhe raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of infoitems which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| servertime || Time || The time on the server&lt;br /&gt;
|-&lt;br /&gt;
| user_id || Number || The ID of the user.&lt;br /&gt;
|-&lt;br /&gt;
| last_modified || Time || The last modification timestamp of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| recurrence_position || Number || The recurrence position for series appointments or 0 if no series&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || The ID of the folder through that the object can be read&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Reminder===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/reminder?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
Response body: An JSON array with the id that was not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: A &amp;quot;multipart/form-data&amp;quot; encoded .CSV file. The field name for the file is &amp;quot;file&amp;quot;. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered, and warnings (under the key &amp;quot;warnings&amp;quot;) containing an Array of objects with the warning data, containing all customary error fields.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mailfilter&amp;quot; ==&lt;br /&gt;
The module mailfilter descriptes how to add, update or delete mail filter rules or to check which actions are supported by the underlying system.&lt;br /&gt;
&lt;br /&gt;
A detailed description can be found here [[ HTTP_API_MailFilter | Mail Filter HTTP API]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;ajax file upload&amp;quot; ==&lt;br /&gt;
This module offers to store files in server&#039;s dedicated download directory for a configureable amount of time. The files are then accessible for further operations like inline images in (html) mails&lt;br /&gt;
&lt;br /&gt;
=== Uploading a file ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/file?action=new&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The module for which the file is uploaded to determine proper upload quota constraints (e.g. &amp;quot;mail&amp;quot;, &amp;quot;infostore&amp;quot;, etc.).&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; – The file type filter to define which file types are allowed during upload. Currently supported filters are: &amp;lt;code&amp;gt;file=all, text=text/*, media=image OR audio OR video, image=image/*, audio=audio/*, video=video/*, application=application/*&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A common POST request body of MIME type &amp;quot;multipart/*&amp;quot; which holds the file(s) to upload&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of the uploaded files. The files are accessible through the returned IDs for future use.&lt;br /&gt;
&lt;br /&gt;
=== Updating a file&#039;s last access timestamp (keep alive) ===&lt;br /&gt;
By updating the last access timestamp it&#039;s prevented from being deleted from both session and disk storage.&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=keepalive&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file whose timestamp should be updated&lt;br /&gt;
&lt;br /&gt;
Response: The string &amp;quot;null&amp;quot; in response&#039;s data element&lt;br /&gt;
&lt;br /&gt;
=== Requesting a formerly uploaded file ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested file is directly written into output stream&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;image&amp;quot; ==&lt;br /&gt;
This module allows to download images from Open-Xchange server without providing a session ID in request&#039;s URL parameters.&lt;br /&gt;
&lt;br /&gt;
=== Requesting an image ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/image&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;uid&amp;lt;/code&amp;gt; – The unique ID referring to the desired image&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested image is directly written into output stream&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=2367</id>
		<title>OX6:Gui Plugin Development</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Gui_Plugin_Development&amp;diff=2367"/>
		<updated>2008-09-05T17:37:27Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: Added description of changing similar URLs&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Introduction =&lt;br /&gt;
&lt;br /&gt;
With Open-Xchange SP4 you will be able to add you own JavaScript Code for existing events. The follwoing examples show how you can add your own About page, your own Window Title, and your own message for not activated/bought components of OX (Upsell Message).&lt;br /&gt;
&lt;br /&gt;
= Setup and file description =&lt;br /&gt;
&lt;br /&gt;
Two things have to be done to register your own JavaScript Code within the server:&lt;br /&gt;
&lt;br /&gt;
1. You have to create the property file in /opt/open-xchange/etc/groupware/settings/, for example myjscode.properties. The file should have the following value:&lt;br /&gt;
&lt;br /&gt;
 modules/$NAME/enabled=true&lt;br /&gt;
&lt;br /&gt;
$NAME is equal to the filename of the property file, in our case it would be:&lt;br /&gt;
&lt;br /&gt;
 modules/myjscode/enabled=true&lt;br /&gt;
&lt;br /&gt;
This will enable the JS Code located in $WEBSRV/ox6/plugins/$NAME (for example /var/www/ox6/plugins/myjscode/).&lt;br /&gt;
&lt;br /&gt;
2. Next we have to create the folder that we had configured, in our example we would have to create:&lt;br /&gt;
&lt;br /&gt;
 mkdir /var/www/ox6/plugins/myjscode/&lt;br /&gt;
&lt;br /&gt;
The server now will have a look at this directory and searches for the file register.js in this directory. All your JS enhancements should be written to that file.&lt;br /&gt;
&lt;br /&gt;
3. Afterwards you have to restart the groupware server with:&lt;br /&gt;
&lt;br /&gt;
 /etc/init.d/open-xchange-groupware restart&lt;br /&gt;
&lt;br /&gt;
= Examples =&lt;br /&gt;
&lt;br /&gt;
== Customized About page ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/productinfo.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/productinfo/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/productinfo/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.vendor_address = &amp;quot;&amp;lt;b&amp;gt;Open-Xchange GmbH&amp;lt;/b&amp;gt;\nMartinstrasse 41\n57462 Olpe\nE-Mail: info@open-xchange.com\n&amp;lt;a href=\&amp;quot;http://www.open-xchange.com\&amp;quot; target=\&amp;quot;_blank\&amp;quot;&amp;gt;www.open-xchange.com&amp;lt;/a&amp;gt;&amp;quot;&lt;br /&gt;
&lt;br /&gt;
== Customized Window Title ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/windowtitle.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com &lt;br /&gt;
 # &lt;br /&gt;
 # @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 modules/windowtitle/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/windowtitle/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 oxProductInfo.product_name = &amp;quot;This is the fabulous Open-Xchange Server&amp;quot;; &lt;br /&gt;
 &lt;br /&gt;
 try {&lt;br /&gt;
     window.document.title = oxProductInfo.product_name;&lt;br /&gt;
 } catch (e) { }&lt;br /&gt;
&lt;br /&gt;
== Customized Upsell Message ==&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/upsell.properties:&lt;br /&gt;
&lt;br /&gt;
 # This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
 # under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
 # by the Free Software Foundation.&lt;br /&gt;
 #&lt;br /&gt;
 # Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
 # Mail: info@open-xchange.com&lt;br /&gt;
 # &lt;br /&gt;
 # Author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
 &lt;br /&gt;
 # The following property enables the Upsell-Layer Plugin for the OX6 AJAX GUI&lt;br /&gt;
 modules/upsell/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/upsell/register.js:&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Stefan Preuss &amp;lt;stefan.preuss@open-xchange.com&amp;gt;&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 /*&lt;br /&gt;
  * Example for an Upsell-Layer&lt;br /&gt;
  * The OX GUI triggers a special event if a user clicks on disabled features.&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
  /*&lt;br /&gt;
   * Register to Upsell-Event&lt;br /&gt;
   */&lt;br /&gt;
  register(&amp;quot;Feature_Not_Available&amp;quot;, showUpsellLayer);&lt;br /&gt;
 &lt;br /&gt;
  /**&lt;br /&gt;
   * Function to display an Upsell-Alert dialog&lt;br /&gt;
   * @param feature String (optional) - Module description&lt;br /&gt;
   * @param win Window (optional) - Only needed/given if we trigger the event from the new object windows &lt;br /&gt;
   */&lt;br /&gt;
  function showUpsellLayer(feature, win) {&lt;br /&gt;
     // setting corewindow to default if win is not defined&lt;br /&gt;
     win = win || corewindow; &lt;br /&gt;
     &lt;br /&gt;
     /*&lt;br /&gt;
      * Build up the dialog content&lt;br /&gt;
      * Note: You can also use myDiv.innerHTML!&lt;br /&gt;
      */&lt;br /&gt;
     var myDiv = newnode(&amp;quot;div&amp;quot;,{ textAlign: &amp;quot;center&amp;quot;, padding: &amp;quot;10px&amp;quot; }, 0, [ &lt;br /&gt;
             newnode(&amp;quot;div&amp;quot;, 0, { background: &amp;quot;url(http://www.example.com/img/header/logo.gif)&amp;quot; }, 0,&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;span&amp;quot;, 0, 0, [ &lt;br /&gt;
                 document.createTextNode(&amp;quot;Diese Funktion ist nur in Open-Xchange Premium verfügbar!&amp;quot;) ],&lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Weitere Information zu Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document),&lt;br /&gt;
             newnode(&amp;quot;input&amp;quot;, { marginTop: &amp;quot;10px&amp;quot;}, &lt;br /&gt;
                 { type: &amp;quot;button&amp;quot;, onclick: function() { window.open(&amp;quot;http://www.open-xchange.com&amp;quot;) },&lt;br /&gt;
                   value: &amp;quot;Paket-Upgrade auf Open-Xchange Premium!&amp;quot; }, 0, &lt;br /&gt;
                 win.document) &lt;br /&gt;
         ], win.document);&lt;br /&gt;
     &lt;br /&gt;
     // calling the newAlert function to open the dialog at the given window&lt;br /&gt;
     win.newAlert(&amp;quot;Hinweis &amp;quot; + feature, null, AlertPopup.close, myDiv);&lt;br /&gt;
  }&lt;br /&gt;
  &lt;br /&gt;
  /*&lt;br /&gt;
   * Comment this out to change the grayed out module images in the upper left corner!&lt;br /&gt;
   */&lt;br /&gt;
  /*&lt;br /&gt;
  if (!document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src.match(/mod_portal_sel.gif$/)) {&lt;br /&gt;
     document.getElementById(&amp;quot;sp_c_portal&amp;quot;).src = getFullImgSrc(&amp;quot;img/portal/mod_portal.gif&amp;quot;);&lt;br /&gt;
  }&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_calendar&amp;quot;).src = getFullImgSrc(&amp;quot;img/calendar/mod_calendar.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_tasks&amp;quot;).src = getFullImgSrc(&amp;quot;img/tasks/mod_tasks.gif&amp;quot;);&lt;br /&gt;
  document.getElementById(&amp;quot;sp_c_infostore&amp;quot;).src = getFullImgSrc(&amp;quot;img/infostore/mod_infostore.gif&amp;quot;);&lt;br /&gt;
  */&lt;br /&gt;
&lt;br /&gt;
== Customized / Extended configuration tree ==&lt;br /&gt;
&lt;br /&gt;
In order to extend your configuration frontend you will have to make more changes then overwrite existing JS methods. You have to implement your own configuration site. Below, you will find the JS API Doc that will show you how to build external contents into the configuration frontend:&lt;br /&gt;
&lt;br /&gt;
[[Main_Page#Interfaces|JavaScript API for extending the configuration frontend]]&lt;br /&gt;
&lt;br /&gt;
/opt/open-xchange/etc/groupware/settings/extendconfiguration.properties:&lt;br /&gt;
&lt;br /&gt;
 modules/extendconfiguration/enabled=true&lt;br /&gt;
&lt;br /&gt;
/var/www/ox6/plugins/extendconfiguration/register.js:&lt;br /&gt;
&lt;br /&gt;
 // Extending the configuration tree.&lt;br /&gt;
 &lt;br /&gt;
 // Add a new folder-like node called &amp;quot;Example&amp;quot;, and inside it another node&lt;br /&gt;
 // called &amp;quot;Page&amp;quot;. The position of a node is specified by a path string.&lt;br /&gt;
 // Each tree level is separated by slashes. There should be only two levels&lt;br /&gt;
 // below the standard &amp;quot;configuration&amp;quot; root element: configuration/x for inner&lt;br /&gt;
 // nodes and configuration/x/y for leaf nodes.&lt;br /&gt;
 &lt;br /&gt;
 new ox.Configuration.InnerNode(&amp;quot;configuration/example&amp;quot;, &amp;quot;Example&amp;quot;);&lt;br /&gt;
 var node = new ox.Configuration.LeafNode(&amp;quot;configuration/example/page&amp;quot;, &amp;quot;Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Connect the node to a new page. &lt;br /&gt;
 &lt;br /&gt;
 var page = new ox.Configuration.Page(node, &amp;quot;Example Configuration Page&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All data on the page is collected in a single data object. This object is&lt;br /&gt;
 // transmitted to and from the server in the methods load() and save() using&lt;br /&gt;
 // static methods of ox.JSON.&lt;br /&gt;
 // For save(), the parameter cont is a continuation function which must be&lt;br /&gt;
 // called after the data was saved successfully.&lt;br /&gt;
 &lt;br /&gt;
 page.save = function(data, cont) {&lt;br /&gt;
     ox.JSON.put(AjaxRoot + &amp;quot;/serverplugin?action=set&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         data, cont);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // The continuation function of load() expects the data object as parameter.&lt;br /&gt;
 // To extract the data object from the server reply, a new continuation function&lt;br /&gt;
 // is used.&lt;br /&gt;
 &lt;br /&gt;
 page.load = function(cont) {&lt;br /&gt;
     ox.JSON.get(AjaxRoot + &amp;quot;/serverplugin?action=get&amp;amp;session=&amp;quot; + session,&lt;br /&gt;
         function(reply) { cont(reply.data); });&lt;br /&gt;
 };&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Content is added to the page with the method addWidget().&lt;br /&gt;
 // Here, a static text is added at the top of the page.&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.Text(&amp;quot;Long explanation text&amp;quot;));&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Individual input widgets can be connected to fields in the data object by&lt;br /&gt;
 // specifying the field name as the second parameter to addWidget().&lt;br /&gt;
 &lt;br /&gt;
 page.addWidget(new ox.UI.CheckBox(&amp;quot;CheckBox Label&amp;quot;), &amp;quot;fieldname&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Layout can be controlled by using container widgets.&lt;br /&gt;
 // Configuration pages currently support only the Group container, which adds&lt;br /&gt;
 // a header over its children.&lt;br /&gt;
 // Every group has its own data object, which becomes nested in the page&#039;s&lt;br /&gt;
 // data object.&lt;br /&gt;
 &lt;br /&gt;
 var group = new ox.Configuration.Group(&amp;quot;Group title&amp;quot;);&lt;br /&gt;
 page.addWidget(group, &amp;quot;subobject&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // Adding widgets to a goup happens exactly like for a page, since both are&lt;br /&gt;
 // descendants of ox.UI.Container.&lt;br /&gt;
 &lt;br /&gt;
 var input = new ox.UI.Input(&amp;quot;Detail field&amp;quot;);&lt;br /&gt;
 group.addWidget(input, &amp;quot;input&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // All input widgets have a default value which is used when the data object&lt;br /&gt;
 // does not contain the widget&#039;s field (e. g. on first login).&lt;br /&gt;
 &lt;br /&gt;
 input.default_value = &amp;quot;default&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
 &lt;br /&gt;
 // ox.UI.Selection has many descendants which implement the same thing:&lt;br /&gt;
 // A field which must contain one of several possible values.&lt;br /&gt;
 // The possible values are set with the method setEntries().&lt;br /&gt;
 &lt;br /&gt;
 var choice = new ox.UI.ComboBox(&amp;quot;Choice&amp;quot;);&lt;br /&gt;
 group.addWidget(choice, &amp;quot;choice&amp;quot;);&lt;br /&gt;
 choice.setEntries([0, 1, Infinity], [&amp;quot;Zero&amp;quot;, &amp;quot;One&amp;quot;, &amp;quot;Infinity&amp;quot;]);&lt;br /&gt;
&lt;br /&gt;
== Customized new buttons in the panel ==&lt;br /&gt;
&lt;br /&gt;
This example adds a new area to the contacts pannel called &amp;quot;SMS&amp;quot;. The area then&lt;br /&gt;
has two buttons &amp;quot;Display&amp;quot; and &amp;quot;Send&amp;quot;. The &amp;quot;Display&amp;quot; button is active if one ore &lt;br /&gt;
multiple contacts are selected and fires a js alert for each of them when being &lt;br /&gt;
clicked. The Button &amp;quot;SMS&amp;quot; is only active when one single contacts is active&lt;br /&gt;
and has a business telephone number stored in it. On click a js alert is &lt;br /&gt;
executed and the telephone number is displayed.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
 /**&lt;br /&gt;
  *&lt;br /&gt;
  * This program is free software; you can redistribute it and/or modify it&lt;br /&gt;
  * under the terms of the GNU General Public License, Version 2 as published&lt;br /&gt;
  * by the Free Software Foundation.&lt;br /&gt;
  *&lt;br /&gt;
  * Copyright (C) 2004-2007 Open-Xchange, Inc.&lt;br /&gt;
  * Mail: info@open-xchange.com &lt;br /&gt;
  * &lt;br /&gt;
  * @author: Viktor&lt;br /&gt;
  *&lt;br /&gt;
  */&lt;br /&gt;
 &lt;br /&gt;
 //create a new menu Object for the panel and define the unique id (id1 here)&lt;br /&gt;
 var contextmenu = MenuNodes.createSmallButtonContext(&amp;quot;id1&amp;quot;, &amp;quot;SMS&amp;quot;);&lt;br /&gt;
 &lt;br /&gt;
 /**&lt;br /&gt;
  * Add menu Entries to the new generated panel object and define the icons&lt;br /&gt;
  * as well as the to be called functions. The identifiers must be unique &lt;br /&gt;
  * all over the complete js code (button1 and button2) in this example&lt;br /&gt;
  */&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button1&amp;quot;, &amp;quot;Display&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click1);&lt;br /&gt;
 MenuNodes.createSmallButton(contextmenu,&amp;quot;button2&amp;quot;, &amp;quot;Send&amp;quot;,&lt;br /&gt;
     &amp;quot;themes/default/img/menu/edit.gif&amp;quot;,&lt;br /&gt;
 &amp;quot;themes/default/img/menu/edit_d.gif&amp;quot;,&lt;br /&gt;
     click2);&lt;br /&gt;
 /* The pannel object gets the id 20 and gets displayed in the fixed area&lt;br /&gt;
  * possible areas are FIXED and DYNAMIC the id controls the order in the areas&lt;br /&gt;
  */ &lt;br /&gt;
 addMenuNode(contextmenu.node, MenuNodes.FIXED, 20);&lt;br /&gt;
 &lt;br /&gt;
 //Following makes the new pannel options dynamic active/inactive&lt;br /&gt;
 changeDisplay(&amp;quot;contacts&amp;quot;, &amp;quot;id1&amp;quot;);&lt;br /&gt;
 menuarrows[&amp;quot;contacts&amp;quot;] = {};&lt;br /&gt;
 function changeplugin() {&lt;br /&gt;
     menuglobalzaehler = 0;&lt;br /&gt;
     menuarrows[&amp;quot;contacts&amp;quot;][&amp;quot;id1&amp;quot;] = new Array();&lt;br /&gt;
 //menucountselected here holds the amount of select items&lt;br /&gt;
     menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;, menucountselected &amp;gt;= 1,&lt;br /&gt;
 &amp;quot;button1&amp;quot;);&lt;br /&gt;
 // following an example how to get data out of the GUI internal cache. button2&lt;br /&gt;
 // is only active when a contact which as a business tel number is selected.&lt;br /&gt;
   if (activemodule == &amp;quot;contacts&amp;quot;) {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, function(data) {&lt;br /&gt;
             menu_display_contents(&amp;quot;contacts&amp;quot;,&amp;quot;id1&amp;quot;,&lt;br /&gt;
                 menucountselected == 1 &amp;amp;&amp;amp;&lt;br /&gt;
 data.objects[0].telephone_business1,&lt;br /&gt;
                 &amp;quot;button2&amp;quot;);&lt;br /&gt;
         });&lt;br /&gt;
    }&lt;br /&gt;
 }&lt;br /&gt;
 register(&amp;quot;OX_SELECTED_ITEMS_CHANGED&amp;quot;, changeplugin); &lt;br /&gt;
 &lt;br /&gt;
 //now the called functions for the buttons follow&lt;br /&gt;
 function click1() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;id&amp;quot;, &amp;quot;folder_id&amp;quot;, &amp;quot;last_name&amp;quot;]&lt;br /&gt;
     }, null, display);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function click2() {&lt;br /&gt;
     OXCache.newRequest(null, &amp;quot;contacts&amp;quot;, {&lt;br /&gt;
         objects: menuselectedobjects,&lt;br /&gt;
         columns: [&amp;quot;telephone_business1&amp;quot;]&lt;br /&gt;
     }, null, call);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function display(data) {&lt;br /&gt;
     for (var i = 0; i &amp;lt; menucountselected; i++)&lt;br /&gt;
         alert(data.objects[i].last_name);&lt;br /&gt;
 }&lt;br /&gt;
 &lt;br /&gt;
 function call(data) {&lt;br /&gt;
      alert(&amp;quot;Now, a SMS to &amp;quot; + data.objects[0].telephone_business1 + &lt;br /&gt;
             &amp;quot; could have been sent&amp;quot;);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
== Customizing the Help, Logout, Session Expired and Direct Link locations / URLs ==&lt;br /&gt;
&lt;br /&gt;
If you need to change or customize the Help, Logout, Session Expired or Direct Link locations / URLs you can use the following variables and parameters. You can set them anywhere within your plugin. If not set, the system defaults will be used. Don&#039;t use the expression &#039;var&#039; as these are public available.&lt;br /&gt;
&lt;br /&gt;
 // the base path for the help pages&lt;br /&gt;
 help_location = &amp;quot;[protocol]://[hostname][path]/help/[language{1}]/&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url after logout&lt;br /&gt;
 logout_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the redirect url if the session expires&lt;br /&gt;
 sessionExpired_location = &amp;quot;[protocol]://[hostname][path]&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
 // the direct link url, used in the infostore detail views and the new e-mail window&lt;br /&gt;
 // note: do not remove or modify the part &amp;quot;#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;, otherwise direct links won&#039;t work anymore&lt;br /&gt;
 directLink_location = &amp;quot;[protocol]://[hostname][path]#m=[module]&amp;amp;f=[folder]&amp;amp;i=[object_id]&amp;quot;;&lt;br /&gt;
 &lt;br /&gt;
As you can see you can use place holders, similar to other programming languages. These place holders will get parsed and replaced by the OX application. Following a short description of some of them:&lt;br /&gt;
&lt;br /&gt;
 [protocol]      = the current used protocol - e.g. http or https&lt;br /&gt;
 [hostname]      = the hostname - e.g www.myox.de&lt;br /&gt;
 [path]          = the path (if any) behind the hostname - e.g. /ox6/ - or empty if not used&lt;br /&gt;
 [file]          = the file parameter (if any) - e.g. ox.html&lt;br /&gt;
 [language{0|1}] = the users language - e.g. de_DE, where {0} is the language iso code and {1} the country iso code&lt;br /&gt;
 [context_id]    = the users context id&lt;br /&gt;
 [timezone]      = the users timezone - e.g. Europe/Berlin&lt;br /&gt;
&lt;br /&gt;
A full set of available parameter will follow soon.&lt;br /&gt;
Note: The parameter [module], [folder] and [object_id] are only available at the directLink and can&#039;t be used anywhere else!&lt;br /&gt;
&lt;br /&gt;
= Help Menu =&lt;br /&gt;
&lt;br /&gt;
It is possible to add entries to the pop-up menu of the help button in the top right corner. Following is a simple example which opens a language-specific help page:&lt;br /&gt;
&lt;br /&gt;
 var label = { de_DE: &amp;quot;Hilfe&amp;quot;, en_US: &amp;quot;Help&amp;quot;, fr_FR: &amp;quot;Aide&amp;quot; };&lt;br /&gt;
 HelpMenu.addText(label[config.language || &amp;quot;en_US&amp;quot;], displayLink);&lt;br /&gt;
 &lt;br /&gt;
 function displayLink() {&lt;br /&gt;
         open(&amp;quot;/help/&amp;quot; + config.language);&lt;br /&gt;
 }&lt;br /&gt;
&lt;br /&gt;
The manual handling of the label is required until proper support for plug-in internationalization is implemented.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=2002</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=2002"/>
		<updated>2008-07-09T12:02:23Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: added new config options&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
Some error message contain data sizes which must be expressed in Bytes or Kilobytes etc., depending on the actual value. Since the unit must be translated, this conversion is performed by the client. Unfortunately, standard printf()-style formatting does not have a specifier for this kind of translation. Therefore, the conversion specification for sizes is the same as for normal strings, and the client has to determine which parameters to translate based on the error code. The current error codes and the corresponding size parameters are listed in [[#DataSizeParameters | Data size parameters]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSizeParameters&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data size parameters&lt;br /&gt;
! Error code !! Parameter indices&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0006   || 1&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0020   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
| CON-0101   || 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| FLS-0003   || 1, 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0065   || 1, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0066   || 1&lt;br /&gt;
|-&lt;br /&gt;
| NON-0005   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
=== Common object data ===&lt;br /&gt;
&lt;br /&gt;
This table contains common fields which apply for any module&#039;s data type and is referenced throughout this document whenever a module&#039;s data type is described.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100  || categories     || Array  || Each element is a string, naming a category. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101  || private_flag     || Boolean  || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 103  || number_of_links     || Number  || Number of links.&lt;br /&gt;
|-&lt;br /&gt;
| 104  || number_of_attachments     || Number  || Number of attachments &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – A string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;fastgui&amp;lt;/code&amp;gt; - A string containing GUI-specific settings. This is a JSON object that must be kept small for performance.&lt;br /&gt;
** &amp;lt;code&amp;gt;context_id&amp;lt;/code&amp;gt; - the unique identifier of the context (read-only, added 2008-01-28).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;maxUploadIdleTimeout&amp;lt;/code&amp;gt; - Timeout after that idle uploads are deleted.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with.  (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt; (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not. (deprecated 2008-04-29)&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
*** &amp;lt;code&amp;gt;showDialog&amp;lt;/code&amp;gt; – Enables participant selection dialog for appointments and tasks. (read-only, added 2008-04-30/SP4)&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;portal&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;appendmailtext&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;allowhtmlimages&amp;lt;/code&amp;gt; – Alters default setting whether external images contained in HTML content are allowed or not (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;colorquoted&amp;lt;/code&amp;gt; – color quoted lines (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;deletemail&amp;lt;/code&amp;gt; – delete emails or move to trash (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultFolder&amp;lt;/code&amp;gt;&lt;br /&gt;
***** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;forwardmessage&amp;lt;/code&amp;gt; – forward messages as inline or attachment (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inlineattachments&amp;lt;/code&amp;gt; – activate inlining of HTML attachments (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;linewrap&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – if mail module is enabled or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; – Spam Button should be displayed in GUI or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;phishingheaders&amp;lt;/code&amp;gt; – header(s) identifying phishing headers (added 2008-05-27)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;interfaces&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.extras&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Extras link in the configuration (read only, added 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.passwordchange&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to change the Password within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.user.personaldata&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Will load Plug-In which allows to edit personal contact information within the users configuration (read only, added 2008-07-09)&lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common folder data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder; e.g. &amp;quot;tasks&amp;quot;, &amp;quot;calendar&amp;quot;, &amp;quot;contacts&amp;quot;, &amp;quot;infostore&amp;quot;, or &amp;quot;mail&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
|     || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-61 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]].&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id is not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonFolderData | Common folder data]] and [[#DetailedFolderData | Detailed folder data]]. The field id should not be present.&lt;br /&gt;
&lt;br /&gt;
Provided that permission is granted to create a folder, its module is bound to the limitation, that the new folder&#039;s module must be equal to parent folder&#039;s module except that:&lt;br /&gt;
* Parent folder is one of the system folders &amp;lt;code&amp;gt;private&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;public&amp;lt;/code&amp;gt;, or &amp;lt;code&amp;gt;shared&amp;lt;/code&amp;gt;. Below these folders task, calendar, and contact modules are permitted.&lt;br /&gt;
* Parent folder&#039;s module is one of task, calendar, or contact. Below this kind of folders task, calendar, and contact modules are permitted.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number       || Specifies when to notify the participantsas the number of minutes before the end of the task or before the start of the appointment.&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Exclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#participantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|-&lt;br /&gt;
| 5 || external user&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the task&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]].&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 593 || Context id                  || context_id&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distribution_list&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || contains_image1&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as&lt;br /&gt;
|-&lt;br /&gt;
| 600 ||                             || attachment&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address&lt;br /&gt;
|-&lt;br /&gt;
| 102 ||                             || color_label&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with objects. Each object contains fields “id” and “folder” of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=listuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with id&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
Available with SP4&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the contact&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Get contact by user ID ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – User ID (not Object ID) of the requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. &lt;br /&gt;
&lt;br /&gt;
Available with SP4 package.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given company.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_position&amp;lt;/code&amp;gt; (optional) – Recurrence Position requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the appointment&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: If the appointment was created successfully, an object with the attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created appointment. If the appointment could not be created due to conflicts, the response body is an object with the field &amp;lt;code&amp;gt;conflicts&amp;lt;/code&amp;gt;, which is an array of appointment objects which caused the conflict. Each appointment object which represents a resource conflict contains an additional field &amp;lt;code&amp;gt;hard_conflict&amp;lt;/code&amp;gt; with the Boolean value true. If the user does not have read access to a conflicting appointment, only the fields &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;start_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;end_date&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;shown_as&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; are present and the field &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt; contains only the participants which caused the conflict.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested mails.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail. Supported fields by now are mail&#039;s color label (&amp;quot;color_label&amp;quot;) and its flags (&amp;quot;flags&amp;quot;) where additional field &amp;quot;value&amp;quot; defines if specified flags should be set or removed.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the updated mail&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the mail&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) – 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowimages&amp;lt;/code&amp;gt; (optional - available with SP4) - 0 forces the server to copy (and then emtpy) any image src attribute to a new oxsrc attribute within html parts. 0 to let the response contain the original image src attributes. Can be used to prevent loading external linked images (spam privacy protection). &#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Clear mail folder(s) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=clear&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with IDs of the mail folders to clear&lt;br /&gt;
&lt;br /&gt;
Response: An array with IDs of mail folder that could not be cleared; meaning the response body is an empty JSON array if everything went well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for groups ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#GroupSearch | Group search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupData | Group data]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| name         || String || Name with character restrictions&lt;br /&gt;
|-&lt;br /&gt;
| member       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Create a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: A json objekt with attribute &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; of the newly created group.&lt;br /&gt;
&lt;br /&gt;
=== Delete a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the group to delete.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id” containing the unique identifier of the group.&lt;br /&gt;
&lt;br /&gt;
Response: An empty json array if the group was deleted successfully.&lt;br /&gt;
&lt;br /&gt;
=== Change a group ===&lt;br /&gt;
&lt;br /&gt;
introduced 2008-06-12&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the group to update.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Time stamp of the group to update. If the group was modified after the specified time stamp, then the update must fail. &lt;br /&gt;
&lt;br /&gt;
Request body: Group object as described in [[#GroupData | Group data]]. Only modified fields are present and the field id is omitted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== List resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Request body: An array with resources ids.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label     || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the infoitem&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: Rhe raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of infoitems which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| servertime || Time || The time on the server&lt;br /&gt;
|-&lt;br /&gt;
| user_id || Number || The ID of the user.&lt;br /&gt;
|-&lt;br /&gt;
| last_modified || Time || The last modification timestamp of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| recurrence_position || Number || The recurrence position for series appointments or 0 if no series&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || The ID of the folder through that the object can be read&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Reminder===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/reminder?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
Response body: An JSON array with the id that was not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mailfilter&amp;quot; ==&lt;br /&gt;
The module mailfilter descriptes how to add, update or delete mail filter rules or to check which actions are supported by the underlying system.&lt;br /&gt;
&lt;br /&gt;
A detailed description can be found here [[ HTTP_API_MailFilter | Mail Filter HTTP API]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;ajax file upload&amp;quot; ==&lt;br /&gt;
This module offers to store files in server&#039;s dedicated download directory for a configureable amount of time. The files are then accessible for further operations like inline images in (html) mails&lt;br /&gt;
&lt;br /&gt;
=== Uploading a file ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/file?action=new&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The module for which the file is uploaded to determine proper upload quota constraints (e.g. &amp;quot;mail&amp;quot;, &amp;quot;infostore&amp;quot;, etc.).&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; – The file type filter to define which file types are allowed during upload. Currently supported filters are: &amp;lt;code&amp;gt;file=all, text=text/*, media=image OR audio OR video, image=image/*, audio=audio/*, video=video/*, application=application/*&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A common POST request body of MIME type &amp;quot;multipart/*&amp;quot; which holds the file(s) to upload&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of the uploaded files. The files are accessible through the returned IDs for future use.&lt;br /&gt;
&lt;br /&gt;
=== Updating a file&#039;s last access timestamp (keep alive) ===&lt;br /&gt;
By updating the last access timestamp it&#039;s prevented from being deleted from both session and disk storage.&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=keepalive&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file whose timestamp should be updated&lt;br /&gt;
&lt;br /&gt;
Response: The string &amp;quot;null&amp;quot; in response&#039;s data element&lt;br /&gt;
&lt;br /&gt;
=== Requesting a formerly uploaded file ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested file is directly written into output stream&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=1741</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=1741"/>
		<updated>2008-05-29T10:24:59Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: fixed typo in field description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
Some error message contain data sizes which must be expressed in Bytes or Kilobytes etc., depending on the actual value. Since the unit must be translated, this conversion is performed by the client. Unfortunately, standard printf()-style formatting does not have a specifier for this kind of translation. Therefore, the conversion specification for sizes is the same as for normal strings, and the client has to determine which parameters to translate based on the error code. The current error codes and the corresponding size parameters are listed in [[#DataSizeParameters | Data size parameters]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSizeParameters&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data size parameters&lt;br /&gt;
! Error code !! Parameter indices&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0006   || 1&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0020   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
| CON-0101   || 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| FLS-0003   || 1, 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0065   || 1, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0066   || 1&lt;br /&gt;
|-&lt;br /&gt;
| NON-0005   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – A string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;fastgui&amp;lt;/code&amp;gt; - A string containing GUI-specific settings. This is a JSON object that must be kept small for performance.&lt;br /&gt;
** &amp;lt;code&amp;gt;context_id&amp;lt;/code&amp;gt; - the unique identifier of the context (read-only, added 2008-01-28).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;maxUploadIdleTimeout&amp;lt;/code&amp;gt; - Timeout after that idle uploads are deleted.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with.  (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt; (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not. (deprecated 2008-04-29)&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
*** &amp;lt;code&amp;gt;showDialog&amp;lt;/code&amp;gt; – Enables participant selection dialog for appointments and tasks. (read-only, added 2008-04-30/SP4)&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;portal&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;appendmailtext&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;allowhtmlimages&amp;lt;/code&amp;gt; – Alters default setting whether external images contained in HTML content are allowed or not (added 2008-05-27)&lt;br /&gt;
**** &amp;lt;code&amp;gt;colorquoted&amp;lt;/code&amp;gt; – color quoted lines (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;deletemail&amp;lt;/code&amp;gt; – delete emails or move to trash (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultFolder&amp;lt;/code&amp;gt;&lt;br /&gt;
***** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;forwardmessage&amp;lt;/code&amp;gt; – forward messages as inline or attachment (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inlineattachments&amp;lt;/code&amp;gt; – activate inlining of HTML attachments (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;linewrap&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – if mail module is enabled or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; – Spam Button should be displayed in GUI or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;phishingheaders&amp;lt;/code&amp;gt; – header(s) identifying phishing headers (added 2008-05-27)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;interfaces&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.extras&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Extras link in the configuration (read only, added 2008-04-29)&lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100 || categories    || Array   || Each element is a string, naming a category. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101 || private_flag  || Boolean || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 103 || number_of_links  || Number || Number of links&lt;br /&gt;
|-&lt;br /&gt;
| 104 || number_of_attachments  || Number || Number of attachments&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
|     || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-61 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number       || Specifies when to notify the participantsas the number of minutes before the end of the task or before the start of the appointment.&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Exclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#participantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|-&lt;br /&gt;
| 5 || external user&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority&lt;br /&gt;
|-&lt;br /&gt;
| 310 || duration_type&lt;br /&gt;
|-&lt;br /&gt;
| 311 || type_of_costs&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the task&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]].&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 593 || Context id                  || context_id&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distribution_list&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || contains_image1&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as&lt;br /&gt;
|-&lt;br /&gt;
| 600 ||                             || attachment&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address&lt;br /&gt;
|-&lt;br /&gt;
| 102 ||                             || color_label&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with objects. Each object contains fields “id” and “folder” of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=listuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with id&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
Available with SP4&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the contact&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Get contact by user ID ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – User ID (not Object ID) of the requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. &lt;br /&gt;
&lt;br /&gt;
Available with SP4 package.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given company.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_position&amp;lt;/code&amp;gt; (optional) – Recurrence Position requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the appointment&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created appointment.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested mails.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail. Supported fields by now are mail&#039;s color label (&amp;quot;color_label&amp;quot;) and its flags (&amp;quot;flags&amp;quot;) where additional field &amp;quot;value&amp;quot; defines if specified flags should be set or removed.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the updated mail&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the mail&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) – 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowimages&amp;lt;/code&amp;gt; (optional - available with SP4) - 0 forces the server to copy (and then emtpy) any image src attribute to a new oxsrc attribute within html parts. 0 to let the response contain the original image src attributes. Can be used to prevent loading external linked images (spam privacy protection). &#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Clear mail folder(s) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=clear&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with IDs of the mail folders to clear&lt;br /&gt;
&lt;br /&gt;
Response: An array with IDs of mail folder that could not be cleared; meaning the response body is an empty JSON array if everything went well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for participants ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| member       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== List resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Request body: An array with resources ids.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label     || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the infoitem&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: Rhe raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of infoitems which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| servertime || Time || The time on the server&lt;br /&gt;
|-&lt;br /&gt;
| user_id || Number || The ID of the user.&lt;br /&gt;
|-&lt;br /&gt;
| last_modified || Time || The last modification timestamp of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| recurrence_position || Number || The recurrence position for series appointments or 0 if no series&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || The ID of the folder through that the object can be read&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Reminder===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/reminder?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
Response body: An JSON array with the id that was not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mailfilter&amp;quot; ==&lt;br /&gt;
The module mailfilter descriptes how to add, update or delete mail filter rules or to check which actions are supported by the underlying system.&lt;br /&gt;
&lt;br /&gt;
A detailed description can be found here [[ HTTP_API_MailFilter | Mail Filter HTTP API]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;ajax file upload&amp;quot; ==&lt;br /&gt;
This module offers to store files in server&#039;s dedicated download directory for a configureable amount of time. The files are then accessible for further operations like inline images in (html) mails&lt;br /&gt;
&lt;br /&gt;
=== Uploading a file ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/file?action=new&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The module for which the file is uploaded to determine proper upload quota constraints (e.g. &amp;quot;mail&amp;quot;, &amp;quot;infostore&amp;quot;, etc.).&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; – The file type filter to define which file types are allowed during upload. Currently supported filters are: &amp;lt;code&amp;gt;file=all, text=text/*, media=image OR audio OR video, image=image/*, audio=audio/*, video=video/*, application=application/*&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A common POST request body of MIME type &amp;quot;multipart/*&amp;quot; which holds the file(s) to upload&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of the uploaded files. The files are accessible through the returned IDs for future use.&lt;br /&gt;
&lt;br /&gt;
=== Updating a file&#039;s last access timestamp (keep alive) ===&lt;br /&gt;
By updating the last access timestamp it&#039;s prevented from being deleted from both session and disk storage.&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=keepalive&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file whose timestamp should be updated&lt;br /&gt;
&lt;br /&gt;
Response: The string &amp;quot;null&amp;quot; in response&#039;s data element&lt;br /&gt;
&lt;br /&gt;
=== Requesting a formerly uploaded file ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested file is directly written into output stream&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=1564</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=1564"/>
		<updated>2008-05-05T20:20:10Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: added new parameter &amp;#039;allowimages&amp;#039;&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
Some error message contain data sizes which must be expressed in Bytes or Kilobytes etc., depending on the actual value. Since the unit must be translated, this conversion is performed by the client. Unfortunately, standard printf()-style formatting does not have a specifier for this kind of translation. Therefore, the conversion specification for sizes is the same as for normal strings, and the client has to determine which parameters to translate based on the error code. The current error codes and the corresponding size parameters are listed in [[#DataSizeParameters | Data size parameters]]&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DataSizeParameters&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Data size parameters&lt;br /&gt;
! Error code !! Parameter indices&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0006   || 1&lt;br /&gt;
|-&lt;br /&gt;
| AJP-0020   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
| CON-0101   || 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| FLS-0003   || 1, 2, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0065   || 1, 3&lt;br /&gt;
|-&lt;br /&gt;
| MSG-0066   || 1&lt;br /&gt;
|-&lt;br /&gt;
| NON-0005   || 1, 2&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – A string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;fastgui&amp;lt;/code&amp;gt; - A string containing GUI-specific settings. This is a JSON object that must be kept small for performance.&lt;br /&gt;
** &amp;lt;code&amp;gt;context_id&amp;lt;/code&amp;gt; - the unique identifier of the context (read-only, added 2008-01-28).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;maxUploadIdleTimeout&amp;lt;/code&amp;gt; - Timeout after that idle uploads are deleted.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with.  (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt; (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails. (deprecated 2008-04-29)&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not. (deprecated 2008-04-29)&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
*** &amp;lt;code&amp;gt;showDialog&amp;lt;/code&amp;gt; – Enables participant selection dialog for appointments and tasks. (read-only, added 2008-04-30/SP4)&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;portal&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;addresses&amp;lt;/code&amp;gt; – all email addresses of the user including the primary address (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;appendmailtext&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;colorquoted&amp;lt;/code&amp;gt; – color quoted lines (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultaddress&amp;lt;/code&amp;gt; – primary email address of the user (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;deletemail&amp;lt;/code&amp;gt; – delete emails or move to trash (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;defaultFolder&amp;lt;/code&amp;gt;&lt;br /&gt;
***** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only, added 2008-02-25)&lt;br /&gt;
***** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only, added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;forwardmessage&amp;lt;/code&amp;gt; – forward messages as inline or attachment (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inlineattachments&amp;lt;/code&amp;gt; – activate inlining of HTML attachments (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;linewrap&amp;lt;/code&amp;gt; – (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – if mail module is enabled or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sendaddress&amp;lt;/code&amp;gt; – one email address out of the addresses list that are email sent with (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; – Spam Button should be displayed in GUI or not (added 2008-02-25)&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails (added 2008-02-25)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;interfaces&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;com.openexchange.extras&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Extras link in the configuration (read only, added 2008-04-29)&lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100 || categories    || Array   || Each element is a string, naming a category. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101 || private_flag  || Boolean || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 103 || number_of_links  || Number || Number of links&lt;br /&gt;
|-&lt;br /&gt;
| 104 || number_of_attachments  || Number || Number of attachments&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
|     || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-61 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number       || Specifies when to notify the participantsas the number of minutes before the end of the task or before the start of the appointment.&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Exclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#participantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|-&lt;br /&gt;
| 5 || external user&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority&lt;br /&gt;
|-&lt;br /&gt;
| 310 || duration_type&lt;br /&gt;
|-&lt;br /&gt;
| 311 || type_of_costs&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the task&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]].&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 593 || Context id                  || context_id&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distributuion_list&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || contains_image1&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as&lt;br /&gt;
|-&lt;br /&gt;
| 600 ||                             || attachment&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address&lt;br /&gt;
|-&lt;br /&gt;
| 102 ||                             || color_label&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with objects. Each object contains fields “id” and “folder” of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of users ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=listuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with id&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
Available with SP4&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the contact&#039;s folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Get contact by user ID ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=getuser&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – User ID (not Object ID) of the requested user.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. &lt;br /&gt;
&lt;br /&gt;
Available with SP4 package.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given company.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (mandatory - should be set to &amp;quot;deleted&amp;quot;) (deprecated) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Folder ID of the requested appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_position&amp;lt;/code&amp;gt; (optional) – Recurrence Position requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the appointment&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created appointment.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested mails.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail. Supported fields by now are mail&#039;s color label (&amp;quot;color_label&amp;quot;) and its flags (&amp;quot;flags&amp;quot;) where additional field &amp;quot;value&amp;quot; defines if specified flags should be set or removed.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the updated mail&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the mail&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) – 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) – 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
* &amp;lt;code&amp;gt;allowimages&amp;lt;/code&amp;gt; (optional - available with SP4) - 0 forces the server to copy (and then emtpy) any image src attribute to a new oxsrc attribute within html parts. 0 to let the response contain the original image src attributes. Can be used to prevent loading external linked images (spam privacy protection). &#039;&#039;&#039;NOTE:&#039;&#039;&#039; if set, the corresponding gui config setting will be ignored.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Clear mail folder(s) ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=clear&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with IDs of the mail folders to clear&lt;br /&gt;
&lt;br /&gt;
Response: An array with IDs of mail folder that could not be cleared; meaning the response body is an empty JSON array if everything went well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for participants ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| member       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== List resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Request body: An array with resources ids.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label     || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the infoitem&#039;s folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: Rhe raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of infoitems which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| servertime || Time || The time on the server&lt;br /&gt;
|-&lt;br /&gt;
| user_id || Number || The ID of the user.&lt;br /&gt;
|-&lt;br /&gt;
| last_modified || Time || The last modification timestamp of the reminder&lt;br /&gt;
|-&lt;br /&gt;
| recurrence_position || Number || The recurrence position for series appointments or 0 if no series&lt;br /&gt;
|-&lt;br /&gt;
| folder || Number || The ID of the folder through that the object can be read&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Reminder===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/reminder?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
Response body: An JSON array with the id that was not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mailfilter&amp;quot; ==&lt;br /&gt;
The module mailfilter descriptes how to add, update or delete mail filter rules or to check which actions are supported by the underlying system.&lt;br /&gt;
&lt;br /&gt;
A detailed description can be found here [[ HTTP_API_MailFilter | Mail Filter HTTP API]]&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;ajax file upload&amp;quot; ==&lt;br /&gt;
This module offers to store files in server&#039;s dedicated download directory for a configureable amount of time. The files are then accessible for further operations like inline images in (html) mails&lt;br /&gt;
&lt;br /&gt;
=== Uploading a file ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/file?action=new&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The module for which the file is uploaded to determine proper upload quota constraints (e.g. &amp;quot;mail&amp;quot;, &amp;quot;infostore&amp;quot;, etc.).&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; – The file type filter to define which file types are allowed during upload. Currently supported filters are: &amp;lt;code&amp;gt;file=all, text=text/*, media=image OR audio OR video, image=image/*, audio=audio/*, video=video/*, application=application/*&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request body: A common POST request body of MIME type &amp;quot;multipart/*&amp;quot; which holds the file(s) to upload&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of the uploaded files. The files are accessible through the returned IDs for future use.&lt;br /&gt;
&lt;br /&gt;
=== Updating a file&#039;s last access timestamp (keep alive) ===&lt;br /&gt;
By updating the last access timestamp it&#039;s prevented from being deleted from both session and disk storage.&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=keepalive&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file whose timestamp should be updated&lt;br /&gt;
&lt;br /&gt;
Response: The string &amp;quot;null&amp;quot; in response&#039;s data element&lt;br /&gt;
&lt;br /&gt;
=== Requesting a formerly uploaded file ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/file?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the uploaded file&lt;br /&gt;
&lt;br /&gt;
Response: The content of the requested file is directly written into output stream&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Available_Translations&amp;diff=1321</id>
		<title>OX6:Available Translations</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Available_Translations&amp;diff=1321"/>
		<updated>2007-11-10T11:04:16Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Available Language Translations */  fixed wrong link description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Open-Xchange Community Edition Translations =&lt;br /&gt;
&lt;br /&gt;
=== Available Language Translations ===&lt;br /&gt;
&lt;br /&gt;
{| border=&amp;quot;1&amp;quot; cellpadding=&amp;quot;3&amp;quot; cellspacing=&amp;quot;0&amp;quot;&lt;br /&gt;
!align=&amp;quot;left&amp;quot; |Language&lt;br /&gt;
!align=&amp;quot;left&amp;quot; |Source&lt;br /&gt;
!align=&amp;quot;left&amp;quot; |Contributor&lt;br /&gt;
!align=&amp;quot;left&amp;quot; |Contact&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_us.png]] English&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Open-Xchange Inc.&lt;br /&gt;
| documentation [at] open-xchange [dot] com&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_fr.png]] French&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Open-Xchange Inc.&lt;br /&gt;
| documentation [at] open-xchange [dot] com&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_jp.png]] Japanese&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Saloob Inc.&lt;br /&gt;
| &lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_de.png]] German&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Open-Xchange Inc.&lt;br /&gt;
| documentation [at] open-xchange [dot] com&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_es.png]] Spanish (Spain)&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Joan Mante&lt;br /&gt;
|&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_tr.png]] Turkish&lt;br /&gt;
| [http://www.bek.org.tr/dryphon/ox_Turkish.zip Download]&lt;br /&gt;
| Ismet Sonmez&lt;br /&gt;
| &lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_co.png]] Spanish (Colombia)&lt;br /&gt;
| [http://www.open-xchange.com/forum/showthread.php?p=3251 Forum]&lt;br /&gt;
| xiao&lt;br /&gt;
| &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
How to include and build a new language please take a look at the section [[GUI Translation]].&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=OX6:Available_Translations&amp;diff=1320</id>
		<title>OX6:Available Translations</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=OX6:Available_Translations&amp;diff=1320"/>
		<updated>2007-11-10T11:01:31Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Available Language Translations */  added link to GUI translation&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= Open-Xchange Community Edition Translations =&lt;br /&gt;
&lt;br /&gt;
=== Available Language Translations ===&lt;br /&gt;
&lt;br /&gt;
{| border=&amp;quot;1&amp;quot; cellpadding=&amp;quot;3&amp;quot; cellspacing=&amp;quot;0&amp;quot;&lt;br /&gt;
!align=&amp;quot;left&amp;quot; |Language&lt;br /&gt;
!align=&amp;quot;left&amp;quot; |Source&lt;br /&gt;
!align=&amp;quot;left&amp;quot; |Contributor&lt;br /&gt;
!align=&amp;quot;left&amp;quot; |Contact&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_us.png]] English&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Open-Xchange Inc.&lt;br /&gt;
| documentation [at] open-xchange [dot] com&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_fr.png]] French&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Open-Xchange Inc.&lt;br /&gt;
| documentation [at] open-xchange [dot] com&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_jp.png]] Japanese&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Saloob Inc.&lt;br /&gt;
| &lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_de.png]] German&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Open-Xchange Inc.&lt;br /&gt;
| documentation [at] open-xchange [dot] com&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_es.png]] Spanish (Spain)&lt;br /&gt;
| Included in standard source distribution&lt;br /&gt;
| Joan Mante&lt;br /&gt;
|&lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_tr.png]] Turkish&lt;br /&gt;
| [http://www.bek.org.tr/dryphon/ox_Turkish.zip Download]&lt;br /&gt;
| Ismet Sonmez&lt;br /&gt;
| &lt;br /&gt;
|-&lt;br /&gt;
| [[Image:Flag_co.png]] Spanish (Colombia)&lt;br /&gt;
| [http://www.open-xchange.com/forum/showthread.php?p=3251 Forum]&lt;br /&gt;
| xiao&lt;br /&gt;
| &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
How to include and build a new language please take a look at the [[GUI_Translation]].&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=959</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=959"/>
		<updated>2007-07-12T08:37:38Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: ranamed webmail to mail, added new module portal&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – An string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments.&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines.&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics.&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once.&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment.&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement.&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview.&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not.&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;portal&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;interfaces&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100 || categories    || Array   || Each element is a string, naming a category. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101 || private_flag  || Boolean || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
|     || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-61 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number       || Specifies when to notify the participantsas the number of minutes before the end of the task or before the start of the appointment.&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Exclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#participantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority&lt;br /&gt;
|-&lt;br /&gt;
| 310 || duration_type&lt;br /&gt;
|-&lt;br /&gt;
| 311 || type_of_costs&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder_id”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]].&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 593 || Context id                  || context_id&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distributuion_list&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || contains_image1&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as&lt;br /&gt;
|-&lt;br /&gt;
| 600 ||                             || attachment&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address&lt;br /&gt;
|-&lt;br /&gt;
| 102 ||                             || color_label&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder_id”. &lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given company.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created appointment.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested mails.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail. Supported fields by now are mail&#039;s color label (&amp;quot;color_label&amp;quot;) and its flags (&amp;quot;flags&amp;quot;) where additional field &amp;quot;value&amp;quot; defines if specified flags should be set or removed.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the updated mail&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) - 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) - 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) - 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for participants ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| member       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label     || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: Rhe raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of infoitems which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| object_id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=958</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=958"/>
		<updated>2007-07-12T08:18:46Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: config tree change&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – An string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments.&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines.&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics.&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once.&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment.&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement.&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview.&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not.&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;webmail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;interfaces&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100 || categories    || Array   || Each element is a string, naming a category. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101 || private_flag  || Boolean || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
|     || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-61 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number       || Specifies when to notify the participantsas the number of minutes before the end of the task or before the start of the appointment.&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Exclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#participantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority&lt;br /&gt;
|-&lt;br /&gt;
| 310 || duration_type&lt;br /&gt;
|-&lt;br /&gt;
| 311 || type_of_costs&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder_id”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]].&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 593 || Context id                  || context_id&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distributuion_list&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || contains_image1&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as&lt;br /&gt;
|-&lt;br /&gt;
| 600 ||                             || attachment&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address&lt;br /&gt;
|-&lt;br /&gt;
| 102 ||                             || color_label&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder_id”. &lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given company.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created appointment.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested mails.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail. Supported fields by now are mail&#039;s color label (&amp;quot;color_label&amp;quot;) and its flags (&amp;quot;flags&amp;quot;) where additional field &amp;quot;value&amp;quot; defines if specified flags should be set or removed.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the updated mail&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) - 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) - 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) - 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for participants ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| member       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label     || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: Rhe raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of infoitems which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| object_id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=957</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=957"/>
		<updated>2007-07-12T08:17:44Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: changed config tree&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – An string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments.&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines.&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics.&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once.&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment.&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement.&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview.&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not.&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;webmail&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100 || categories    || Array   || Each element is a string, naming a category. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101 || private_flag  || Boolean || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
|     || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-61 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number       || Specifies when to notify the participantsas the number of minutes before the end of the task or before the start of the appointment.&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Exclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#participantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority&lt;br /&gt;
|-&lt;br /&gt;
| 310 || duration_type&lt;br /&gt;
|-&lt;br /&gt;
| 311 || type_of_costs&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder_id”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]].&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 593 || Context id                  || context_id&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distributuion_list&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || contains_image1&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as&lt;br /&gt;
|-&lt;br /&gt;
| 600 ||                             || attachment&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address&lt;br /&gt;
|-&lt;br /&gt;
| 102 ||                             || color_label&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder_id”. &lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given company.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created appointment.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested mails.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail. Supported fields by now are mail&#039;s color label (&amp;quot;color_label&amp;quot;) and its flags (&amp;quot;flags&amp;quot;) where additional field &amp;quot;value&amp;quot; defines if specified flags should be set or removed.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the updated mail&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) - 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) - 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) - 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for participants ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| member       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label     || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: Rhe raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of infoitems which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| object_id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=951</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=951"/>
		<updated>2007-07-10T11:35:10Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Module &amp;quot;config&amp;quot; */ moved conflict, freebusy and teamview&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Action was at least partially successful, but a condition occurred that merited a warning&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – An string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments.&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines.&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics.&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once.&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment.&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement.&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview.&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not.&lt;br /&gt;
** &amp;lt;code&amp;gt;participants&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;showWithoutEmail&amp;lt;/code&amp;gt; - If external participants without email should be shown.&lt;br /&gt;
** &amp;lt;code&amp;gt;modules&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;webmail&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_conflict&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
**** &amp;lt;code&amp;gt;calendar_teamview&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;ical&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;syncml&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;public_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;read_create_shared_folders&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;delegate_tasks&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100 || categories    || Array   || Each element is a string, naming a category. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101 || private_flag  || Boolean || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
|     || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-61 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number       || Specifies when to notify the participantsas the number of minutes before the end of the task or before the start of the appointment.&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Exclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#participantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority&lt;br /&gt;
|-&lt;br /&gt;
| 310 || duration_type&lt;br /&gt;
|-&lt;br /&gt;
| 311 || type_of_costs&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder_id”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
=== Search for tasks ===&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Displayed name              !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || Display name                || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || Given name                  || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || Sur name                    || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || Middle name                 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || Suffix                      || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || Title                       || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || Street home                 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || Postal code home            || postal_code_home&lt;br /&gt;
|-&lt;br /&gt;
| 508 || City home                   || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || State home                  || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || Country home                || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || Birthday                    || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || Martial status              || marital_status&lt;br /&gt;
|-&lt;br /&gt;
| 513 || Number of children          || number_of_children&lt;br /&gt;
|-&lt;br /&gt;
| 514 || Profession                  || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || Nickname                    || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || Spouse name                 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || Anniversay                  || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || Note                        || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || Department                  || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || Position                    || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || Employee type               || employee_type&lt;br /&gt;
|-&lt;br /&gt;
| 522 || Room number                 || room_number&lt;br /&gt;
|-&lt;br /&gt;
| 523 || Street business             || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || Postal code business        || postal_code_business&lt;br /&gt;
|-&lt;br /&gt;
| 526 || City business               || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || State business              || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || Country business            || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || Number of employee          || number_of_employees&lt;br /&gt;
|-&lt;br /&gt;
| 530 || Sales volume                || sales_volume&lt;br /&gt;
|-&lt;br /&gt;
| 531 || Tax id                      || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || Commercial register         || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || Branches                    || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || Business category           || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || Info                        || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || Manager&#039;s name              || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || Assistant&#039;s name            || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || Street other                || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || City other                  || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || Postal code other           || postal_code_other&lt;br /&gt;
|-&lt;br /&gt;
| 541 || Country other               || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || Telephone business 1        || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || Telephone business 2        || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || FAX business                || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || Telephone callback          || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || Telephone car               || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || Telephone company           || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || Telephone home 1            || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || Telephone home 2            || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || FAX home                    || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || Cellular telephone 1        || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || Cellular telephone 2        || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || Telephone other             || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || FAX other                   || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || Email 1                     || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || Email 2                     || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || Email 3                     || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || URL                         || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || Telephone ISDN              || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || Telephone pager             || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || Telephone primary           || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || Telephone radio             || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || Telephone telex             || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || Telephone TTY/TDD           || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || Instantmessenger 1          || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || Instantmessenger 2          || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || Telephone IP                || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || Telephone assostant         || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || Company                     || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 ||                             || image1&lt;br /&gt;
|-&lt;br /&gt;
| 571 || Dynamic Field 1             || userfield01&lt;br /&gt;
|-&lt;br /&gt;
| 572 || Dynamic Field 2             || userfield02&lt;br /&gt;
|-&lt;br /&gt;
| 573 || Dynamic Field 3             || userfield03&lt;br /&gt;
|-&lt;br /&gt;
| 574 || Dynamic Field 4             || userfield04&lt;br /&gt;
|-&lt;br /&gt;
| 575 || Dynamic Field 5             || userfield05&lt;br /&gt;
|-&lt;br /&gt;
| 576 || Dynamic Field 6             || userfield06&lt;br /&gt;
|-&lt;br /&gt;
| 577 || Dynamic Field 7             || userfield07&lt;br /&gt;
|-&lt;br /&gt;
| 578 || Dynamic Field 8             || userfield08&lt;br /&gt;
|-&lt;br /&gt;
| 579 || Dynamic Field 9             || userfield09&lt;br /&gt;
|-&lt;br /&gt;
| 580 || Dynamic Field 10            || userfield10&lt;br /&gt;
|-&lt;br /&gt;
| 581 || Dynamic Field 11            || userfield11&lt;br /&gt;
|-&lt;br /&gt;
| 582 || Dynamic Field 12            || userfield12&lt;br /&gt;
|-&lt;br /&gt;
| 583 || Dynamic Field 13            || userfield13&lt;br /&gt;
|-&lt;br /&gt;
| 584 || Dynamic Field 14            || userfield14&lt;br /&gt;
|-&lt;br /&gt;
| 585 || Dynamic Field 15            || userfield15&lt;br /&gt;
|-&lt;br /&gt;
| 586 || Dynamic Field 16            || userfield16&lt;br /&gt;
|-&lt;br /&gt;
| 587 || Dynamic Field 17            || userfield17&lt;br /&gt;
|-&lt;br /&gt;
| 588 || Dynamic Field 18            || userfield18&lt;br /&gt;
|-&lt;br /&gt;
| 589 || Dynamic Field 19            || userfield19&lt;br /&gt;
|-&lt;br /&gt;
| 590 || Dynamic Field 20            || userfield20&lt;br /&gt;
|-&lt;br /&gt;
| 591 ||                             || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]].&lt;br /&gt;
|-&lt;br /&gt;
| 592 ||                             || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 593 || Context id                  || context_id&lt;br /&gt;
|-&lt;br /&gt;
| 594 || Number of distributionlists || number_of_distributuion_list&lt;br /&gt;
|-&lt;br /&gt;
| 595 ||                             || number_of_links&lt;br /&gt;
|-&lt;br /&gt;
| 596 ||                             || contains_image1&lt;br /&gt;
|-&lt;br /&gt;
| 597 ||                             || image_last_modified&lt;br /&gt;
|-&lt;br /&gt;
| 598 || State other                 || state_other&lt;br /&gt;
|-&lt;br /&gt;
| 599 ||                             || file_as&lt;br /&gt;
|-&lt;br /&gt;
| 600 ||                             || attachment&lt;br /&gt;
|-&lt;br /&gt;
| 601 ||                             || image1_content_type&lt;br /&gt;
|-&lt;br /&gt;
| 602 ||                             || mark_as_distributionlist&lt;br /&gt;
|-&lt;br /&gt;
| 605 || Default address             || default_address&lt;br /&gt;
|-&lt;br /&gt;
| 102 ||                             || color_label&lt;br /&gt;
|-&lt;br /&gt;
| 524 ||                             || internal_userid&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder_id”. &lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| last_name || String || Searches contacts where the last name match with the given last name.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || Searches contacts where the first name match with the given first name.&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Searches contacts where the display name match with the given display name.&lt;br /&gt;
|-&lt;br /&gt;
| company || String || Searches contacts where the company match with the given company.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|-&lt;br /&gt;
|  || ignore_conflicts || Boolean  || Ignore soft conflicts for the new or modified appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;recurrence_master&amp;lt;/code&amp;gt; – Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created appointment.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/appointments?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchAppointments&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search appointments&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|-&lt;br /&gt;
| startletter || String || Search contacts with the given startletter.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchAppointments | Search appointments]].&lt;br /&gt;
&lt;br /&gt;
Response: An array with appointment data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get mail count ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=count&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder whose mail count is queried&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An integer value representing folder&#039;s mail count&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Search mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON array of JSON objects each containing the search field and its search pattern: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;[{&amp;quot;col&amp;quot;: 612, &amp;quot;pattern&amp;quot;: &amp;quot;Joe&amp;quot;}, {&amp;quot;col&amp;quot;: 614, &amp;quot;pattern&amp;quot;: &amp;quot;Tuesday&amp;quot;}]&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested mails.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Copy mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the copied mail&lt;br /&gt;
&lt;br /&gt;
=== Move mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the source folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object containing the id of the destination folder inside the &amp;quot;folder_id&amp;quot; field: e.g.:&lt;br /&gt;
&amp;lt;code&amp;gt;{&amp;quot;folder_id&amp;quot;: 1376}&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the moved mail&lt;br /&gt;
&lt;br /&gt;
=== Update mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder.&lt;br /&gt;
&lt;br /&gt;
Request Body: A JSON object which carries the new values that ought to be applied to mail. Supported fields by now are mail&#039;s color label (&amp;quot;color_label&amp;quot;) and its flags (&amp;quot;flags&amp;quot;) where additional field &amp;quot;value&amp;quot; defines if specified flags should be set or removed.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the ID of the updated mail&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Just an empty JSON array is going to be returned since this action cannot be applied to IMAP.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
* &amp;lt;code&amp;gt;edit&amp;lt;/code&amp;gt; (optional) – 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.&lt;br /&gt;
* &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; (optional) - 1 to let the response contain only the (formatted) message headers as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; (optional) - 1 to let the response contain the complete message source as plain text&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; (optional) - 1 to write the complete message source to output stream. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; This parameter will only be used if parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; is set to 1.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An JSON object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Of course response is not a JSON object if either parameter &amp;lt;code&amp;gt;hdr&amp;lt;/code&amp;gt; or parameter &amp;lt;code&amp;gt;src&amp;lt;/code&amp;gt; are set to &amp;quot;1&amp;quot;. Then the response contains plain text. Moreover if optional parameter &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; is set to &amp;quot;1&amp;quot; the complete message source is going to be directly written to output stream to open browser&#039;s save dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Send a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request Body: This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
* The form filed &amp;lt;code&amp;gt;json_0&amp;lt;/code&amp;gt; contains the rudimentary mail as JSON object as described in [[#DetailedMailData | Detailed mail data]] with just its message body (as html content) defined in nested JSON array &amp;quot;attachments&amp;quot; and its header data (from, to, subject, etc.). The field &amp;quot;content_type&amp;quot; defines whether the mail ought to be sent as plain text (&amp;quot;text/plain&amp;quot;), as html (&amp;quot;text/html&amp;quot;) or  as multipart/alternative (&amp;quot;ALTERNATIVE&amp;quot;). Sending a mail requires some special fields inside JSON mail object. The field &amp;quot;infostore_ids&amp;quot; defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field &amp;quot;msgref&amp;quot; indicates the ID of the referenced original mail. Moreover the field &amp;quot;sendtype&amp;quot; indicates the type of the message:&lt;br /&gt;
** 0 - A normal new mail (optional)&lt;br /&gt;
** 1 - A reply mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
** 2 - A forward mail. The field &amp;quot;msgref&amp;quot; must be present&lt;br /&gt;
Example of a normal new mail which appends user&#039;s VCard and requests a read receipt from receiver:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Content-Disposition: form-data; name=&amp;quot;json_0&amp;quot;....{&amp;quot;from&amp;quot;:&amp;quot;\u0022Muster, Karl\u0022 &amp;lt;karl.muster@somewhere.com&amp;gt;&amp;quot;,&amp;quot;to&amp;quot;:&amp;quot;someone@somewhere.com&amp;quot;,&amp;quot;cc&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;bcc&amp;quot;:&amp;quot;&amp;quot;,&lt;br /&gt;
&amp;quot;subject&amp;quot;:&amp;quot;Mail Subject&amp;quot;,&amp;quot;priority&amp;quot;:&amp;quot;3&amp;quot;,&amp;quot;disp_notification_to&amp;quot;:true,&amp;quot;vcard&amp;quot;:1,&lt;br /&gt;
&amp;quot;attachments&amp;quot;:[{&amp;quot;content_type&amp;quot;:&amp;quot;ALTERNATIVE&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;Simple Mail Text!&amp;amp;lt;br&amp;amp;gt;&amp;amp;lt;br&amp;amp;gt;\u000a\u000a&amp;quot;}]}&amp;lt;/code&amp;gt;&lt;br /&gt;
* The form field &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more file upload form fields whose referenced file are going to appended as attachments&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for participants ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| member       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label     || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: Rhe raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of infoitems which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| object_id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file. The column titles of the table are those used within the OX, see column &#039;&#039;Displayed Name&#039;&#039; in [[#DetailedContactData]].&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file with Windows&#039; default encoding Windows-1252. The column titles of the table may be those used by the English, French or German version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;sync&amp;quot; ==&lt;br /&gt;
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.&lt;br /&gt;
&lt;br /&gt;
=== Clearing a folder&#039;s content ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/sync?action=refresh_server&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: A JSON array containing the folder ID(s) whose content should be cleared. &#039;&#039;&#039;NOTE:&#039;&#039;&#039; Although the requests offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs&lt;br /&gt;
(e.g. missing permissions) the complete request is going to be aborted.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
	<entry>
		<id>https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=525</id>
		<title>HTTP API</title>
		<link rel="alternate" type="text/html" href="https://wiki.open-xchange.com/wiki/index.php?title=HTTP_API&amp;diff=525"/>
		<updated>2007-05-10T20:28:34Z</updated>

		<summary type="html">&lt;p&gt;Stefan.preuss: /* Get all mails */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Introduction ==&lt;br /&gt;
&lt;br /&gt;
This document defines the Open-Xchange HTTP API which is used by the new AJAX GUI. The first chapter describes general definitions and conventions which apply to all server modules. All other chapters describe individual server modules.&lt;br /&gt;
&lt;br /&gt;
=== Low level protocol ===&lt;br /&gt;
&lt;br /&gt;
The client accesses the server though HTTP GET, POST and PUT requests. The HTTP API is accessible at URIs starting with &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;. Each server module has a unique name and its own sub-namespace with that name below &amp;lt;code&amp;gt;/ajax&amp;lt;/code&amp;gt;, e. g. all access to the module &amp;quot;tasks&amp;quot; is via URIs starting with &amp;lt;code&amp;gt;/ajax/tasks&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Text encoding is always UTF-8. Data is sent from the server to the client as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; and interpreted by the client to obtain an ECMAScript object. The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:&lt;br /&gt;
&lt;br /&gt;
 Value   ::= &amp;quot;null&amp;quot; | Boolean | Number | String | Array | Object&lt;br /&gt;
 Boolean ::= &amp;quot;true&amp;quot; | &amp;quot;false&amp;quot;&lt;br /&gt;
 Number  ::= see NumericLiteral in ECMA 262 3rd edition&lt;br /&gt;
 String  ::= \&amp;quot;([^&amp;quot;\n\\]|\\[&amp;quot;\n\\])*\&amp;quot;&lt;br /&gt;
 Array   ::= &amp;quot;[]&amp;quot; | &amp;quot;[&amp;quot; Value (&amp;quot;,&amp;quot; Value)* &amp;quot;]&amp;quot;&lt;br /&gt;
 Object  ::= &amp;quot;{}&amp;quot; | &amp;quot;{&amp;quot; Name &amp;quot;:&amp;quot; Value (&amp;quot;,&amp;quot; Name &amp;quot;:&amp;quot; Value)* &amp;quot;}&amp;quot;&lt;br /&gt;
 Name    ::= [A-Fa-f][0-9A-Fa-f_]*&lt;br /&gt;
&lt;br /&gt;
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See [http://json.org JSON] and [http://www.ecma-international.org/publications/standards/Ecma-262.htm ECMA 262, 3&amp;lt;sup&amp;gt;rd&amp;lt;/sup&amp;gt; edition] for the formal definition.&lt;br /&gt;
&lt;br /&gt;
The response body consists of an object, which contains up to four fields as described in [[#ResponseBody | Response body]]. The field &amp;lt;code&amp;gt;data&amp;lt;/code&amp;gt; contains the actual payload which is described in following chapters. The fields &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;error&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;error_params&amp;lt;/code&amp;gt; are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively. Following sections describe the contents of these fields in more detail.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResponseBody&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Response body&lt;br /&gt;
! Name         !! Type      !! Value&lt;br /&gt;
|-&lt;br /&gt;
| data         || Value     || Payload of the response.&lt;br /&gt;
|-&lt;br /&gt;
| timestamp    || Timestamp || Current timestamp on the server.&lt;br /&gt;
|-&lt;br /&gt;
| error        || String    || English error message. Present in case of errors.&lt;br /&gt;
|-&lt;br /&gt;
| error_params || Array     || Replacement parameters for the error message.&lt;br /&gt;
|-&lt;br /&gt;
| error_id     || String    || Unique error identifier to help finding this error instance in the server logs.&lt;br /&gt;
|-&lt;br /&gt;
| code         || String    || Error code consisting of a three-letter category and a four-digit message number, separated by a dash.&lt;br /&gt;
|-&lt;br /&gt;
| category     || Number    || Category to which the error message belongs:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || An error resulting from wrong or missing input from front-end (e.g. mandatory field missing).&lt;br /&gt;
|-&lt;br /&gt;
| 2  || An error strictly related to user configuration which denies requested operation.&lt;br /&gt;
|-&lt;br /&gt;
| 3  || An error related to insufficient permission settings.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections).&lt;br /&gt;
|-&lt;br /&gt;
| 5  || A subsystem or third party service is down and therefore does not respond (e.g. database is down).&lt;br /&gt;
|-&lt;br /&gt;
| 6  || The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system.&lt;br /&gt;
|-&lt;br /&gt;
| 7  || An internal java-related (runtime) exception.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || A programming error which was caused by incorrect programm code.&lt;br /&gt;
|-&lt;br /&gt;
| 9  || A concurrent modification.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Error in system setup detected.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota).&lt;br /&gt;
|-&lt;br /&gt;
| 12 || The given data could not be stored into the database because an attribute contains a too long value.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Data from the client to the server can be sent in several formats. Small amounts of data are sent as &amp;lt;code&amp;gt;application/x-www-urlencoded&amp;lt;/code&amp;gt; in query parameters in the request URI. For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests. Alternatively, some requests specify that data is sent as &amp;lt;code&amp;gt;text/javascript&amp;lt;/code&amp;gt; in the body of a PUT request. The format of the request body for PUT requests is the same as for sending data from the server to the client, except that the payload is sent directly, without being wrapped in another object.&lt;br /&gt;
&lt;br /&gt;
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;. For fields of type &amp;lt;code&amp;gt;String&amp;lt;/code&amp;gt;, the empty string &amp;lt;code&amp;gt;&amp;quot;&amp;quot;&amp;lt;/code&amp;gt; is equivalent to &amp;lt;code&amp;gt;null&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Error handling ===&lt;br /&gt;
&lt;br /&gt;
If the session of the user times out, if the client doesn&#039;t send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.&lt;br /&gt;
&lt;br /&gt;
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in [[#ResponseBody | Response body]]. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style conversion specifications, which are replaced by elements from the array in the field error_params. If error_params is not present, no replacement occurs, even if parts of the error message match the syntax of a conversion specification.&lt;br /&gt;
&lt;br /&gt;
A simplified conversion specification, as used for error messages, is either of the form %s or %&#039;&#039;n&#039;&#039;$s, where &#039;&#039;n&#039;&#039; is an array index for error_params as a decimal number. The conversion specifications are replaced from left to right by elements from error_params, starting at index 0. %s is replaced by the element with the current index and the index is incremented. %&#039;&#039;n&#039;&#039;$s is replaced by the element with index &#039;&#039;n&#039;&#039; and the index is set to &#039;&#039;n&#039;&#039; + 1.&lt;br /&gt;
&lt;br /&gt;
=== Date and time ===&lt;br /&gt;
&lt;br /&gt;
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970‑01‑01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.&lt;br /&gt;
&lt;br /&gt;
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server. Dates with time are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user&#039;s timezone and UTC at the time in question. (See the Java method java.util.TimeZone.getOffset(long)).&lt;br /&gt;
&lt;br /&gt;
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970‑01‑01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.&lt;br /&gt;
&lt;br /&gt;
This specification refers to these three interpretations of the type Number as separate data types. The types are described in [[#DateAndTimeTypes | Date and time types]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DateAndTimeTypes&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Date and time types&lt;br /&gt;
! Type      !! Time !! Timezone !! Comment&lt;br /&gt;
|-&lt;br /&gt;
| Date      || No   || UTC      || Date without time.&lt;br /&gt;
|-&lt;br /&gt;
| Time      || Yes  || User     || Date and time.&lt;br /&gt;
|-&lt;br /&gt;
| Timestamp || Yes  || UTC      || Timestamp or unique sequence number.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Updates ===&lt;br /&gt;
&lt;br /&gt;
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object. Whenever the server transmits data objects to the client, the response object described in [[#ResponseBody | Response body]] includes the field timestamp. This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.&lt;br /&gt;
&lt;br /&gt;
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.&lt;br /&gt;
&lt;br /&gt;
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.&lt;br /&gt;
&lt;br /&gt;
If unique sequence numbers can&#039;t be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.&lt;br /&gt;
&lt;br /&gt;
=== Editing ===&lt;br /&gt;
&lt;br /&gt;
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.&lt;br /&gt;
&lt;br /&gt;
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp field described in the previous section. For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp of the view is used as the timestamp of each object in it.&lt;br /&gt;
&lt;br /&gt;
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.&lt;br /&gt;
&lt;br /&gt;
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.&lt;br /&gt;
&lt;br /&gt;
=== File uploads ===&lt;br /&gt;
&lt;br /&gt;
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”. The file metadata are stored in a form field “file” (much like an &amp;lt;input type=”file” name=”file” /&amp;gt; would do). In general a call that allows file uploads via POST will have a corresponding call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into the request parameter “json”.&lt;br /&gt;
&lt;br /&gt;
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is of the form:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;!DOCTYPE HTML PUBLIC &amp;quot;-//W3C//DTD HTML 4.01//EN&amp;quot; &amp;lt;nowiki&amp;gt;&amp;quot;http://www.w3.org/TR/html4/strict.dtd&amp;quot;&amp;lt;/nowiki&amp;gt;&amp;gt;&lt;br /&gt;
 &amp;lt;html&amp;gt;&lt;br /&gt;
     &amp;lt;META http-equiv=&amp;quot;Content-Type&amp;quot; content=&amp;quot;text/html; charset=UTF-8&amp;quot;&amp;gt;&lt;br /&gt;
     &amp;lt;head&amp;gt;&lt;br /&gt;
         &amp;lt;script type=&amp;quot;text/javascript&amp;quot;&amp;gt;&lt;br /&gt;
             parent.callback_**action**(**json**);&lt;br /&gt;
         &amp;lt;/script&amp;gt;&lt;br /&gt;
     &amp;lt;/head&amp;gt;&lt;br /&gt;
 &amp;lt;/html&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The placeholders &amp;lt;code&amp;gt;**json**&amp;lt;/code&amp;gt; is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder &amp;lt;code&amp;gt;**action**&amp;lt;/code&amp;gt; is replaced by the value of the parameter &amp;lt;code&amp;gt;action&amp;lt;/code&amp;gt; of the request. The content-type of the answer is &amp;lt;code&amp;gt;text/html&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Documentation conventions ===&lt;br /&gt;
&lt;br /&gt;
The rest of this document describes all available requests for each module. A module usually supports several different requests, which are differentiated by the used HTTP method, URI path and supplied URI parameters. The description of each method generally contains the following elements:&lt;br /&gt;
* the HTTP method followed by the request URI, inclusing the URI parameter action, which is used to differentiate methods,&lt;br /&gt;
* a list of URI parameters which can or must be supplied by the client,&lt;br /&gt;
* for PUT requests, content of the request body,&lt;br /&gt;
* &amp;quot;Response with timestamp:&amp;quot;if the timestamp field is required in the response body or simply &amp;quot;Response:&amp;quot; if not,&lt;br /&gt;
* content of the response payload, unless it is supposed to be empty.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;login&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The login module is used to obtain a session ID from the user&#039;s login credentials.&lt;br /&gt;
&lt;br /&gt;
=== Login ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=login&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt; – The login name.&lt;br /&gt;
* &amp;lt;code&amp;gt;password&amp;lt;/code&amp;gt; – The password.&lt;br /&gt;
&lt;br /&gt;
Response: A string containing the session ID used for all subsequent requests.&lt;br /&gt;
&lt;br /&gt;
=== Logout ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/login?action=logout&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;config&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.&lt;br /&gt;
&lt;br /&gt;
The namespace looks like the following:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;/ajax/config/&amp;lt;/code&amp;gt;&lt;br /&gt;
** &amp;lt;code&amp;gt;gui&amp;lt;/code&amp;gt; – An string containing GUI-specific settings (currently, it is a huge [[#Low_level_protocol | JSON]] object).&lt;br /&gt;
** &amp;lt;code&amp;gt;identifier&amp;lt;/code&amp;gt; – the unique identifier of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;contact_id&amp;lt;/code&amp;gt; – the unique identifier of the contact data of the user (read-only).&lt;br /&gt;
** &amp;lt;code&amp;gt;language&amp;lt;/code&amp;gt; – the configured language of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;timezone&amp;lt;/code&amp;gt; – the configured timezone of the user.&lt;br /&gt;
** &amp;lt;code&amp;gt;calendarnotification&amp;lt;/code&amp;gt; - send a mail notification for appointments&lt;br /&gt;
** &amp;lt;code&amp;gt;tasknotification&amp;lt;/code&amp;gt; - send a mail notification for tasks&lt;br /&gt;
** &amp;lt;code&amp;gt;reloadTimes&amp;lt;/code&amp;gt; - Selectable times for GUI reload&lt;br /&gt;
** &amp;lt;code&amp;gt;serverVersion&amp;lt;/code&amp;gt; - Version string of the server.&lt;br /&gt;
** &amp;lt;code&amp;gt;currentTime&amp;lt;/code&amp;gt; - User timezone specific long of the current server time.&lt;br /&gt;
** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard folder of the user&lt;br /&gt;
*** &amp;lt;code&amp;gt;tasks&amp;lt;/code&amp;gt; – the standard task folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;calendar&amp;lt;/code&amp;gt; – the standard calendar folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;contacts&amp;lt;/code&amp;gt; – the standard contacts folder (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;infostore&amp;lt;/code&amp;gt; – the private infostore folder (read-only)&lt;br /&gt;
** &amp;lt;code&amp;gt;mail/&amp;lt;/code&amp;gt; – settings for the email module&lt;br /&gt;
*** &amp;lt;code&amp;gt;folder/&amp;lt;/code&amp;gt; – the standard email folders (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;inbox&amp;lt;/code&amp;gt; – identifier of the folder that gets all incoming mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;drafts&amp;lt;/code&amp;gt; – identifier of the folder with the mail drafts (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;trash&amp;lt;/code&amp;gt; – identifier of the folder with the deleted mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;spam&amp;lt;/code&amp;gt; – identifier of the folder with the spam mails (read-only)&lt;br /&gt;
**** &amp;lt;code&amp;gt;sent&amp;lt;/code&amp;gt; – identifier of the folder with the sent mails (read-only)&lt;br /&gt;
*** &amp;lt;code&amp;gt;htmlinline&amp;lt;/code&amp;gt; – activate inlining of HTML attachments.&lt;br /&gt;
*** &amp;lt;code&amp;gt;colorquote&amp;lt;/code&amp;gt; – color quoted lines.&lt;br /&gt;
*** &amp;lt;code&amp;gt;emoticons&amp;lt;/code&amp;gt; – display emoticons as graphics.&lt;br /&gt;
*** &amp;lt;code&amp;gt;harddelete&amp;lt;/code&amp;gt; – delete emails at once.&lt;br /&gt;
*** &amp;lt;code&amp;gt;inlineforward&amp;lt;/code&amp;gt; – forward messages as inline or attachment.&lt;br /&gt;
*** &amp;lt;code&amp;gt;vcard&amp;lt;/code&amp;gt; – attach vcard when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;notifyonreadack&amp;lt;/code&amp;gt; – notify on read acknowledgement.&lt;br /&gt;
*** &amp;lt;code&amp;gt;msgpreview&amp;lt;/code&amp;gt; – show a message preview.&lt;br /&gt;
*** &amp;lt;code&amp;gt;ignorereplytext&amp;lt;/code&amp;gt;&lt;br /&gt;
*** &amp;lt;code&amp;gt;nocopytosent&amp;lt;/code&amp;gt; – don&#039;t put a copy to the sent folder when sending mails.&lt;br /&gt;
*** &amp;lt;code&amp;gt;spambutton&amp;lt;/code&amp;gt; - Spam Button should be displayed in GUI or not.&lt;br /&gt;
&lt;br /&gt;
=== Get configuration data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: Value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
=== Set configuration data ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/config/path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: The new value of the node specified by path.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;folders&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The folders module is used to access the OX folder structure.&lt;br /&gt;
&lt;br /&gt;
=== Special System Folders ===&lt;br /&gt;
&lt;br /&gt;
Folders with some kind of special.&lt;br /&gt;
&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! ID !! Type !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 6 || contacts || System Users&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get root folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=root&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;CommonObjectData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Common object data&lt;br /&gt;
! ID  !! Name          !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 1   || id            || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 2   || created_by    || String  || User ID of the user who created this object.&lt;br /&gt;
|-&lt;br /&gt;
| 3   || modified_by   || String  || User ID of the user who last modified this object.&lt;br /&gt;
|-&lt;br /&gt;
| 4   || creation_date || Time    || Date and time of creation.&lt;br /&gt;
|-&lt;br /&gt;
| 5   || last_modified || Time    || Date and time of the last modification.&lt;br /&gt;
|-&lt;br /&gt;
| 20  || folder_id     || String  || Object ID of the parent folder.&lt;br /&gt;
|-&lt;br /&gt;
| 100 || categories    || Array   || Each element is a string, naming a category. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.&lt;br /&gt;
|-&lt;br /&gt;
| 101 || private_flag  || Boolean || Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedFolderData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed folder data&lt;br /&gt;
! ID  !! Name            !! Type             !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || title           || String           || Name of this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 301 || module          || String           || Name of the module which implements this folder.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || type            || Number           || Type of folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || private&lt;br /&gt;
|-&lt;br /&gt;
| 2 || public&lt;br /&gt;
|-&lt;br /&gt;
| 3 || shared&lt;br /&gt;
|-&lt;br /&gt;
| 5 || system folder&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 304 || subfolders      || Boolean          || true if this folder has subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 305 || own_rights      || Number or String || Permissions which apply to the current user, as described either in [[#PermissionFlags | Permission flags]] or in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
|     || permissions     || Array            || Each element is an object described in [[#PermissionObject | Permission object]].&lt;br /&gt;
|-&lt;br /&gt;
| 307 || summary         || String           || Information about contained objects.&lt;br /&gt;
|-&lt;br /&gt;
| 308 || standard_folder || Boolean          || Indicates whether or not folder is marked as a default folder (only OX folder)&lt;br /&gt;
|-&lt;br /&gt;
| 309 || total           || Number           || The number of objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 310 || new             || Number           || The number of new objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 311 || unread          || Number           || The number of unread objects in this Folder.&lt;br /&gt;
|-&lt;br /&gt;
| 312 || deleted         || Number           || The number of deleted objects in this Folder.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionFlags&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission flags&lt;br /&gt;
! Bits  !! Value&lt;br /&gt;
|-&lt;br /&gt;
|  0-61 || Folder permissions:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || See the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Create objects in the folder.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Create subfolders.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|  7-13 || Read permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Read only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Read all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 14-20 || Write permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Modify only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Modify all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 21-27 || Delete permissions for objects in the folder:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0  || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1  || Delete only own objects.&lt;br /&gt;
|-&lt;br /&gt;
| 2  || Delete all objects.&lt;br /&gt;
|-&lt;br /&gt;
| 64 || Admin.&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 28    || Admin flag:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || No permissions.&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Allowed to modify permissions.&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;PermissionObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Permission object&lt;br /&gt;
! Name   !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| bits   || Number  || For non-mail folders, a number as described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
|-&lt;br /&gt;
| rights || String  || For mail folders, the rights string as defined in RFC 2086.&lt;br /&gt;
|-&lt;br /&gt;
| entity || Number  || User ID of the user or group to which this permission applies.&lt;br /&gt;
|-&lt;br /&gt;
| group  || Boolean || true if entity refers to a group, false if it refers to a user.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get subfolders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get path ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=path&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of a folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for all parent nodes until root folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated folders ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;parent&amp;lt;/code&amp;gt; – Object ID of a folder, which is the parent folder of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for folders are defined in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields categories and private_flag are not available for folders.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted folders are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a folder ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/folders?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested folder.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested folder. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present. Since OX access controls are folder-based, the folder object also defines the permissions for the objects it contains. The permissions for a given user or group are defined by the object described in [[#PermissionObject | Permission object]]. The format of the actual permissions depends on the type of the folder. The permissions of mail folders are transmitted as a rights string as defined in section 3 of RFC 2086. Permissions of all other folders are transmitted as a single nonnegative integer number. The permissions for any given action on the folder or on contained objects is defined by a group of bits in the binary representation of this number. Each group of bits is interpreted as a separate number. Zero always means &amp;quot;no permissions&amp;quot;. Any other values add new permissions and always include the permissions of all lower values. The individual values are described in [[#PermissionFlags | Permission flags]].&lt;br /&gt;
&lt;br /&gt;
=== Update a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a folder ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Folder object as described in [[#CommonObjectData | Common object data]] and [[#DetailedFolderData | Detailed folder data]]. The fields id, categories and private_flag are not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created folder.&lt;br /&gt;
&lt;br /&gt;
=== Delete folders ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/folders?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted folders. &lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted folders.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of folders which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;tasks&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The tasks module is used to access task information.&lt;br /&gt;
&lt;br /&gt;
=== Get all tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskAndAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task and appointment data&lt;br /&gt;
! ID  !! Name                     !! Type         !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 200 || title                    || String       || Short description.&lt;br /&gt;
|-&lt;br /&gt;
| 201 || start_date               || Date or Time || Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date.&lt;br /&gt;
|-&lt;br /&gt;
| 202 || end_date                 || Date or Time || Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.&lt;br /&gt;
|-&lt;br /&gt;
| 203 || note                     || String       || Long description.&lt;br /&gt;
|-&lt;br /&gt;
| 204 || alarm                    || Number       || Specifies when to notify the participantsas the number of minutes before the end of the task or before the start of the appointment.&lt;br /&gt;
|-&lt;br /&gt;
| 206 || recurrence_id            || Number       || Object ID of the entire appointment sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 207 || recurrence_position      || Number       || 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 208 || recurrence_date_position || Date         || Date of an individual appointment in a sequence. Present if and only if recurrence_type &amp;gt; 0.&lt;br /&gt;
|-&lt;br /&gt;
| 209 || recurrence_type          || Number       || Specifies the type of the recurrence for a task sequence:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none (single event)&lt;br /&gt;
|-&lt;br /&gt;
| 1 || daily&lt;br /&gt;
|-&lt;br /&gt;
| 2 || weekly&lt;br /&gt;
|-&lt;br /&gt;
| 3 || monthly&lt;br /&gt;
|-&lt;br /&gt;
| 4 || yearly&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 212 || days                     || Number       || Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type &amp;gt; 1. If allowed but not present, the value defaults to 127 (all 7 days).&lt;br /&gt;
|-&lt;br /&gt;
| 213 || day_in_month             || Number       || Specifies which day of a month is part of the sequence. Counting starts with 1. If the field &amp;quot;days&amp;quot; is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type &amp;gt; 2.&lt;br /&gt;
|-&lt;br /&gt;
| 214 || month                    || Number       || Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 215 || interval                 || Number       || Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type &amp;gt; 0. Must be 1 if recurrence_type = 4.&lt;br /&gt;
|-&lt;br /&gt;
| 216 || until                    || Date         || Exclusive end date of a sequence. May be present only if recurrence_type &amp;gt; 0. The sequence has no end date if recurrence_type &amp;gt; 0 and this field is not present.&lt;br /&gt;
|-&lt;br /&gt;
| 217 || notification             || Boolean      || If true, all participants are notified of any changes to this object.&lt;br /&gt;
|-&lt;br /&gt;
| 220 || participants             || Array        || Each element identifies a participant, user group or booked resource as described in [[#participantIdentifier | Participant identifier]].&lt;br /&gt;
|-&lt;br /&gt;
| 221 || users                    || Array        || Each element represents a participant as described in [[#UserParticipantObject | User participant object]]. User groups are resolved and are represented by their members. Any user can occur only once.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantIdentifier&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant identifier&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| type || Number || Type of participant:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || user&lt;br /&gt;
|-&lt;br /&gt;
| 2 || user group&lt;br /&gt;
|-&lt;br /&gt;
| 3 || resource&lt;br /&gt;
|-&lt;br /&gt;
| 4 || resource group&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;UserParticipantObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | User participant object&lt;br /&gt;
! Name           !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id             || Number || User ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name   || String || Displayable name of the participant.&lt;br /&gt;
|-&lt;br /&gt;
| confirmation   || Number ||&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || none&lt;br /&gt;
|-&lt;br /&gt;
| 1 || accepted&lt;br /&gt;
|-&lt;br /&gt;
| 2 || declined&lt;br /&gt;
|-&lt;br /&gt;
| 3 || tentative&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| confirmmessage || String || Confirm Message of the participant&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedTaskData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed task data&lt;br /&gt;
! ID  !! Name              !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 300 || status            || Number || Status of the task:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || not started&lt;br /&gt;
|-&lt;br /&gt;
| 2 || in progress&lt;br /&gt;
|-&lt;br /&gt;
| 3 || done&lt;br /&gt;
|-&lt;br /&gt;
| 4 || waiting&lt;br /&gt;
|-&lt;br /&gt;
| 5 || deferred&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 301 || percent_completed || Number || How much of the task is completed. An integer number between 0 and 100.&lt;br /&gt;
|-&lt;br /&gt;
| 302 || actual_costs&lt;br /&gt;
|-&lt;br /&gt;
| 303 || actual_duration&lt;br /&gt;
|-&lt;br /&gt;
| 304 || after_complete&lt;br /&gt;
|-&lt;br /&gt;
| 305 || billing_information&lt;br /&gt;
|-&lt;br /&gt;
| 306 || project_id&lt;br /&gt;
|-&lt;br /&gt;
| 307 || target_costs&lt;br /&gt;
|-&lt;br /&gt;
| 308 || target_duration&lt;br /&gt;
|-&lt;br /&gt;
| 309 || priority&lt;br /&gt;
|-&lt;br /&gt;
| 310 || duration_type&lt;br /&gt;
|-&lt;br /&gt;
| 311 || type_of_costs&lt;br /&gt;
|-&lt;br /&gt;
| 312 || currency&lt;br /&gt;
|-&lt;br /&gt;
| 313 || trip_meter&lt;br /&gt;
|-&lt;br /&gt;
| 314 || companies&lt;br /&gt;
|-&lt;br /&gt;
| 315 || date_completed&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with task data. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated tasks ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for tasks are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested tasks.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted tasks are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a task ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/tasks?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested task.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested task. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated task.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated task. If the task was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Task object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[##DetailedTaskData | Detailed task data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created task.&lt;br /&gt;
&lt;br /&gt;
=== Delete tasks ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted tasks.&lt;br /&gt;
&lt;br /&gt;
Request body: An object in the field “id” and “folder_id”.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Confirm task ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/tasks?action=confirm&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the to confirm task.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ID of the folder through that the task is accessed.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the to confirm task.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields &amp;quot;confirmation&amp;quot; and &amp;quot;confirmmessage&amp;quot; as described in [[#UserParticipantObject | User participant object]].&lt;br /&gt;
&lt;br /&gt;
Response: Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;contacts&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The contacts module is used to access contact information.&lt;br /&gt;
&lt;br /&gt;
=== Get all contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedContactData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed contact data&lt;br /&gt;
! ID  !! Name                 !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 500 || display_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 501 || first_name           || String || First name.&lt;br /&gt;
|-&lt;br /&gt;
| 502 || last_name            || String || Last name.&lt;br /&gt;
|-&lt;br /&gt;
| 503 || second_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 504 || suffix               || String&lt;br /&gt;
|-&lt;br /&gt;
| 505 || title                || String&lt;br /&gt;
|-&lt;br /&gt;
| 506 || street_home          || String&lt;br /&gt;
|-&lt;br /&gt;
| 507 || postal_code_home&lt;br /&gt;
|-&lt;br /&gt;
| 508 || city_home            || String&lt;br /&gt;
|-&lt;br /&gt;
| 509 || state_home           || String&lt;br /&gt;
|-&lt;br /&gt;
| 510 || country_home         || String&lt;br /&gt;
|-&lt;br /&gt;
| 511 || birthday             || Date&lt;br /&gt;
|-&lt;br /&gt;
| 512 || marital_status&lt;br /&gt;
|-&lt;br /&gt;
| 513 || number_of_children&lt;br /&gt;
|-&lt;br /&gt;
| 514 || profession           || String&lt;br /&gt;
|-&lt;br /&gt;
| 515 || nickname             || String&lt;br /&gt;
|-&lt;br /&gt;
| 516 || spouse_name          || String&lt;br /&gt;
|-&lt;br /&gt;
| 517 || anniversary          || Date&lt;br /&gt;
|-&lt;br /&gt;
| 518 || note                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 519 || department           || String&lt;br /&gt;
|-&lt;br /&gt;
| 520 || position             || String&lt;br /&gt;
|-&lt;br /&gt;
| 521 || employee_type&lt;br /&gt;
|-&lt;br /&gt;
| 522 || room_number&lt;br /&gt;
|-&lt;br /&gt;
| 523 || street_business      || String&lt;br /&gt;
|-&lt;br /&gt;
| 525 || postal_code_business&lt;br /&gt;
|-&lt;br /&gt;
| 526 || city_business        || String&lt;br /&gt;
|-&lt;br /&gt;
| 527 || state_business       || String&lt;br /&gt;
|-&lt;br /&gt;
| 528 || country_business     || String&lt;br /&gt;
|-&lt;br /&gt;
| 529 || number_of_employees&lt;br /&gt;
|-&lt;br /&gt;
| 530 || sales_volume&lt;br /&gt;
|-&lt;br /&gt;
| 531 || tax_id               || String&lt;br /&gt;
|-&lt;br /&gt;
| 532 || commercial_register  || String&lt;br /&gt;
|-&lt;br /&gt;
| 533 || branches             || String&lt;br /&gt;
|-&lt;br /&gt;
| 534 || business_category    || String&lt;br /&gt;
|-&lt;br /&gt;
| 535 || info                 || String&lt;br /&gt;
|-&lt;br /&gt;
| 536 || manager_name         || String&lt;br /&gt;
|-&lt;br /&gt;
| 537 || assistant_name       || String&lt;br /&gt;
|-&lt;br /&gt;
| 538 || street_other         || String&lt;br /&gt;
|-&lt;br /&gt;
| 539 || city_other           || String&lt;br /&gt;
|-&lt;br /&gt;
| 540 || postal_code_other&lt;br /&gt;
|-&lt;br /&gt;
| 541 || country_other        || String&lt;br /&gt;
|-&lt;br /&gt;
| 542 || telephone_business1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 543 || telephone_business2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 544 || fax_business         || String&lt;br /&gt;
|-&lt;br /&gt;
| 545 || telephone_callback   || String&lt;br /&gt;
|-&lt;br /&gt;
| 546 || telephone_car        || String&lt;br /&gt;
|-&lt;br /&gt;
| 547 || telephone_company    || String&lt;br /&gt;
|-&lt;br /&gt;
| 548 || telephone_home1      || String&lt;br /&gt;
|-&lt;br /&gt;
| 549 || telephone_home2      || String&lt;br /&gt;
|-&lt;br /&gt;
| 550 || fax_home             || String&lt;br /&gt;
|-&lt;br /&gt;
| 551 || cellular_telephone1  || String&lt;br /&gt;
|-&lt;br /&gt;
| 552 || cellular_telephone2  || String&lt;br /&gt;
|-&lt;br /&gt;
| 553 || telephone_other      || String&lt;br /&gt;
|-&lt;br /&gt;
| 554 || fax_other            || String&lt;br /&gt;
|-&lt;br /&gt;
| 555 || email1               || String&lt;br /&gt;
|-&lt;br /&gt;
| 556 || email2               || String&lt;br /&gt;
|-&lt;br /&gt;
| 557 || email3               || String&lt;br /&gt;
|-&lt;br /&gt;
| 558 || url                  || String&lt;br /&gt;
|-&lt;br /&gt;
| 559 || telephone_isdn       || String&lt;br /&gt;
|-&lt;br /&gt;
| 560 || telephone_pager      || String&lt;br /&gt;
|-&lt;br /&gt;
| 561 || telephone_primary    || String&lt;br /&gt;
|-&lt;br /&gt;
| 562 || telephone_radio      || String&lt;br /&gt;
|-&lt;br /&gt;
| 563 || telephone_telex      || String&lt;br /&gt;
|-&lt;br /&gt;
| 564 || telephone_ttytdd     || String&lt;br /&gt;
|-&lt;br /&gt;
| 565 || instant_messenger1   || String&lt;br /&gt;
|-&lt;br /&gt;
| 566 || instant_messenger2   || String&lt;br /&gt;
|-&lt;br /&gt;
| 567 || telephone_ip         || String&lt;br /&gt;
|-&lt;br /&gt;
| 568 || telephone_assistant  || String&lt;br /&gt;
|-&lt;br /&gt;
| 569 || company              || String&lt;br /&gt;
|-&lt;br /&gt;
| 570 || image1&lt;br /&gt;
|-&lt;br /&gt;
| 571 || userfield01&lt;br /&gt;
|-&lt;br /&gt;
| 572 || userfield02&lt;br /&gt;
|-&lt;br /&gt;
| 573 || userfield03&lt;br /&gt;
|-&lt;br /&gt;
| 574 || userfield04&lt;br /&gt;
|-&lt;br /&gt;
| 575 || userfield05&lt;br /&gt;
|-&lt;br /&gt;
| 576 || userfield06&lt;br /&gt;
|-&lt;br /&gt;
| 577 || userfield07&lt;br /&gt;
|-&lt;br /&gt;
| 578 || userfield08&lt;br /&gt;
|-&lt;br /&gt;
| 579 || userfield09&lt;br /&gt;
|-&lt;br /&gt;
| 580 || userfield10&lt;br /&gt;
|-&lt;br /&gt;
| 581 || userfield11&lt;br /&gt;
|-&lt;br /&gt;
| 582 || userfield12&lt;br /&gt;
|-&lt;br /&gt;
| 583 || userfield13&lt;br /&gt;
|-&lt;br /&gt;
| 584 || userfield14&lt;br /&gt;
|-&lt;br /&gt;
| 585 || userfield15&lt;br /&gt;
|-&lt;br /&gt;
| 586 || userfield16&lt;br /&gt;
|-&lt;br /&gt;
| 587 || userfield17&lt;br /&gt;
|-&lt;br /&gt;
| 588 || userfield18&lt;br /&gt;
|-&lt;br /&gt;
| 589 || userfield19&lt;br /&gt;
|-&lt;br /&gt;
| 590 || userfield20&lt;br /&gt;
|-&lt;br /&gt;
| 591 || links                || Array  || An array of objects containing links to other contacts. Each contact is describes by an object as defined in [[#ContactLinkData | Contact link data]].&lt;br /&gt;
|-&lt;br /&gt;
| 592 || distribution_list    || Array  || If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in [[#DistributionListMember | Distribution list member]].&lt;br /&gt;
|-&lt;br /&gt;
| 593 || context_id&lt;br /&gt;
|-&lt;br /&gt;
| 594 || number_of_distributuion_list&lt;br /&gt;
|-&lt;br /&gt;
| 595 || number_of_links&lt;br /&gt;
|-&lt;br /&gt;
| 596 || contains_image1&lt;br /&gt;
|-&lt;br /&gt;
| 597 || image_last_modified&lt;br /&gt;
|-&lt;br /&gt;
| 598 || state_other&lt;br /&gt;
|-&lt;br /&gt;
| 599 || file_as&lt;br /&gt;
|-&lt;br /&gt;
| 600 || attachment&lt;br /&gt;
|-&lt;br /&gt;
| 601 || image1_content_type&lt;br /&gt;
|-&lt;br /&gt;
| 602 || mark_as_distributionlist&lt;br /&gt;
|-&lt;br /&gt;
| 605 || default_address&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label&lt;br /&gt;
|-&lt;br /&gt;
| 524 || internal_userid&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ContactLinkData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Contact link data&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DistributionListMember&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Distribution list member&lt;br /&gt;
! Name       !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id         || String || User ID of the member if the member is an existing contact.&lt;br /&gt;
|-&lt;br /&gt;
| first_name || String || First name&lt;br /&gt;
|-&lt;br /&gt;
| last_name  || String || Last name&lt;br /&gt;
|-&lt;br /&gt;
| mail       || String || Email address&lt;br /&gt;
|-&lt;br /&gt;
| mail_field || Number || Which email field of an existing contact (if any) is used for the mail field.&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0 || independent contact&lt;br /&gt;
|-&lt;br /&gt;
| 1 || default email field (email1)&lt;br /&gt;
|-&lt;br /&gt;
| 2 || second email field (email2)&lt;br /&gt;
|-&lt;br /&gt;
| 3 || third email field (email3)&lt;br /&gt;
|}&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested contacts.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated contacts ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for contacts are defined in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested contacts.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a contact ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/contacts?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested contact.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested contact. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated contact.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Create a contact ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Contact object as described in [[#CommonObjectData | Common object data]] and [[#DetailedContactData | Detailed contact data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created contact.&lt;br /&gt;
&lt;br /&gt;
=== Delete contacts ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/contacts?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted contacts.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the fields “id” and “folder_id”. &lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Search contacts ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/contacts?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;SearchContacts&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Search contacts&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find contacts. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;calendar&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The calendar module is used to access calendar data.&lt;br /&gt;
&lt;br /&gt;
=== Get all appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; (optional) – Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedAppointmentData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed appointment data&lt;br /&gt;
! ID  !! Name        !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 400 || location    || String  || Location&lt;br /&gt;
|-&lt;br /&gt;
| 401 || full_time   || Boolean || True if the appointment is a whole day appointment, false otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 402 || shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get appointment information ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=has&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response is an array of booleans. Array length is the number of days.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of appointments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array of requested appointments. Each element identifies one appointment and is described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;FullIdentifierForAnAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Full identifier for an appointment&lt;br /&gt;
! Name !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id   || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| pos  || Number || Value of the field recurrence_position, if present in the appointment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get updated appointments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested appointments.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments are identified by objects described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]] instead of arrays. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date.&lt;br /&gt;
&lt;br /&gt;
=== Get an appointment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested appointment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested appointment. The fields of the object are listed in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Update an appointment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated appointment.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.&lt;br /&gt;
&lt;br /&gt;
=== Create an appointment ===&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/calendar?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Appointment object as described in [[#CommonObjectData | Common object data]], [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]] and [[#DetailedAppointmentData | Detailed appointment data]]. The field id is not present.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created appointment.&lt;br /&gt;
&lt;br /&gt;
=== Delete appointments ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/calendar?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted appointments.&lt;br /&gt;
&lt;br /&gt;
Request body: The appointment object to delete. The fields for the object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]]. &lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. The fields of each object are described in [[#FullIdentifierForAnAppointment | Full identifier for an appointment]].&lt;br /&gt;
&lt;br /&gt;
=== Free &amp;amp; Busy ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/calendar?action=freebusy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; - Internal user id. Must be obtained from the contact module.&lt;br /&gt;
* &amp;lt;code&amp;gt;type&amp;lt;/code&amp;gt; - Constant for user or resource&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; – Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.&lt;br /&gt;
&lt;br /&gt;
Response: An array of objects identifying the appointments which lie between start and end as described.&amp;lt;br&amp;gt;&lt;br /&gt;
This objects consist of:&lt;br /&gt;
{| id=&amp;quot;FreeAndBusyAppointment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
! Name !! Type !! Value&lt;br /&gt;
|-&lt;br /&gt;
| shown_as    || Number  || Describes, how this appointment appears in availability queries:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1 || reserved&lt;br /&gt;
|-&lt;br /&gt;
| 2 || temporary&lt;br /&gt;
|-&lt;br /&gt;
| 3 || absent&lt;br /&gt;
|-&lt;br /&gt;
| 4 || free&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| start_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|- &lt;br /&gt;
| end_date || Date or Time || see [[#DetailedTaskAndAppointmentData | Detailed task and appointment data]]&lt;br /&gt;
|-&lt;br /&gt;
| id || String || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| full_time   || Boolean || True if the appointment is a whole day appointment, not present otherwise.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;mail&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The mail module is used to access mail data.&lt;br /&gt;
&lt;br /&gt;
When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with &amp;quot;not IMAP&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Get all mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for appointments are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* TODO: Search.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedMailData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed mail data&lt;br /&gt;
! ID  !! Name                 !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 600 || id                   || String  || Object ID&lt;br /&gt;
|-&lt;br /&gt;
| 601 || folder_id            || String  || Object ID of the parent folder&lt;br /&gt;
|-&lt;br /&gt;
| 602 || attachment           || Boolean || Specifies whether this mail has attachments.&lt;br /&gt;
|-&lt;br /&gt;
| 603 || from                 || Array   || Each element is a string specifying one sender.&lt;br /&gt;
|-&lt;br /&gt;
| 604 || to                   || Array   || Each element is a string specifying one receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 605 || cc                   || Array   || Each element is a string specifying one carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 606 || bcc                  || Array   || Each element is a string specifying one blind carbon-copy receiver.&lt;br /&gt;
|-&lt;br /&gt;
| 607 || subject              || String  || Subject line.&lt;br /&gt;
|-&lt;br /&gt;
| 608 || size                 || Number  || Size of the mail in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 609 || sent_date            || Time    || Date and time as specified in the mail by the sending client.&lt;br /&gt;
|-&lt;br /&gt;
| 610 || received_date        || Time    || Date and time as measured by the receiving server.&lt;br /&gt;
|-&lt;br /&gt;
| 611 || flags                || Number  || Various system flags. A sum of zero or more of following values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1  || answered&lt;br /&gt;
|-&lt;br /&gt;
| 2  || deleted&lt;br /&gt;
|-&lt;br /&gt;
| 4  || draft&lt;br /&gt;
|-&lt;br /&gt;
| 8  || flagged&lt;br /&gt;
|-&lt;br /&gt;
| 16 || recent&lt;br /&gt;
|-&lt;br /&gt;
| 32 || seen&lt;br /&gt;
|-&lt;br /&gt;
| 64 || user&lt;br /&gt;
|}&lt;br /&gt;
See javax.mail.Flags.Flag for details.&lt;br /&gt;
|-&lt;br /&gt;
| 612 || level                || Number  || Zero-based nesting level in a thread.&lt;br /&gt;
|-&lt;br /&gt;
| 613 || disp_notification_to || String  || Content of message&#039;s header “Disposition-Notification-To”&lt;br /&gt;
|-&lt;br /&gt;
| 614 || priority             || Number  || Value of message&#039;s “X-Priority” header:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 0   || No priority&lt;br /&gt;
|-&lt;br /&gt;
| 1   || Very Low&lt;br /&gt;
|-&lt;br /&gt;
| 2   || Low&lt;br /&gt;
|-&lt;br /&gt;
| 3   || Normal&lt;br /&gt;
|-&lt;br /&gt;
| 4   || High&lt;br /&gt;
|-&lt;br /&gt;
| 5   || Very High&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
|     || user                 || Object  || An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string.&lt;br /&gt;
|-&lt;br /&gt;
|     || attachments          || Array   || Each element is an attachment as described in [[#Attachment | Attachment]]. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.&lt;br /&gt;
|-&lt;br /&gt;
|     || nested_msgs          || Array   || Each element is a mail object as described in this table, except for fields id, folder_id and attachment.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;Attachment&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || String || Object ID (unique only inside the same message)&lt;br /&gt;
|-&lt;br /&gt;
| content_type || String || MIME type&lt;br /&gt;
|-&lt;br /&gt;
| content      || String || Content as text. Present only if easily convertible to text.&lt;br /&gt;
|-&lt;br /&gt;
| filename     || String || Displayed filename (mutually exclusive with content).&lt;br /&gt;
|-&lt;br /&gt;
| size         || Number || Size of the attachment in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| disp         || String || Attachment&#039;s disposition: null, inline, attachment or alternative.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested mails.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Not IMAP: Get updated mails ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose mails are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for mails are defined in [[#DetailedMailData | Detailed mail data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested mails.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted mails. New and modified mails are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted mails are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested mail.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Get a mail attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=attachment&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the mail which contains the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt; – ID of the requested attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;save&amp;lt;/code&amp;gt; – 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.&lt;br /&gt;
&lt;br /&gt;
=== Append to a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=append&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the appended mail.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt; – Textual representation of a mail object as described in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. The object is encoded as text/javascript like the request body for PUT requests.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more attachments. n is a decimal integer starting with 0 and incrementing for every new attachment.&lt;br /&gt;
&lt;br /&gt;
This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
&lt;br /&gt;
=== Create a mail ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/mail?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;mail&amp;lt;/code&amp;gt; – Textual representation of a mail object as described in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included. The object is encoded as text/javascript like the request body for PUT requests.&lt;br /&gt;
* &amp;lt;code&amp;gt;attachment&amp;lt;/code&amp;gt;&#039;&#039;n&#039;&#039; (optional) – One or more attachments. n is a decimal integer starting with 0 and incrementing for every new attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;infostore_ids&amp;lt;/code&amp;gt; (optional) – A comma-seperated list of infostore document IDs that ought to be attached to the mail&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: Object ID of the newly created mail.&lt;br /&gt;
&lt;br /&gt;
This method uses the encoding multipart/form-data or multipart/mixed.&lt;br /&gt;
&lt;br /&gt;
=== Reply/Forward a mail ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=reply&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=replyall&amp;lt;/code&amp;gt;&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/mail?action=forward&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested Message.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; - Object ID of the folder, whose contents are queried.&lt;br /&gt;
&lt;br /&gt;
Response (not IMAP: with timestamp): An object containing all data of the requested mail. The fields of the object are listed in [[#DetailedMailData | Detailed mail data]]. The fields id and attachment are not included.&lt;br /&gt;
&lt;br /&gt;
=== Delete mails ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/mail?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* Not IMAP: &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted mails.&lt;br /&gt;
&lt;br /&gt;
Not IMAP: Response: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;groups&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a group ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/group?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The group id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for participants ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/group?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find groups. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of group objects as described in [[#GroupResponse | Group response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;GroupResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Group response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|-&lt;br /&gt;
| member       || Array  || Array of group member id&#039;s &lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;resource&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.&lt;br /&gt;
&lt;br /&gt;
=== Get a resource ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/resource?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The resource id.&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
=== Search for resources ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/resource?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with search parameters  as described in [[#ParticipantSearch | Participant search]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ParticipantSearch&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Participant search&lt;br /&gt;
! Name    !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| pattern || String || Search pattern to find resources. In the pattern, the character &amp;quot;*&amp;quot; matches zero or more characters and the character &amp;quot;?&amp;quot; matches exactly one character. All other characters match only themselves.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Response: An array of resource objects as described in [[#ResourceResponse | Resource response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ResourceResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Resource Response&lt;br /&gt;
! Name         !! Type   !! Value&lt;br /&gt;
|-&lt;br /&gt;
| id           || Number || ID&lt;br /&gt;
|-&lt;br /&gt;
| display_name || String || Display name&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;infostore&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The infostore module combines the knowledge database, bookmarks and documents.&lt;br /&gt;
&lt;br /&gt;
=== Get all infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DetailedInfoitemData&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Detailed infoitem data&lt;br /&gt;
! ID  !! Name            !! Type    !! Value&lt;br /&gt;
|-&lt;br /&gt;
| 700 || title           || String  || Title&lt;br /&gt;
|-&lt;br /&gt;
| 701 || url             || String  || Link/URL&lt;br /&gt;
|-&lt;br /&gt;
| 702 || filename        || String  || Displayed filename of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 703 || file_mimetype   || String  || MIME type of the document. The client converts known types to more readable names before displaying them.&lt;br /&gt;
|-&lt;br /&gt;
| 704 || file_size       || Number  || Size of the document in bytes.&lt;br /&gt;
|-&lt;br /&gt;
| 705 || version         || Number  || Version number of the document. New documents start at 1. Every update increments the version by 1.&lt;br /&gt;
|-&lt;br /&gt;
| 706 || description     || String  || Description&lt;br /&gt;
|-&lt;br /&gt;
| 707 || locked_until    || Time    || The time until which this item will presumably be locked. Only set if the docment is currently locked, 0 otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 708 || file_md5sum     || String  || MD5Sum of the document.&lt;br /&gt;
|-&lt;br /&gt;
| 709 || version_comment || String  || A version comment is used to file a changelog for the file.&lt;br /&gt;
|-&lt;br /&gt;
| 710 || current_version || Boolean || “true” if this version is the current version “false” otherwise.&lt;br /&gt;
|-&lt;br /&gt;
| 102 || color_label     || Number  || Color number used by Outlook to label the appointment. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers. TODO: zero allowed?&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Get a list of infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of requested infoitems.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get updated infoitems ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
* &amp;lt;code&amp;gt;ignore&amp;lt;/code&amp;gt; (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted infoitems are identified by their object IDs as plain strings, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested infoitem. The fields of the object are listed in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
=== Search infoitems ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=search&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – The requested fields as per tables [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;start&amp;lt;/code&amp;gt; (optional) – The start index (inclusive) in the ordered search, that is requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; (optional) – The last index (inclusive) from the ordered search, that is requested.&lt;br /&gt;
&lt;br /&gt;
Request body: An Object as described in [[#SearchContacts | Search contacts]].&lt;br /&gt;
&lt;br /&gt;
=== Get an infoitem document ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;version&amp;lt;/code&amp;gt; (optional) – If present the infoitem data describes the given version. Otherwise the current version is returned &lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt;(optional) – If present the response declares the given content_type in the Content-Type header.&lt;br /&gt;
&lt;br /&gt;
Response body: Rhe raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem or the content_type given.&lt;br /&gt;
&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
=== Get all versions ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=versions&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem whose versions are requested.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for infoitems are defined in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with infoitem data. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. The timestamp is the timestamp relating to the requested infostore item.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
=== Update an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=update&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Create an infoitem via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem. The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
=== Save an attachment in the infostore ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=saveAs&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object with the attachment&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object with the attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;Attachment&amp;lt;/code&amp;gt; – The id of the attachement to save.&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. The field id is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given.&lt;br /&gt;
&lt;br /&gt;
Response: Object ID of the newly created infoitem.&lt;br /&gt;
&lt;br /&gt;
=== Delete infoitems ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with object IDs of the deleted infoitems.&lt;br /&gt;
&lt;br /&gt;
Response: An array with object IDs of infoitems which were modified after the specified timestamp and were therefore not deleted.&lt;br /&gt;
&lt;br /&gt;
=== Delete versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the version numbers of the infoitems to detach.&lt;br /&gt;
&lt;br /&gt;
Response: An array with version numbers that were not deleted.&lt;br /&gt;
&lt;br /&gt;
Note: When the current version of a document is deleted the new current version will be the newest version.&lt;br /&gt;
&lt;br /&gt;
=== Delete all versions of infostore documents ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=revert&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Removes all versions of the infostore document leaving only the base object.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via PUT ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; - Timestamp of the infostore object&lt;br /&gt;
&lt;br /&gt;
Request body: Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
&lt;br /&gt;
Response: The id of the newly created object&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Copy an infostore document via POST ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/infostore?action=copy&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the updated infoitem.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.&lt;br /&gt;
* &amp;lt;code&amp;gt;json&amp;lt;/code&amp;gt; - Infoitem object as described in [[#CommonObjectData | Common object data]] and [[#DetailedInfoitemData | Detailed infoitem data]]. Only modified fields are present.&lt;br /&gt;
* &amp;lt;code&amp;gt;file&amp;lt;/code&amp;gt; – File Metadata as per &amp;lt;input type=”file” /&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Request Body: Body of content-type “multipart/form-data” or “multipart/mixed” containing the above mentioned fields and file-data.&lt;br /&gt;
&lt;br /&gt;
Response: The response is sent as a HTML document (see introduction).&lt;br /&gt;
&lt;br /&gt;
Note: Only the fields (and the file) of the current document will be copied. Those fields present in the request are modified accordingly.&lt;br /&gt;
&lt;br /&gt;
=== Lock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=lock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be locked.&lt;br /&gt;
* &amp;lt;code&amp;gt;diff&amp;lt;/code&amp;gt; (optional) – If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only include errors.&lt;br /&gt;
&lt;br /&gt;
=== Unlock an infoitem ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/infostore?action=unlock&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the infoitem that should be unlocked.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: Can only contain errors.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Links&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The link module provides the ability to connect two objects from any module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Links from an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/link?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all Links ([[#LinkObject | Link object]]) from the given Object ID.&lt;br /&gt;
&lt;br /&gt;
=== Create a Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=new&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: Link object as described in [[#LinkObject | Link object]].&lt;br /&gt;
&lt;br /&gt;
Response: An OK.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;LinkObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Link Object&lt;br /&gt;
! Field              !! Name    !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| First Object ID    || id1     || Number || The ID of the first Object you want to start to link&lt;br /&gt;
|-&lt;br /&gt;
| First Module Type  || module1 || Number || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| First Folder ID    || folder1 || String || The Folder of this Object&lt;br /&gt;
|-&lt;br /&gt;
| Second Object ID   || id2     || Number || The ID of the second Object you want to link the first Object with&lt;br /&gt;
|-&lt;br /&gt;
| Second Module Type || module2 || Number || The Module of the second Object&lt;br /&gt;
Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 13  || Project&lt;br /&gt;
|-&lt;br /&gt;
| 17  || Forum&lt;br /&gt;
|-&lt;br /&gt;
| 18  || Pin board&lt;br /&gt;
|-&lt;br /&gt;
| 19  || Email&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| Second Folder ID   || folder2 || String || The Folder of the second Object&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: A List of arrays with the information of the Links to delete which looks like [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
Response: A List of arrays with object Ids of links which are not readable by the user and were therefore not deleted. See [[#DeleteObject | Delete object]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;DeleteObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Delete Object&lt;br /&gt;
! Field     !! Type   !! Array Position&lt;br /&gt;
|-&lt;br /&gt;
| Object id || Number || 0&lt;br /&gt;
|-&lt;br /&gt;
| Module    || Number || 1&lt;br /&gt;
|-&lt;br /&gt;
| Folder    || String || 2&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;Attachments&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The Attachment Module allows file attachments to arbitrary objects. Object addresses are defined analogous to the Link module. An Attachment always belongs to an object (called &#039;attached&#039;) in a certain folder of a certain module.  &lt;br /&gt;
&lt;br /&gt;
=== Get All Attachments for an Object ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=all&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachment&#039;s are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
&lt;br /&gt;
Response: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Get a list of attachments ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=list&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The Object ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder ID of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The Module type of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array of with object IDs of requested tasks.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with attachment data. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter.&lt;br /&gt;
&lt;br /&gt;
=== Create an Attachment ===&lt;br /&gt;
&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/attachment?action=attach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;json_[index]&amp;lt;/code&amp;gt; – The JSON representation of an attachment object as described in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;file_[index]&amp;lt;/code&amp;gt; – The file metadata as per &amp;lt;input type=file /&amp;gt; upload.&lt;br /&gt;
&lt;br /&gt;
Note: The JSON Object and file fields describe the corresponding attachment. For ex.: json_0 contains metadata for file_0, json_1 for file_1 and so on. Indexes start with 0.&lt;br /&gt;
&lt;br /&gt;
Request body: multipart/form-data or multipart/mixed containing the file data of the attached file and the above fields.&lt;br /&gt;
&lt;br /&gt;
Response: HTML page with javascript callback as per introduction. Contains a JSON-Array of ids of the newly created attachments. The order of the ids corresponds to the indexes in the request.&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;AttachmentObject&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Attachment Object&lt;br /&gt;
! ID  !! Name          !! Type    !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 800 || folder        || Number  || The ID of the first Folder in which the attached object resides.&lt;br /&gt;
|-&lt;br /&gt;
| 801 || attached      || Number  || The object id of the object this attachement is attached to.&lt;br /&gt;
|-&lt;br /&gt;
| 802 || module        || Number  || The Module of this Object Possible Values:&lt;br /&gt;
{| cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
| 1   || Appointment&lt;br /&gt;
|-&lt;br /&gt;
| 4   || Task&lt;br /&gt;
|-&lt;br /&gt;
| 7   || Contact&lt;br /&gt;
|-&lt;br /&gt;
| 137 || Infostore&lt;br /&gt;
|}&lt;br /&gt;
|-&lt;br /&gt;
| 803 || filename      || String  || The filename of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 804 || file_size     || Number  || The file size (in bytes) of the attached file.&lt;br /&gt;
|-&lt;br /&gt;
| 805 || file_mimetype || String  || The MIME-Type of the attached file&lt;br /&gt;
|-&lt;br /&gt;
| 806 || rft_flag      || Boolean || If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents).&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Attachment ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/attachment?action=detach&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – The ID of the base Object&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – The type of the Object&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – The Folder of the Object&lt;br /&gt;
&lt;br /&gt;
Request body: An array with the ids of the attachments to delete.&lt;br /&gt;
&lt;br /&gt;
=== Get updated attachments ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment?action=updates&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – A comma-separated list of columns to return. Each column is specified by a numeric column identifier. Column identifiers for attachments are defined in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]].&lt;br /&gt;
* &amp;lt;code&amp;gt;sort&amp;lt;/code&amp;gt; (optional) – The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;order&amp;lt;/code&amp;gt; (optional) – &amp;quot;asc&amp;quot; if the response entires should be sorted in the ascending order, &amp;quot;desc&amp;quot; if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.&lt;br /&gt;
* &amp;lt;code&amp;gt;timestamp&amp;lt;/code&amp;gt; – Timestamp of the last update of the requested infoitems.&lt;br /&gt;
ignore (optional) – Which kinds of updates should be ignored. Currently, the only valid value – &amp;quot;deleted&amp;quot; – causes deleted object IDs not to be returned.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An array with new and deleted attachments for the specified object. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments are identified by their object IDs as plain numbers, without being part of a nested array.&lt;br /&gt;
&lt;br /&gt;
=== Get an attachment ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attahment?action=get&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
&lt;br /&gt;
Response with timestamp: An object containing all data of the requested attachment. The fields of the object are listed in [[#CommonObjectData | Common object data]] (with only id, created_by and creation_date available) and [[#AttachmentObject | Attachment object]]. &lt;br /&gt;
&lt;br /&gt;
=== Get an attachments filedata ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/attachment/[filename]?action=document&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – Object ID of the folder, whose contents are queried.&lt;br /&gt;
* &amp;lt;code&amp;gt;attached&amp;lt;/code&amp;gt; – Object ID of the object to which the attachments are attached.&lt;br /&gt;
* &amp;lt;code&amp;gt;module&amp;lt;/code&amp;gt; – Module ID (as per [[#AttachmentObject | Attachment object]]) of the attached object.&lt;br /&gt;
* &amp;lt;code&amp;gt;id&amp;lt;/code&amp;gt; – Object ID of the requested attachment.&lt;br /&gt;
* &amp;lt;code&amp;gt;content_type&amp;lt;/code&amp;gt; (optional) – If set the responses Content-Type header is set to this value, not the attachements file mime type.&lt;br /&gt;
&lt;br /&gt;
Response body: The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this infoitem.&lt;br /&gt;
Note: The Filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;reminder&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The reminder module provides the ability to fetch all active reminders for a user between two dates.&lt;br /&gt;
&lt;br /&gt;
=== Get reminder range ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/reminder?action=range&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;end&amp;lt;/code&amp;gt; – The End date of the reminder range&lt;br /&gt;
&lt;br /&gt;
Response: An Array with all reminders which are scheduled until the specified time. Each reminder is described in [[#ReminderResponse | Reminder response]].&lt;br /&gt;
&lt;br /&gt;
{| id=&amp;quot;ReminderResponse&amp;quot; cellspacing=&amp;quot;0&amp;quot; border=&amp;quot;1&amp;quot;&lt;br /&gt;
|+ align=&amp;quot;bottom&amp;quot; | Reminder response&lt;br /&gt;
! Field     !! Type   !! Description&lt;br /&gt;
|-&lt;br /&gt;
| object_id || Number || The ID of the reminder.&lt;br /&gt;
|-&lt;br /&gt;
| target_id || Number || The target_id where this reminder is attached to&lt;br /&gt;
|-&lt;br /&gt;
| alarm     || Time   || The time of the alarm&lt;br /&gt;
|-&lt;br /&gt;
| module    || Number || The module of the reminder&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Delete Link ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/link?action=delete&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Request body: An object with the field “id”.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;multiple&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The multiple module allows to bundle multiple requests to most other modules in a single request. Not supported are:&lt;br /&gt;
* modules login, config and multiple,&lt;br /&gt;
* POST requests with a multipart encoding (uploads),&lt;br /&gt;
* GET requests which do not use an object as described in [[#ResponseBody | Response body]] as response body (downloads).&lt;br /&gt;
&lt;br /&gt;
=== Multiple requests ===&lt;br /&gt;
&lt;br /&gt;
PUT &amp;lt;code&amp;gt;/ajax/multiple&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;continue&amp;lt;/code&amp;gt; – Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.&lt;br /&gt;
&lt;br /&gt;
Request body: An array with request objects. Each request object contains all URI parameters of the &amp;quot;normal&amp;quot; request as fields. The module name of the &amp;quot;normal&amp;quot; request is included in the field module. The parameter session is not included. If the &amp;quot;normal&amp;quot; request has a request body, the object which is represented by that request body is includes as the value of the field data.&lt;br /&gt;
&lt;br /&gt;
Response: An array with reply objects as described in [[#ResponseBody | Response body]]. The order of reply objects corresponds to the order of requests in the request body. Unlike with all other modules, this response is itself not part of a response object as described in [[#ResponseBody | Response body]].&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;quota&amp;quot; ==&lt;br /&gt;
&lt;br /&gt;
The filestore module allows accesssing information about the use and quota of the filestore.&lt;br /&gt;
&lt;br /&gt;
=== Get the filestore usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=filestore&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the uploaded files sizes sum and the field “quota” represents the maximum.&lt;br /&gt;
&lt;br /&gt;
=== Get the mail usage data ===&lt;br /&gt;
&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/quota?action=mail&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
&lt;br /&gt;
Response: A JSON Object containing the fields “use” and “quota”. “use” represents the use mail quota and the field “quota” represents the maximum. -1 represents an unlimited quota.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;import&amp;quot;==&lt;br /&gt;
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder.&lt;br /&gt;
&lt;br /&gt;
=== Import CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file. The column titles of the table are those used within the OX.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import Outlook CSV ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=OUTLOOK_CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An .CSV file. The column titles of the table are those used by the English version of Outlook.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import iCAL ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This may be an Appointment or a Task folder. May even be a list containing both.&lt;br /&gt;
&lt;br /&gt;
Request body: An iCalendar file.&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
=== Import vCard ===&lt;br /&gt;
POST &amp;lt;code&amp;gt;/ajax/import?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder into which data should be imported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Request body: An vCard file, maybe of the formats: vCard 2.1, vCard 3.0 or vCalendar 1.0&lt;br /&gt;
&lt;br /&gt;
Response: An array of JSON-Objects, one for each entry in the list, containing: The Object ID of the entry, the Object ID of the folder the data was written into, a timestamp of the modification (in case of error, of modification attempt) and an error in case the data could not be entered.&lt;br /&gt;
&lt;br /&gt;
== Module &amp;quot;export&amp;quot; ==&lt;br /&gt;
The module export allows to export specific module data (like Contacts, Tasks or Appointments) from a folder in several formats (iCal, vCard, CSV).&lt;br /&gt;
&lt;br /&gt;
=== Exporting CSV ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=CSV&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
* &amp;lt;code&amp;gt;columns&amp;lt;/code&amp;gt; – (optional) Columns to be imported from the given file, given as an array of column numbers. See [[#DetailedContactData | Detailed contact data]] for numbers.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file of the MIME type &amp;lt;code&amp;gt;text/csv&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting iCAL ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=ICAL&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/calendar&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Exporting vCard ===&lt;br /&gt;
GET &amp;lt;code&amp;gt;/ajax/export?action=VCARD&amp;lt;/code&amp;gt; &lt;br /&gt;
&lt;br /&gt;
Parameters:&lt;br /&gt;
* &amp;lt;code&amp;gt;session&amp;lt;/code&amp;gt; – A session ID previously obtained from the login module.&lt;br /&gt;
* &amp;lt;code&amp;gt;folder&amp;lt;/code&amp;gt; – ObjectID of the folder whose contents are to be exported. This must be a Contact folder.&lt;br /&gt;
&lt;br /&gt;
Response: An InputStream containing the file, of the MIME type &amp;lt;code&amp;gt;text/x-vcard&amp;lt;/code&amp;gt;.&lt;/div&gt;</summary>
		<author><name>Stefan.preuss</name></author>
	</entry>
</feed>