SmugMug API - Get folder by its ID

Response [200 Ok]

Uri /api/v2/folder/id/dWcn5
UriDescription Get folder by its ID
EndpointType FolderByID
Locator Folder
LocatorType Object

Folder [1 of 1]
/api/v2/folder/user/scottlefler

Uri /api/v2/folder/user/scottlefler
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2014-03-08T08:55:45+00:00
DateModified 2014-03-08T08:55:45+00:00
Description empty string
IsEmpty false
Keywords empty string
Name empty string
NodeID dWcn5
PasswordHint empty string
SecurityType None
SortDirection Descending
SortMethod DateModified
UrlName empty string
UrlPath empty string
WebUri https://scottlefler.com

Uris

AlbumList
/api/v2/folder/user/scottlefler!albumlist

Uri /api/v2/folder/user/scottlefler!albumlist
UriDescription List of user's albums
EndpointType AlbumList
Locator AlbumList
LocatorType List

FolderAlbums
/api/v2/folder/user/scottlefler!albums

Uri /api/v2/folder/user/scottlefler!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

FolderByID
/api/v2/folder/id/dWcn5

Uri /api/v2/folder/id/dWcn5
UriDescription Get folder by its ID
EndpointType FolderByID
Locator Folder
LocatorType Object

FolderHighlightImage
/api/v2/folder/user/scottlefler!highlightimage

Uri /api/v2/folder/user/scottlefler!highlightimage
UriDescription Highlight image for folder
EndpointType FolderHighlightImage
Locator Image
LocatorType Object

FolderList
/api/v2/folder/user/scottlefler!folderlist

Uri /api/v2/folder/user/scottlefler!folderlist
UriDescription Recursive list of all of the user's folders
EndpointType FolderList
Locator FolderList
LocatorType List

FolderPages
/api/v2/folder/user/scottlefler!pages

Uri /api/v2/folder/user/scottlefler!pages
UriDescription Pages inside of the folder
EndpointType FolderPages
Locator Page
LocatorType Objects

FolderSearch
/api/v2/folder/user/scottlefler!search

Uri /api/v2/folder/user/scottlefler!search
UriDescription Search for folders
EndpointType FolderSearch
Locator FolderByID
LocatorType Objects

Folders
/api/v2/folder/user/scottlefler!folders

Uri /api/v2/folder/user/scottlefler!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

HighlightImage
/api/v2/highlight/node/dWcn5

Uri /api/v2/highlight/node/dWcn5
UriDescription Highlight image for a folder, album, or page
EndpointType HighlightImage
Locator Image
LocatorType Object

Node
/api/v2/node/dWcn5

Uri /api/v2/node/dWcn5
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object

Size
/api/v2/folder/user/scottlefler!size

Uri /api/v2/folder/user/scottlefler!size
UriDescription Size of folder
EndpointType Size
Locator Size
LocatorType Object

User
/api/v2/user/scottlefler

Uri /api/v2/user/scottlefler
UriDescription User By Nickname
EndpointType User
Locator User
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.02456

Request

Uri /api/v2/folder/id/dWcn5
Method GET
Version v2

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /folder
  • /id
  • /

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/id/dWcn5"
    },
    "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": "dWcn5"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/id/dWcn5",
        "Locator": "Folder",
        "LocatorType": "Object",
        "Folder": {
            "Name": "",
            "UrlName": "",
            "SecurityType": "None",
            "SortMethod": "DateModified",
            "SortDirection": "Descending",
            "Description": "",
            "Keywords": "",
            "PasswordHint": "",
            "DateAdded": "2014-03-08T08:55:45+00:00",
            "DateModified": "2014-03-08T08:55:45+00:00",
            "UrlPath": "",
            "NodeID": "dWcn5",
            "IsEmpty": false,
            "Uri": "/api/v2/folder/user/scottlefler",
            "WebUri": "https://scottlefler.com",
            "UriDescription": "A folder or legacy (sub)category by UrlPath",
            "Uris": {
                "FolderByID": {
                    "Uri": "/api/v2/folder/id/dWcn5",
                    "Locator": "Folder",
                    "LocatorType": "Object",
                    "UriDescription": "Get folder by its ID",
                    "EndpointType": "FolderByID"
                },
                "Node": {
                    "Uri": "/api/v2/node/dWcn5",
                    "Locator": "Node",
                    "LocatorType": "Object",
                    "UriDescription": "Node with the given id.",
                    "EndpointType": "Node"
                },
                "User": {
                    "Uri": "/api/v2/user/scottlefler",
                    "Locator": "User",
                    "LocatorType": "Object",
                    "UriDescription": "User By Nickname",
                    "EndpointType": "User"
                },
                "HighlightImage": {
                    "Uri": "/api/v2/highlight/node/dWcn5",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for a folder, album, or page",
                    "EndpointType": "HighlightImage"
                },
                "FolderHighlightImage": {
                    "Uri": "/api/v2/folder/user/scottlefler!highlightimage",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for folder",
                    "EndpointType": "FolderHighlightImage"
                },
                "Folders": {
                    "Uri": "/api/v2/folder/user/scottlefler!folders",
                    "Locator": "Folder",
                    "LocatorType": "Objects",
                    "UriDescription": "Folders inside of the folder",
                    "EndpointType": "Folders"
                },
                "FolderList": {
                    "Uri": "/api/v2/folder/user/scottlefler!folderlist",
                    "Locator": "FolderList",
                    "LocatorType": "List",
                    "UriDescription": "Recursive list of all of the user's folders",
                    "EndpointType": "FolderList"
                },
                "FolderAlbums": {
                    "Uri": "/api/v2/folder/user/scottlefler!albums",
                    "Locator": "Album",
                    "LocatorType": "Objects",
                    "UriDescription": "Albums inside of the folder",
                    "EndpointType": "FolderAlbums"
                },
                "AlbumList": {
                    "Uri": "/api/v2/folder/user/scottlefler!albumlist",
                    "Locator": "AlbumList",
                    "LocatorType": "List",
                    "UriDescription": "List of user's albums",
                    "EndpointType": "AlbumList"
                },
                "FolderSearch": {
                    "Uri": "/api/v2/folder/user/scottlefler!search",
                    "Locator": "FolderByID",
                    "LocatorType": "Objects",
                    "UriDescription": "Search for folders",
                    "EndpointType": "FolderSearch"
                },
                "FolderPages": {
                    "Uri": "/api/v2/folder/user/scottlefler!pages",
                    "Locator": "Page",
                    "LocatorType": "Objects",
                    "UriDescription": "Pages inside of the folder",
                    "EndpointType": "FolderPages"
                },
                "Size": {
                    "Uri": "/api/v2/folder/user/scottlefler!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.02456,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}