## 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
+
+### POST api/friendica/event_create
+
+Create a new event for the current logged in user.
+
+#### Parameters
+
+- `id` : (optional) id of event, event will be amended if supplied
+- `name` : name of the event (required)
+- `start_time` : start of the event (ISO), required
+- `end_time` : (optional) end of the event, event is open end, if not supplied
+- `desc` : (optional) description of the event
+- `place` : (optional) location of the event
+- `publish` : (optional) create message for event
+- `allow_cid` : (optional) ACL-formatted list of allowed contact ids if private event
+- `allow_gid` : (optional) ACL-formatted list of disallowed contact ids if private event
+- `deny_cid` : (optional) ACL-formatted list of allowed group ids if private event
+- `deny_gid` : (optional) ACL-formatted list of disallowed group ids if private event
+
+### POST api/friendica/event_delete
+
+Delete event from calendar (not the message)
+
+#### Parameters
+
+- `id` : id of event to be deleted
+
### GET api/externalprofile/show
Returns a [Contact](help/API-Entities#Contact) entity for the provided profile URL.
* `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.
* `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.
* `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.
* `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.
```json
{
- "id": "photo id"
+ "id": "photo id",
"created": "date(YYYY-MM-DD HH:MM:SS)",
"edited": "date(YYYY-MM-DD HH:MM:SS)",
"title": "photo title",
"width": "number",
"profile": "1 if is profile photo",
"link": {
- "<scale>": "url to image"
+ "<scale>": "url to image",
...
},
// if 'scale' is set
```json
[
{
- id: "resource_id",
- album: "album name",
- filename: "original file name",
- type: "image mime type",
- thumb: "url to thumb sized image"
+ "id": "resource_id",
+ "album": "album name",
+ "filename": "original file name",
+ "type": "image mime type",
+ "thumb": "url to thumb sized image"
},
...
]
"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.
---
-### 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.
* 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.
### GET api/friendica/profile/show
-Returns the [Profile](help/API-Entities#Profile) data of all profiles or a single profile of the authenticated user.
-
-#### Parameters
-
-* `profile_id` (optional): id of the profile to be returned. If omitted all profiles are returned by default.
+Returns the [Profile](help/API-Entities#Profile) data of the authenticated user.
#### Return values
On success: Array of:
-* `multi_profiles`: true if user has activated multi_profiles
* `global_dir`: URL of the global directory set in server settings
* `friendica_owner`: user data of the authenticated user
* `profiles`: array of the profile data
HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
General description of profile data in API returns:
+- hide_friends: true if friends are hidden
+- profile_photo
+- profile_thumb
+- publish: true if published on the server's local directory
+- net_publish: true if published to global_dir
+- fullname
+- date_of_birth
+- description
+- xmpp
+- homepage
+- address
+- locality
+- region
+- postal_code
+- country
+- pub_keywords
+- custom_fields: list of public custom fields
---
-### 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
projects / friendica.git / blobdiff