]> git.mxchange.org Git - friendica.git/commitdiff
move account/update_profile_image to section with general API's
authorgerhard6380 <gerhard@seeber.at>
Sat, 6 May 2017 23:39:37 +0000 (01:39 +0200)
committergerhard6380 <gerhard@seeber.at>
Sat, 6 May 2017 23:39:37 +0000 (01:39 +0200)
doc/api.md

index 35a5a8c6caaf52163900439bb7be42fbd616851d..d1f2ebc86b5fb9a35d04210f8b60ea83aabfe983 100644 (file)
@@ -460,6 +460,28 @@ Friendica doesn't allow showing followers of other users.
 Friendica doesn't allow showing friends of other users.\r
 \r
 \r
+---\r
+### account/update_profile_image (POST; AUTH)\r
+#### Parameters\r
+* image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)\r
+* profile_id (optional): id of the profile for which the image should be used, default is changing the default profile\r
+\r
+uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo\r
+\r
+#### Return values\r
+\r
+On success:\r
+* JSON return: returns the updated user details (see account/verify_credentials)\r
+\r
+On error:\r
+* 403 FORBIDDEN: if not authenticated\r
+* 400 BADREQUEST: "no media data submitted", "profile_id not available"\r
+* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server", \r
+                       "image size exceeds Friendica Config setting (uploaded size: x)", \r
+                       "unable to process image data", \r
+                       "image upload failed"\r
+\r
+\r
 ## Implemented API calls (not compatible with other APIs)\r
 \r
 \r
@@ -765,7 +787,7 @@ On error:
 * desc (optional): description for the photo, updated when photo_id is specified\r
 * album: name of the album to be deleted (always necessary)\r
 * album_new (optional): can be used to change the album of a single photo if photo_id is specified\r
-* allow_cid/allow_gid/deny_cid/deny_gid (optional): on create: empty string or omitting = public photo, specify in format '<x><y><z>' for private photo; \r
+* allow_cid/allow_gid/deny_cid/deny_gid (optional): on create: empty string or omitting = public photo, specify in format '```<x><y><z>```' for private photo; \r
                        on update: keys need to be present with empty values for setting a private photo now to public\r
 \r
 both calls point to one function for creating AND updating photos. Saves data for the scales 0-2 to database (see above for scale description). Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo. \r
@@ -811,28 +833,6 @@ On error:
 * 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"\r
 \r
 \r
----\r
-### account/update_profile_image (POST; AUTH)\r
-#### Parameters\r
-* image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)\r
-* profile_id (optional): id of the profile for which the image should be used, default is changing the default profile\r
-\r
-uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo\r
-\r
-#### Return values\r
-\r
-On success:\r
-* JSON return: returns the updated user details (see account/verify_credentials)\r
-\r
-On error:\r
-* 403 FORBIDDEN: if not authenticated\r
-* 400 BADREQUEST: "no media data submitted", "profile_id not available"\r
-* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server", \r
-                       "image size exceeds Friendica Config setting (uploaded size: x)", \r
-                       "unable to process image data", \r
-                       "image upload failed"\r
-\r
-\r
 ---\r
 ### friendica/direct_messages_setseen (GET; AUTH)\r
 #### Parameters\r