Deprecated

Alternative	/api/v2/node/:nodeid

Response [200 Ok]

Uri	/api/v2/folder/user/assets?_responseLevel=Full
UriDescription	A folder or legacy (sub)category by UrlPath
EndpointType	Folder
Locator	Folder
LocatorType	Object

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

Uri	/api/v2/folder/user/assets
UriDescription	A folder or legacy (sub)category by UrlPath
ResponseLevel	Public
DateAdded	2014-02-25T10:51:25+00:00
DateModified	2014-02-25T10:51:25+00:00
Description	empty string
IsEmpty	false
Keywords	empty string
Name	empty string
NodeID	HSBRm
PasswordHint	empty string
SecurityType	None
SortDirection	Descending
SortMethod	DateModified
UrlName	empty string
UrlPath	empty string
WebUri	https://assets.smugmug.com

Uris

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

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

AlbumList [1 of 1]

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

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

FolderByID
/api/v2/folder/id/HSBRm

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

Folder [1 of 1]

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

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

Image [1 of 1]

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

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

FolderList [1 of 1]

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

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

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

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

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

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

HighlightImage
/api/v2/highlight/node/HSBRm

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

Image [1 of 1]

Node
/api/v2/node/HSBRm

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

Node [1 of 1]

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

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

Size [1 of 1]

User
/api/v2/user/assets

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

User [1 of 1]

Timing

Total

cycles	1
objects	0
time	0.02746

Request

Uri	/api/v2/folder/user/assets?_accept=text%2Fhtml&_responseLevel=Full
Method	GET
Version	v2

Config

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

Options

Path

Notes

FolderHighlightImage is deprecated, use HighlightImage instead

Response Levels

Methods

OPTIONS

Permissions	Read

GET

Permissions	Read

PATCH

Permissions	Modify

DELETE

Permissions	Modify

Available Media Types

Parameters

GET

FolderID

Output Fields

