X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2Fapi.md;h=bf1507adba7527bb20e62d7b71a92369212e46d1;hb=61da46677d0d7892dfe6cfc6c09c80211df34d90;hp=02295a95fef7567afed75bcfe7b347be4b26a151;hpb=7daaaf0ab88c47d8df0973f9e1063c5eaa620c43;p=friendica.git

diff --git a/doc/api.md b/doc/api.md
index 02295a95fe..bf1507adba 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -104,7 +104,7 @@ Unofficial Twitter command. It shows all direct answers (excluding the original
 * max_id: maximum id
 * getText: Defines the format of the status field. Can be "html" or "plain"
 * include_entities: "true" shows entities for pictures and links (Default: false)
-* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")
+* friendica_verbose: "true" enables different error returns (default: "false")
 
 #### Unsupported parameters
 * skip_status
@@ -117,7 +117,7 @@ Unofficial Twitter command. It shows all direct answers (excluding the original
 * since_id: minimal id
 * max_id: maximum id
 * getText: Defines the format of the status field. Can be "html" or "plain"
-* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")
+* friendica_verbose: "true" enables different error returns (default: "false")
 
 ---
 ### direct_messages/conversation (*; AUTH)
@@ -129,7 +129,7 @@ Shows all direct messages of a conversation
 * max_id: maximum id
 * getText: Defines the format of the status field. Can be "html" or "plain"
 * uri: URI of the conversation
-* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")
+* friendica_verbose: "true" enables different error returns (default: "false")
 
 ---
 ### direct_messages/sent (*; AUTH)
@@ -140,7 +140,7 @@ Shows all direct messages of a conversation
 * max_id: maximum id
 * getText: Defines the format of the status field. Can be "html" or "plain"
 * include_entities: "true" shows entities for pictures and links (Default: false)
-* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")
+* friendica_verbose: "true" enables different error returns (default: "false")
 
 ---
 ### direct_messages/new (POST,PUT; AUTH)
@@ -157,7 +157,7 @@ Shows all direct messages of a conversation
 * id: id of the message to be deleted
 * include_entities: optional, currently not yet implemented
 * friendica_parenturi: optional, can be used for increased safety to delete only intended messages
-* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")
+* friendica_verbose: "true" enables different error returns (default: "false")
 
 #### Return values
 
@@ -744,6 +744,38 @@ On success:
 On error:
 * different JSON returns {"result":"error","message":"searchstring not specified"}
 
+---
+### friendica/profile/show (GET; AUTH)
+show data of all profiles or a single profile of the authenticated user
+
+#### Parameters
+* profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
+
+#### 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
+
+On error: 
+HTTP 403 Forbidden: when no authentication provided
+HTTP 400 Bad Request: if given profile_id is not in db or not assigned to authenticated user
+
+General description of profile data in API returns:
+* profile_id
+* profile_name
+* is_default: true if this is the public profile
+* 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
+* description ... homepage: different data fields from 'profile' table in database
+* users: array with the users allowed to view this profile (empty if is_default=true)
+
+
 ---
 ## Not Implemented API calls
 The following API calls are implemented in GNU Social but not in Friendica: (incomplete)