From 035139d3883da1f4ff584e6120865064d3879788 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sun, 16 Feb 2020 12:09:07 -0500 Subject: [PATCH] Add documentation for api/friendica/events endpoint --- doc/API-Entities.md | 117 +++++++++++++++++++++++++++++++++++++++++++ doc/API-Friendica.md | 9 ++++ 2 files changed, 126 insertions(+) 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeTypeDescription
idInteger
uidIntegerOwner User Id
cidIntegerTarget Contact Id
uriStringItem unique URI string
nameString (Plaintext)Title
descString (HTML)Description
startTimeString (UTC YYYY-MM-DD HH:II:SS))
endTimeString (UTC YYYY-MM-DD HH:II:SS))Optional (null date is 0001-01-01 00:00:00
typeString (event or birthday)
nofinishBooleanOngoing event
placeStringOptional. Location.
adjustBoolean???
ignoreBoolean???
allow_cidString (angle-brackets escaped integers)Optional. List of allowed contact ids
allow_gidString (angle-brackets escaped integers)Optional. List of allowed group ids
deny_cidString (angle-brackets escaped integers)Optional. List of disallowed contact ids
deny_gidString (angle-brackets escaped integers)Optional. List of disallowed group ids
+ ## Hashtag Unused diff --git a/doc/API-Friendica.md b/doc/API-Friendica.md index 013dd08f59..62a71dc6b1 100644 --- a/doc/API-Friendica.md +++ b/doc/API-Friendica.md @@ -15,6 +15,15 @@ These endpoints uses the [Friendica API entities](help/API-Entities). ## Endpoints +### GET api/friendica/events + +Returns a list of [Event](help/API-Entities#Event) entities for the current logged in user. + +#### Parameters + +- `since_id`: (optional) minimum event id for pagination +- `count`: maximum number of items returned, default 20 + ### GET api/externalprofile/show Returns a [Contact](help/API-Entities#Contact) entity for the provided profile URL.