diff --git a/doc/API-Entities.md b/doc/API-Entities.md index b234912acd..e369cb4ffd 100644 --- a/doc/API-Entities.md +++ b/doc/API-Entities.md @@ -361,6 +361,123 @@ Ex: Wed May 23 06:01:13 +0000 2007 +## Event + +
Attribute | +Type | +Description | +
---|---|---|
id |
+Integer | ++ |
uid |
+Integer | +Owner User Id | +
cid |
+Integer | +Target Contact Id | +
uri |
+String | +Item unique URI string | +
name |
+String (Plaintext) | +Title | +
desc |
+String (HTML) | +Description | +
startTime |
+String (UTC YYYY-MM-DD HH:II:SS) ) |
++ |
endTime |
+String (UTC YYYY-MM-DD HH:II:SS) ) |
+Optional (null date is 0001-01-01 00:00:00 |
+
type |
+String (event or birthday ) |
++ |
nofinish |
+Boolean | +Ongoing event | +
place |
+String | +Optional. Location. | +
adjust |
+Boolean | +??? | +
ignore |
+Boolean | +??? | +
allow_cid |
+String (angle-brackets escaped integers) | +Optional. List of allowed contact ids | +
allow_gid |
+String (angle-brackets escaped integers) | +Optional. List of allowed group ids | +
deny_cid |
+String (angle-brackets escaped integers) | +Optional. List of disallowed contact ids | +
deny_gid |
+String (angle-brackets escaped integers) | +Optional. List of disallowed group ids | +