api_albums

This commit is contained in:
zotlabs 2016-12-07 18:41:59 -08:00
parent 07706b41f4
commit c4d6189b55
2 changed files with 85 additions and 19 deletions

66
doc/api/api_albums.md Normal file
View File

@ -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"
}
]
}

View File

@ -3,82 +3,82 @@ Zot API
api/z/1.0/channel/export/basic
channel/export/basic
Export channel data
api/z/1.0/channel/stream
channel/stream
Fetch channel conversation items
api/z/1.0/network/stream
network/stream
Fetch network conversation items
[api/z/1.0/files](help/api/api_files)
[files](help/api/api_files)
List file storage
api/z/1.0/filemeta
filemeta
Export file metadata for any uploaded file
[api/z/1.0/filedata](help/api/api_filedata)
[filedata](help/api/api_filedata)
Fetch file contents or partial contents for any uploaded file
api/z/1.0/file/export
file/export
api/z/1.0/file
file
api/z/1.0/albums
[albums](help/api/api_albums)
List photo albums
api/z/1.0/photos
photos
list photo metadata
api/z/1.0/photo
photo
[api/z/1.0/group](help/api/group)
[group](help/api/group)
List privacy groups
[api/z/1.0/group_members](help/api/group_members)
[group_members](help/api/group_members)
List members of a privacy group
[api/z/1.0/xchan](help/api/api_xchan)
[xchan](help/api/api_xchan)
Global extended channel (identity) information
[api/z/1.0/item/update](help/api/api_item_update)
[item/update](help/api/api_item_update)
Create or update an item (post, activity, webpage, etc.)
api/z/1.0/item/full
item/full
Get all data associated with an item
api/z/1.0/abook
abook
Connections
api/z/1.0/abconfig
abconfig
Connection metadata (such as permissions)
api/z/1.0/perm_allowed
perm_allowed
Check a permission for a given xchan