X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2Fapi.md;h=7d6f440c58c0008ecbaf909048c194f1b09c52ff;hb=3948e2923a3e325c65a6cc66e8a898103aed9a76;hp=f050ae4304f98d7682003100eee6781ce2c63aff;hpb=870d2f844d83741c7fc1878dda72807dab92d992;p=friendica.git
diff --git a/doc/api.md b/doc/api.md
index f050ae4304..7d6f440c58 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -1,6 +1,6 @@
Friendica API
===
-The Friendica API aims to be compatible to the [GNU Social API](http://skilledtests.com/wiki/Twitter-compatible_API) and the [Twitter API](https://dev.twitter.com/rest/public).
+The Friendica API aims to be compatible to the [GNU Social API](http://wiki.gnusocial.de/gnusocial:api) and the [Twitter API](https://dev.twitter.com/rest/public).
Please refer to the linked documentation for further information.
@@ -52,20 +52,20 @@ Error body is
json:
```
-{
-"error": "Specific error message",
-"request": "API path requested",
-"code": "HTTP error code"
-}
+ {
+ "error": "Specific error message",
+ "request": "API path requested",
+ "code": "HTTP error code"
+ }
```
xml:
```
-
-Specific error message
-API path requested
-HTTP error code
-
+
+ Specific error message
+ API path requested
+ HTTP error code
+
```
---
@@ -388,6 +388,18 @@ Friendica doesn't allow showing friends of other users.
---
### statusnet/config (*)
+---
+### statusnet/conversation (*; AUTH)
+It shows all direct answers (excluding the original post) to a given id.
+
+#### Parameter
+* id: id of the post
+* count: Items per page (default: 20)
+* page: page number
+* since_id: minimal id
+* max_id: maximum id
+* include_entities: "true" shows entities for pictures and links (Default: false)
+
---
### statusnet/version (*)
@@ -605,47 +617,47 @@ An image used as profile image has only scale 4-6, other images only 0-3
json
```
-{
-"id": "photo id"
-"created": "date(YYYY-MM-GG HH:MM:SS)",
-"edited": "date(YYYY-MM-GG HH:MM:SS)",
-"title": "photo title",
-"desc": "photo description",
-"album": "album name",
-"filename": "original file name",
-"type": "mime type",
-"height": "number",
-"width": "number",
-"profile": "1 if is profile photo",
-"link": {
-"": "url to image"
-...
-},
-// if 'scale' is set
-"datasize": "size in byte",
-"data": "base64 encoded image data"
-}
+ {
+ "id": "photo id"
+ "created": "date(YYYY-MM-GG HH:MM:SS)",
+ "edited": "date(YYYY-MM-GG HH:MM:SS)",
+ "title": "photo title",
+ "desc": "photo description",
+ "album": "album name",
+ "filename": "original file name",
+ "type": "mime type",
+ "height": "number",
+ "width": "number",
+ "profile": "1 if is profile photo",
+ "link": {
+ "": "url to image"
+ ...
+ },
+ // if 'scale' is set
+ "datasize": "size in byte",
+ "data": "base64 encoded image data"
+ }
```
xml
```
-
-photo id
-date(YYYY-MM-GG HH:MM:SS)
-date(YYYY-MM-GG HH:MM:SS)
-photo title
-photo description
-album name
-original file name
-mime type
-number
-number
-1 if is profile photo
-
-
-...
-
-
+
+ photo id
+ date(YYYY-MM-GG HH:MM:SS)
+ date(YYYY-MM-GG HH:MM:SS)
+ photo title
+ photo description
+ album name
+ original file name
+ mime type
+ number
+ number
+ 1 if is profile photo
+
+
+ ...
+
+
```
---
@@ -657,29 +669,29 @@ Returns a list of all photo resources of the logged in user.
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"
+ },
+ ...
+ ]
```
xml
```
-
-
-"url to thumb sized image"
-
-...
-
+
+
+ "url to thumb sized image"
+
+ ...
+
```