DateAdded	datetimeiso8601
DateModified	datetimeiso8601
Description	text
HighlightImageUri	uri
IsEmpty	boolean	Whether this folder contains any albums, folders, or pages.
Keywords	text
Name	text
NodeID	text
Password	text
PasswordHint	text
Privacy	select Public Unlisted Private
SecurityType	select None Password GrantAccess
SmugSearchable	select No Local LocalUser Yes Inherit from User
SortDirection	select Ascending Descending
SortMethod	select SortIndex Name DateAdded DateModified
UrlName	text
UrlPath	text
WorldSearchable	select No HomeOnly Yes Inherit from User

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/assets?_accept=text%2Fhtml&_responseLevel=Full"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "PATCH": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "FolderID",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "",
                    "Type": "Varchar",
                    "MIN_CHARS": 5,
                    "MAX_CHARS": "INFINITY"
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "Name",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 254
            },
            {
                "Name": "UrlName",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 32
            },
            {
                "Name": "SecurityType",
                "Type": "Select",
                "OPTIONS": [
                    "None",
                    "Password",
                    "GrantAccess"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortMethod",
                "Type": "Select",
                "OPTIONS": [
                    "SortIndex",
                    "Name",
                    "DateAdded",
                    "DateModified"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortDirection",
                "Type": "Select",
                "OPTIONS": [
                    "Ascending",
                    "Descending"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "Description",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": 65535
            },
            {
                "Name": "Keywords",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "Password",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "PasswordHint",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "Privacy",
                "Type": "Select",
                "OPTIONS": [
                    "Public",
                    "Unlisted",
                    "Private"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SmugSearchable",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Local",
                    "LocalUser",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "WorldSearchable",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "HomeOnly",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "HighlightImageUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Image"
                ]
            },
            {
                "Name": "DateAdded",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "DateModified",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "UrlPath",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "NodeID",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "IsEmpty",
                "Description": "Whether this folder contains any albums, folders, or pages.",
                "Type": "Boolean"
            }
        ],
        "Notes": [
            "FolderHighlightImage is deprecated, use HighlightImage instead"
        ],
        "ResponseLevels": [
            "Full",
            "Public",
            "Password",
            "GrantAccess"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "folder"
            },
            {
                "type": "path",
                "text": "user"
            },
            {
                "type": "singleparam",
                "param_name": "nickname",
                "param_value": "assets",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [],
                "param_validator": {}
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/assets?_responseLevel=Full",
        "Locator": "Folder",
        "LocatorType": "Object",
        "Folder": {
            "Name": "",
            "UrlName": "",
            "SecurityType": "None",
            "SortMethod": "DateModified",
            "SortDirection": "Descending",
            "Description": "",
            "Keywords": "",
            "PasswordHint": "",
            "DateAdded": "2014-02-25T10:51:25+00:00",
            "DateModified": "2014-02-25T10:51:25+00:00",
            "UrlPath": "",
            "NodeID": "HSBRm",
            "IsEmpty": false,
            "Uri": "/api/v2/folder/user/assets",
            "WebUri": "https://assets.smugmug.com",
            "UriDescription": "A folder or legacy (sub)category by UrlPath",
            "Uris": {
                "FolderByID": {
                    "Uri": "/api/v2/folder/id/HSBRm",
                    "Locator": "Folder",
                    "LocatorType": "Object",
                    "UriDescription": "Get folder by its ID",
                    "EndpointType": "FolderByID"
                },
                "Node": {
                    "Uri": "/api/v2/node/HSBRm",
                    "Locator": "Node",
                    "LocatorType": "Object",
                    "UriDescription": "Node with the given id.",
                    "EndpointType": "Node"
                },
                "User": {
                    "Uri": "/api/v2/user/assets",
                    "Locator": "User",
                    "LocatorType": "Object",
                    "UriDescription": "User By Nickname",
                    "EndpointType": "User"
                },
                "HighlightImage": {
                    "Uri": "/api/v2/highlight/node/HSBRm",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for a folder, album, or page",
                    "EndpointType": "HighlightImage"
                },
                "FolderHighlightImage": {
                    "Uri": "/api/v2/folder/user/assets!highlightimage",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for folder",
                    "EndpointType": "FolderHighlightImage"
                },
                "Folders": {
                    "Uri": "/api/v2/folder/user/assets!folders",
                    "Locator": "Folder",
                    "LocatorType": "Objects",
                    "UriDescription": "Folders inside of the folder",
                    "EndpointType": "Folders"
                },
                "FolderList": {
                    "Uri": "/api/v2/folder/user/assets!folderlist",
                    "Locator": "FolderList",
                    "LocatorType": "List",
                    "UriDescription": "Recursive list of all of the user's folders",
                    "EndpointType": "FolderList"
                },
                "FolderAlbums": {
                    "Uri": "/api/v2/folder/user/assets!albums",
                    "Locator": "Album",
                    "LocatorType": "Objects",
                    "UriDescription": "Albums inside of the folder",
                    "EndpointType": "FolderAlbums"
                },
                "AlbumList": {
                    "Uri": "/api/v2/folder/user/assets!albumlist",
                    "Locator": "AlbumList",
                    "LocatorType": "List",
                    "UriDescription": "List of user's albums",
                    "EndpointType": "AlbumList"
                },
                "FolderSearch": {
                    "Uri": "/api/v2/folder/user/assets!search",
                    "Locator": "FolderByID",
                    "LocatorType": "Objects",
                    "UriDescription": "Search for folders",
                    "EndpointType": "FolderSearch"
                },
                "FolderPages": {
                    "Uri": "/api/v2/folder/user/assets!pages",
                    "Locator": "Page",
                    "LocatorType": "Objects",
                    "UriDescription": "Pages inside of the folder",
                    "EndpointType": "FolderPages"
                },
                "Size": {
                    "Uri": "/api/v2/folder/user/assets!size",
                    "Locator": "Size",
                    "LocatorType": "Object",
                    "UriDescription": "Size of folder",
                    "EndpointType": "Size"
                }
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "A folder or legacy (sub)category by UrlPath",
        "EndpointType": "Folder",
        "Timing": {
            "Total": {
                "time": 0.02746,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

OPTIONS

GET

PATCH

DELETE

Contents