X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fapi.md;h=58413b2e64df08ceab343c9fc51535d35a945383;hb=939364f9a0b40eaa0c87e111074122ff3ff12323;hp=b61fb8aa66eb8c0a0e68ea731c59deb89fb6c051;hpb=cf063b2045e3a541d1655df7ed6d3be13b539487;p=friendica.git diff --git a/doc/api.md b/doc/api.md index b61fb8aa66..58413b2e64 100644 --- a/doc/api.md +++ b/doc/api.md @@ -294,12 +294,103 @@ 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 * media: image data +#### Return values + +Object of: + +* media_id: a media identifier (integer) +* media_id_string: a media identifier (string) +* size: size in byte +* image.w: image width +* image.h: image height +* image.image_type: image mime type +* image.friendica_preview_url: image preview url + --- ### oauth/request_token (*) @@ -354,6 +445,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 +646,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 (*) @@ -592,6 +751,7 @@ Friendica doesn't allow showing followers of other users. #### Parameters * q: search query +* friendica_tag: search hashtag (optional; query condition only accept one of the two [ q | friendica_tag ] ) * page: the page number (starting at 1) to return * rpp: the number of statuses to return per page * count: alias for the rpp parameter @@ -609,6 +769,18 @@ Friendica doesn't allow showing followers of other users. --- +### search/tweets (*; AUTH) + +This is an alias for `search`. + +--- + +### saved_searches/list (*; AUTH) + +This call does not have any parameter. + +--- + ### users/search (*) #### Parameters @@ -680,6 +852,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 @@ -885,7 +1074,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 @@ -1186,7 +1375,6 @@ The following API calls from the Twitter API are not implemented in either Frien * statuses/retweeters/ids * statuses/lookup * direct_messages/show -* search/tweets * friendships/no_retweets/ids * friendships/outgoing * friendships/update @@ -1194,8 +1382,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 -* account/update_profile_background_image * blocks/ids * users/show * users/search @@ -1211,7 +1397,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 @@ -1222,14 +1407,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/list * saved_searches/show/:id * saved_searches/create * saved_searches/destroy/:id