From 6731635debc7a84924e8c64fe22c185cfd6a96b2 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Petr=20P=C3=ADsa=C5=99?= Date: Tue, 12 Jan 2010 00:01:26 +0100 Subject: [PATCH] doc: Update GetListOf*Messages to spec. 2.1 --- doc/user_web_services | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/user_web_services b/doc/user_web_services index e5f4631..777e59d 100644 --- a/doc/user_web_services +++ b/doc/user_web_services @@ -256,6 +256,18 @@ GetListOfSentMessages Download list of outgoing messages matching search criteria. +Criteria are: delivery time not before, not after, organisation unit number of +sender, message status filter, offset of first message in a list and limit on +number of messages to get. + +Message status filter is union of distinct message states expressed as +exponents of 2. Effectively it's a polynom \sum_{x \in message_statux} 2^x. +Special value -1 means all messages. Meaning for value 1 or 0 is undefined. + +Messages are sorted in order of delivery time. + +Offset starts on 1. Limit defaults to 1000. + Non-normative error codes: 2017 Syntax error in date-time -- 2.11.4.GIT