X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2FAPI-Friendica.md;h=726accf62aef8ca3380cdc120b4ea4bd0bdbe815;hb=204e52ea307b182175ae0c64d6eb69c71a104658;hp=013dd08f59584ebb349e758d961d99e78e97b978;hpb=dad530802f2af7e3b522d59e73d547812169daf0;p=friendica.git diff --git a/doc/API-Friendica.md b/doc/API-Friendica.md index 013dd08f59..726accf62a 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. @@ -211,7 +220,7 @@ Deprecated Twitter sent direct message list endpoint. Returns [Private Messages] * `friendica_verbose`: "true" enables different error returns (default: "false") -### POST/PUT api/direct_messages/new +### POST api/direct_messages/new Deprecated Twitter direct message submission endpoint. @@ -223,7 +232,7 @@ Deprecated Twitter direct message submission endpoint. * `replyto`: ID of the replied direct message * `title`: Title of the direct message -### POST/DELETE api/direct_messages/destroy +### POST api/direct_messages/destroy Deprecated Twitter direct message deletion endpoint. @@ -304,7 +313,7 @@ Array of: * `gid`: id of the group * `user`: array of [Contacts](help/API-Entities#Contact) -### POST/PUT api/friendica/group_create +### POST api/friendica/group_create Create the group with the posted array of contacts as members. @@ -357,7 +366,7 @@ Array of: * `status`: "missing user" | "ok" * `wrong users`: array of users, which were not available in the contact table -### POST/DELETE api/friendica/group_delete +### POST api/friendica/group_delete Delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted. @@ -556,7 +565,7 @@ On error: "unknown error - update photo entry in database failed", "unknown error - this error on uploading or updating a photo should never happen" -### DELETE api/friendica/photo/delete +### POST api/friendica/photo/delete Deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this Sets item table entries for this photo to deleted = 1. @@ -586,7 +595,7 @@ On error: --- -### POST/DELETE api/friendica/photoalbum/delete +### POST api/friendica/photoalbum/delete Deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this. @@ -613,7 +622,7 @@ On error: * 400 BADREQUEST: "no albumname specified", "album not available" * 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed" -### POST/PUT api/friendica/photoalbum/update +### POST api/friendica/photoalbum/update Changes the album name to album_new for all photos in album. @@ -680,15 +689,6 @@ General description of profile data in API returns: --- -### GET api/friendica/remoteauth - -Similar as /redir, redirects to `url` after DFRN authentication. - -#### Parameters - -- `c_url`: url of remote contact to auth to -- `url`: string, url to redirect after auth - ## Deprecated endpoints - POST api/statuses/mediap