Deprecated
Alternative | /api/v2/node/:nodeid |
---|
Response [200 Ok]
Uri | /api/v2/folder/id/35nGvM |
---|---|
UriDescription | Get folder by its ID |
EndpointType | FolderByID |
Locator | Folder |
LocatorType | Object |
Folder [1 of 1]
/api/v2/folder/user/alexanderbather
Uri | /api/v2/folder/user/alexanderbather |
---|---|
UriDescription | A folder or legacy (sub)category by UrlPath |
ResponseLevel | Public |
DateAdded | 2016-06-09T09:42:34+00:00 |
DateModified | 2016-06-09T09:42:34+00:00 |
Description | empty string |
IsEmpty | false |
Keywords | empty string |
Name | empty string |
NodeID | 35nGvM |
PasswordHint | empty string |
SecurityType | None |
SortDirection | Ascending |
SortMethod | SortIndex |
UrlName | empty string |
UrlPath | empty string |
WebUri | https://www.alexanderbather.com |
Uris
AlbumList
/api/v2/folder/user/alexanderbather!albumlist
Uri | /api/v2/folder/user/alexanderbather!albumlist |
---|---|
UriDescription | List of user's albums |
EndpointType | AlbumList |
Locator | AlbumList |
LocatorType | List |
FolderAlbums
/api/v2/folder/user/alexanderbather!albums
Uri | /api/v2/folder/user/alexanderbather!albums |
---|---|
UriDescription | Albums inside of the folder |
EndpointType | FolderAlbums |
Locator | Album |
LocatorType | Objects |
FolderByID
/api/v2/folder/id/35nGvM
Uri | /api/v2/folder/id/35nGvM |
---|---|
UriDescription | Get folder by its ID |
EndpointType | FolderByID |
Locator | Folder |
LocatorType | Object |
FolderHighlightImage
/api/v2/folder/user/alexanderbather!highlightimage
Uri | /api/v2/folder/user/alexanderbather!highlightimage |
---|---|
UriDescription | Highlight image for folder |
EndpointType | FolderHighlightImage |
Locator | Image |
LocatorType | Object |
FolderList
/api/v2/folder/user/alexanderbather!folderlist
Uri | /api/v2/folder/user/alexanderbather!folderlist |
---|---|
UriDescription | Recursive list of all of the user's folders |
EndpointType | FolderList |
Locator | FolderList |
LocatorType | List |
FolderPages
/api/v2/folder/user/alexanderbather!pages
Uri | /api/v2/folder/user/alexanderbather!pages |
---|---|
UriDescription | Pages inside of the folder |
EndpointType | FolderPages |
Locator | Page |
LocatorType | Objects |
FolderSearch
/api/v2/folder/user/alexanderbather!search
Uri | /api/v2/folder/user/alexanderbather!search |
---|---|
UriDescription | Search for folders |
EndpointType | FolderSearch |
Locator | FolderByID |
LocatorType | Objects |
Folders
/api/v2/folder/user/alexanderbather!folders
Uri | /api/v2/folder/user/alexanderbather!folders |
---|---|
UriDescription | Folders inside of the folder |
EndpointType | Folders |
Locator | Folder |
LocatorType | Objects |
HighlightImage
/api/v2/highlight/node/35nGvM
Uri | /api/v2/highlight/node/35nGvM |
---|---|
UriDescription | Highlight image for a folder, album, or page |
EndpointType | HighlightImage |
Locator | Image |
LocatorType | Object |
Node
/api/v2/node/35nGvM
Uri | /api/v2/node/35nGvM |
---|---|
UriDescription | Node with the given id. |
EndpointType | Node |
Locator | Node |
LocatorType | Object |
Size
/api/v2/folder/user/alexanderbather!size
Uri | /api/v2/folder/user/alexanderbather!size |
---|---|
UriDescription | Size of folder |
EndpointType | Size |
Locator | Size |
LocatorType | Object |
User
/api/v2/user/alexanderbather
Uri | /api/v2/user/alexanderbather |
---|---|
UriDescription | User By Nickname |
EndpointType | User |
Locator | User |
LocatorType | Object |
Request
Uri | /api/v2/folder/id/35nGvM |
---|---|
Method | GET |
Version | v2 |
Config
{ "expand_method": "ref", "shorturis": false }
JSON
{ "Request": { "Version": "v2", "Method": "GET", "Uri": "/api/v2/folder/id/35nGvM" }, "Options": { "MethodDetails": { "OPTIONS": { "Permissions": [ "Read" ] }, "GET": { "Permissions": [ "Read" ] } }, "Methods": [ "OPTIONS", "GET" ], "MediaTypes": [ "application/json", "application/vnd.php.serialized", "application/x-msgpack", "text/html", "text/csv" ], "Path": [ { "type": "path", "text": "api" }, { "type": "path", "text": "v2" }, { "type": "path", "text": "folder" }, { "type": "path", "text": "id" }, { "type": "singleparam", "param_name": "nodeid", "param_value": "35nGvM" } ], "Deprecated": { "Alternative": "/api/v2/node/:nodeid" } }, "Response": { "Uri": "/api/v2/folder/id/35nGvM", "Locator": "Folder", "LocatorType": "Object", "Folder": { "Name": "", "UrlName": "", "SecurityType": "None", "SortMethod": "SortIndex", "SortDirection": "Ascending", "Description": "", "Keywords": "", "PasswordHint": "", "DateAdded": "2016-06-09T09:42:34+00:00", "DateModified": "2016-06-09T09:42:34+00:00", "UrlPath": "", "NodeID": "35nGvM", "IsEmpty": false, "Uri": "/api/v2/folder/user/alexanderbather", "WebUri": "https://www.alexanderbather.com", "UriDescription": "A folder or legacy (sub)category by UrlPath", "Uris": { "FolderByID": { "Uri": "/api/v2/folder/id/35nGvM", "Locator": "Folder", "LocatorType": "Object", "UriDescription": "Get folder by its ID", "EndpointType": "FolderByID" }, "Node": { "Uri": "/api/v2/node/35nGvM", "Locator": "Node", "LocatorType": "Object", "UriDescription": "Node with the given id.", "EndpointType": "Node" }, "User": { "Uri": "/api/v2/user/alexanderbather", "Locator": "User", "LocatorType": "Object", "UriDescription": "User By Nickname", "EndpointType": "User" }, "HighlightImage": { "Uri": "/api/v2/highlight/node/35nGvM", "Locator": "Image", "LocatorType": "Object", "UriDescription": "Highlight image for a folder, album, or page", "EndpointType": "HighlightImage" }, "FolderHighlightImage": { "Uri": "/api/v2/folder/user/alexanderbather!highlightimage", "Locator": "Image", "LocatorType": "Object", "UriDescription": "Highlight image for folder", "EndpointType": "FolderHighlightImage" }, "Folders": { "Uri": "/api/v2/folder/user/alexanderbather!folders", "Locator": "Folder", "LocatorType": "Objects", "UriDescription": "Folders inside of the folder", "EndpointType": "Folders" }, "FolderList": { "Uri": "/api/v2/folder/user/alexanderbather!folderlist", "Locator": "FolderList", "LocatorType": "List", "UriDescription": "Recursive list of all of the user's folders", "EndpointType": "FolderList" }, "FolderAlbums": { "Uri": "/api/v2/folder/user/alexanderbather!albums", "Locator": "Album", "LocatorType": "Objects", "UriDescription": "Albums inside of the folder", "EndpointType": "FolderAlbums" }, "AlbumList": { "Uri": "/api/v2/folder/user/alexanderbather!albumlist", "Locator": "AlbumList", "LocatorType": "List", "UriDescription": "List of user's albums", "EndpointType": "AlbumList" }, "FolderSearch": { "Uri": "/api/v2/folder/user/alexanderbather!search", "Locator": "FolderByID", "LocatorType": "Objects", "UriDescription": "Search for folders", "EndpointType": "FolderSearch" }, "FolderPages": { "Uri": "/api/v2/folder/user/alexanderbather!pages", "Locator": "Page", "LocatorType": "Objects", "UriDescription": "Pages inside of the folder", "EndpointType": "FolderPages" }, "Size": { "Uri": "/api/v2/folder/user/alexanderbather!size", "Locator": "Size", "LocatorType": "Object", "UriDescription": "Size of folder", "EndpointType": "Size" } }, "ResponseLevel": "Public" }, "UriDescription": "Get folder by its ID", "EndpointType": "FolderByID", "Timing": { "Total": { "time": 0.0154, "cycles": 1, "objects": 0 } } }, "Code": 200, "Message": "Ok" }