aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api
diff options
context:
space:
mode:
authorzotlabs <mike@macgirvin.com>2016-12-07 18:41:59 -0800
committerzotlabs <mike@macgirvin.com>2016-12-07 18:41:59 -0800
commitc4d6189b55ee4f006013fb180bbf1c431094df72 (patch)
tree02af7043a7359c0f6c278b77a54f0ab2d0e37fc4 /doc/api
parent07706b41f46a726257d8c86beb7ced664d3a7ab7 (diff)
downloadvolse-hubzilla-c4d6189b55ee4f006013fb180bbf1c431094df72.tar.gz
volse-hubzilla-c4d6189b55ee4f006013fb180bbf1c431094df72.tar.bz2
volse-hubzilla-c4d6189b55ee4f006013fb180bbf1c431094df72.zip
api_albums
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/api_albums.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/api/api_albums.md b/doc/api/api_albums.md
new file mode 100644
index 000000000..230daae3c
--- /dev/null
+++ b/doc/api/api_albums.md
@@ -0,0 +1,66 @@
+API albums
+==========
+
+Description: list photo albums
+
+GET /api/z/1.0/albums
+
+
+Output:
+
+ text - textual name
+
+ total - number of photos in this album
+
+ url - web URL
+
+ urlencode - textual name, urlencoded
+
+ bin2hex - textual name using bin2hex (which is used in the web URL link)
+
+
+Example:
+
+
+ {
+
+ "success": true,
+ "albums": [
+ {
+ "text": "/",
+ "total": "2",
+ "url": "https://xyz.macgirvin.com/photos/hubzilla/album/",
+ "urlencode": "",
+ "bin2hex": ""
+ },
+ {
+ "text": "2016-01",
+ "total": "6",
+ "url": "https://xyz.macgirvin.com/photos/hubzilla/album/323031362d3031",
+ "urlencode": "2016-01",
+ "bin2hex": "323031362d3031"
+ },
+ {
+ "text": "2016-02",
+ "total": "7",
+ "url": "https://xyz.macgirvin.com/photos/hubzilla/album/323031362d3032",
+ "urlencode": "2016-02",
+ "bin2hex": "323031362d3032"
+ },
+ {
+ "text": "Cover Photos",
+ "total": "5",
+ "url": "https://xyz.macgirvin.com/photos/hubzilla/album/436f7665722050686f746f73",
+ "urlencode": "Cover+Photos",
+ "bin2hex": "436f7665722050686f746f73"
+ },
+ {
+ "text": "Profile Photos",
+ "total": "26",
+ "url": "https://xyz.macgirvin.com/photos/hubzilla/album/50726f66696c652050686f746f73",
+ "urlencode": "Profile+Photos",
+ "bin2hex": "50726f66696c652050686f746f73"
+ }
+ ]
+
+ }