X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2Fapi.md;h=2715f44462ea2392e7cc20ddde78362df97ac74d;hb=0441a169a932c3ba19a2fedc16b4db895cdec127;hp=c565d8699c0e8d26b2d0595008cb78491928a160;hpb=0a7f1761e6dfbb1d600f5b937153ab9892956ecf;p=friendica.git diff --git a/doc/api.md b/doc/api.md index c565d8699c..2715f44462 100644 --- a/doc/api.md +++ b/doc/api.md @@ -294,6 +294,85 @@ Friendica doesn't allow showing the friends of other users. --- +### lists/ownerships (*; AUTH) + +#### Parameters + +* list_id: ID of the list +* count: Items per page +* page: Page number +* since_id: Minimum ID +* max_id: Maximum ID + +#### Unsupported parameters + +* slug +* owner_screen_name +* owner_id +* include_entities +* include_rts + +--- + +### lists/destroy (POST; AUTH) + +#### Parameters + +* list_id: ID of the list + +#### Unsupported parameters + +* owner_screen_name +* owner_id +* slug + +--- + +### lists/create (POST; AUTH) + +#### Parameters + +* name: name of the list + +#### Unsupported parameters + +* mode +* description + +--- + +### lists/update (POST; AUTH) + +#### Parameters + +* list_id: ID of the list +* name: name of the list + +#### Unsupported parameters + +* slug +* name +* mode +* description +* owner_screen_name +* owner_id + +--- + +### lists/statuses (*; AUTH) + +#### Parameters + +* user_id: ID of the user for whom to return results. + +#### Unsupported parameters + +* screen_name +* count +* cursor + +--- + ### media/upload (POST,PUT; AUTH) #### Parameters @@ -354,6 +433,7 @@ Friendica doesn't allow showing the friends of other users. #### Parameters * include_entities: "true" shows entities for pictures and links (Default: false) +* count: how many items should be shown (Default: 20) --- @@ -554,6 +634,73 @@ Friendica doesn't allow showing the friends of other users. * trim_user * contributor_details +--- + +### Return values for statuses/* api calls + +Returned status object is conform to GNU Social/Twitter api. + +Friendica adds some addictional fields: + +- owner: a user object, it's the owner of the item. +- private: boolean, true if the item is marked as private +- activities: map with activities related to the item. Every activity is a list of user objects. + +This properties are prefixed with "friendica_" in JSON responses and namespaced under "http://friendi.ca/schema/api/1/" in XML responses + +JSON: + +```json +[ + { + // ... + 'friendica_owner' : { + // user object + }, + 'friendica_private' : true, + 'friendica_activities': { + 'like': [ + { + // user object + }, + // ... + ], + 'dislike': [], + 'attendyes': [], + 'attendno': [], + 'attendmaybe': [] + } + }, + // ... +] +``` + +XML: + +```xml + + + + + true + + + + + + + + + + + + + + + +``` + + --- ### statusnet/config (*) @@ -692,6 +839,23 @@ On error: --- +### account/update_profile (POST; AUTH) + +#### Parameters + +* name (optional): full name of the user +* description (optional): a description of the user + +#### Unsupported parameters + +* url +* location +* profile_link_color +* include_entities +* skip_status + +--- + ### friendships/incoming (*; AUTH) #### Unsupported parameters @@ -897,7 +1061,7 @@ possibile scale value are: * 1: image with or height at <= 640 * 2: image with or height at <= 320 * 3: thumbnail 160x160 -* 4: Profile image at 175x175 +* 4: Profile image at 300x300 * 5: Profile image at 80x80 * 6: Profile image at 48x48 @@ -1205,7 +1369,6 @@ The following API calls from the Twitter API are not implemented in either Frien * friendships/lookup * account/settings * account/update_delivery_device -* account/update_profile * blocks/ids * users/show * users/search @@ -1221,7 +1384,6 @@ The following API calls from the Twitter API are not implemented in either Frien * users/suggestions/:slug/members * favorites/list * lists/list -* lists/statuses * lists/members/destroy * lists/memberships * lists/subscribers @@ -1232,13 +1394,9 @@ The following API calls from the Twitter API are not implemented in either Frien * lists/members/show * lists/members * lists/members/create -* lists/destroy -* lists/update -* lists/create * lists/show * lists/subscriptions * lists/members/destroy_all -* lists/ownerships * saved_searches/show/:id * saved_searches/create * saved_searches/destroy/:id